Users

Get a list of users.

GEThttps://api.usepylon.com/users

Response

200400404500

Body

application/json

dataarray of User (object)

The data payload of the response.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

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

Get a user by its ID.

GEThttps://api.usepylon.com/users/{id}

Path parameters

id*string

The ID of the user to fetch.

Response

200400404500

Body

application/json

dataUser (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/users/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

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

Update a user.

PATCHhttps://api.usepylon.com/users/{id}

Path parameters

id*string

The ID of the user to update.

Body

application/json

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.

Response

200400404500

Body

application/json

dataUser (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/users/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404500

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

Search for users by a given filter.

Currently, the following fields are filterable for users:

• email

POSThttps://api.usepylon.com/users/search

Body

application/json

cursorstring

The cursor to use for pagination.

filter*Filter (object)

limitinteger (int64)

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

Response

200400404500

Body

application/json

dataarray of User (object)

The data payload of the response.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/users/search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filter": {
        "field": "text",
        "operator": "equals"
      }
    }),
});
const data = await response.json();

Response

200400404500

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