Knowledge Base Website Changelog Book a Demo Login

Users

PreviousUser roles NextExternal IDs

Last updated 3 months ago

Was this helpful?

Get a list of users

get

/users

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.usepylon.com/users' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

{
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text",
  "data": [
    {
      "avatar_url": "text",
      "email": "text",
      "id": "text",
      "name": "text",
      "role_id": "text",
      "status": "text",
      "emails": [
        "text"
      ]
    }
  ]
}

Get a user by its ID

get

/users/{id}

Authorizations

Path parameters

idstringrequired

The ID of the user to fetch.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.usepylon.com/users/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

{
  "data": {
    "avatar_url": "text",
    "email": "text",
    "id": "text",
    "name": "text",
    "role_id": "text",
    "status": "text",
    "emails": [
      "text"
    ]
  },
  "request_id": "text"
}

Update a user

patch

/users/{id}

Authorizations

Path parameters

idstringrequired

The ID of the user to update.

Body

role_idstring

The role_id of the user.

statusstring

The new user status for the user. Can be one of active, away, or out_of_office.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.usepylon.com/users/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json'

200

400

404

500

{
  "data": {
    "avatar_url": "text",
    "email": "text",
    "id": "text",
    "name": "text",
    "role_id": "text",
    "status": "text",
    "emails": [
      "text"
    ]
  },
  "request_id": "text"
}

Search for users by a given filter

Currently, the following fields are filterable for users:

email. Allowed operators: equals, in, not_in

post

/users/search

Authorizations

Body

cursorstring

The cursor to use for pagination.

filterobjectrequired

limitinteger · int64

The number of users to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.usepylon.com/users/search' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"filter":{"field":"text","operator":"equals","subfilters":[{"field":"text","operator":"equals","subfilters":[{"field":"text","operator":"equals","subfilters":"[Circular Reference]","values":[null]}],"values":[null]}],"values":[null]}}'

200

400

404

500

{
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text",
  "data": [
    {
      "avatar_url": "text",
      "email": "text",
      "id": "text",
      "name": "text",
      "role_id": "text",
      "status": "text",
      "emails": [
        "text"
      ]
    }
  ]
}