People API: Search

Endpoint#

Property	Value
Type	query
Method	GET
Path	/api/external/v1/people/search
Handler	OperatelyWeb.Api.People.Search

Authentication#

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

Inputs#

Field	Type	Required	Nullable	Default
query	string	No	No	""
ignored_ids	array of id primitive (encoded as string)	No	No	[]
search_scope_type	search_scope_options enum (company, project, space, goal, resource_hub, none)	No	No	”none”
search_scope_id	id primitive (encoded as string)	No	Yes	nil

Outputs#

Field	Type	Required	Nullable
people	array of person object	Yes	No

cURL Example#

Copied

curl --request GET \
  --url "https://app.operately.com/api/external/v1/people/search?ignored_ids[]=value&query=value&search_scope_id=value&search_scope_type=company" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}"

Response Example#

{
  "people": [
    {
      "__typename": "value",
      "access_level": "<access_options_int>",
      "avatar_blob_id": "value",
      "avatar_url": "value",
      "company": "<company>",
      "daily_summary_delivery_time": "value",
      "description": "value",
      "dismissed_product_release_id": "value",
      "email": "value",
      "email_preference": "buffered",
      "email_window_minutes": "<email_window_minutes>",
      "full_name": "value",
      "has_open_invitation": true,
      "id": "value",
      "invite_link": "<invite_link>",
      "language": "en",
      "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,
      "time_format": "automatic",
      "timezone": "value",
      "title": "value",
      "type": "value",
      "url": "value"
    }
  ]
}