get_people

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/get_people
Handler	OperatelyWeb.Api.Queries.GetPeople

Authentication#

• Requires a valid API token.
• Read-only and full-access tokens can execute this query.

Inputs#

Field	Type	Required	Nullable	Default
only_suspended	boolean	No	No	-
include_suspended	boolean	No	No	-
include_manager	boolean	No	No	-
include_account	boolean	No	No	-
include_invite_link	boolean	No	No	-
include_company_access_levels	boolean	No	No	-

Outputs#

Field	Type	Required	Nullable
people	array of person object	No	Yes

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/get_people?include_account=true&include_company_access_levels=true&include_invite_link=true&include_manager=true&include_suspended=true&only_suspended=true" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "people": [
    {
      "access_level": 123,
      "agent_def": "<agent_def>",
      "avatar_blob_id": "value",
      "avatar_url": "value",
      "company": "<company>",
      "description": "value",
      "email": "value",
      "full_name": "value",
      "has_open_invitation": true,
      "id": "value",
      "invite_link": "<invite_link>",
      "manager": "<person>",
      "notify_about_assignments": true,
      "notify_on_mention": true,
      "peers": [
        "<person>"
      ],
      "permissions": "<person_permissions>",
      "reports": [
        "<person>"
      ],
      "send_daily_summary": true,
      "show_dev_bar": true,
      "suspended": true,
      "timezone": "value",
      "title": "value",
      "type": "value"
    }
  ]
}