Search users (using query parameters)

GET /api/2.0/people/search

Request

Returns a list of users matching the search query. This method uses the query parameters.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Query

querystring

Search query

Examples

GET /api/2.0/people/search?query=some%20text HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url 'https://example.com/api/2.0/people/search?query=some%20text' \
  --header 'Accept: application/json'

Responses

200

List of users

idstringformat: uuid

ID

displayNamestring

Display name

titlestring

Title

avatarstring

Avatar

avatarOriginalstring

Original size avatar

avatarMaxstring

Maximum size avatar

avatarMediumstring

Medium size avatar

avatarSmallstring

Small avatar

profileUrlstring

Profile URL

hasAvatarboolean

Specifies if the user has an avatar or not

isAnonimboolean

Specifies if the user is an anonim or not

401

Unauthorized