Users

Get a list of users

get

Returns all users for the organization.

Rate limit: 60 requests per minute

Authorizations

AuthorizationstringRequired

Authorization: Bearer

Query parameters

include_deactivatedbooleanOptional

Whether to include deactivated users. Defaults to false.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400

The request was invalid or could not be completed.

application/json

404Error

application/json

500

An unexpected internal error occurred.

application/json

get/users

GET /users HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Get a user by its ID

get

Returns a single user by ID.

Rate limit: 60 requests per minute

Authorizations

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the user to fetch.

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400

The request was invalid or could not be completed.

application/json

404Error

application/json

500

An unexpected internal error occurred.

application/json

get/users/{id}

GET /users/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "avatar_url": "text",
    "email": "text",
    "emails": [
      "text"
    ],
    "id": "text",
    "is_deactivated": true,
    "name": "text",
    "role": {
      "id": "text",
      "name": "text",
      "slug": "text"
    },
    "role_id": "text",
    "status": "active"
  },
  "request_id": "text"
}

Update a user

patch

Updates an existing user. Only provided fields are modified.

Rate limit: 20 requests per minute

Authorizations

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the user to update.

Body

avatar_urlstringOptional

The avatar URL of the user. Must be a square .png, .jpg or .jpeg.

namestringOptional

The name of the user.

role_idstringOptional

The role_id of the user.

statusstring · enumOptional

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

Example: activePossible values:

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400

The request was invalid or could not be completed.

application/json

404Error

application/json

500

An unexpected internal error occurred.

application/json

patch/users/{id}

PATCH /users/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "avatar_url": "text",
  "name": "text",
  "role_id": "text",
  "status": "active"
}

{
  "data": {
    "avatar_url": "text",
    "email": "text",
    "emails": [
      "text"
    ],
    "id": "text",
    "is_deactivated": true,
    "name": "text",
    "role": {
      "id": "text",
      "name": "text",
      "slug": "text"
    },
    "role_id": "text",
    "status": "active"
  },
  "request_id": "text"
}

Search for users by a given filter

post

Filterable fields and their allowed operators:

Field	Allowed operators
email	equals, in, not_in

Rate limit: 20 requests per minute

Authorizations

AuthorizationstringRequired

Authorization: Bearer

Body

cursorstringOptional

The cursor to use for pagination.

limitinteger · int64Optional

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

Responses

200Success

application/json

request_idstringOptional

The request ID for tracking.

400

The request was invalid or could not be completed.

application/json

404Error

application/json

500

An unexpected internal error occurred.

application/json

post/users/search

POST /users/search HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "cursor": "text",
  "filter": {
    "field": "text",
    "operator": "equals",
    "subfilters": [
      {
        "field": "state",
        "operator": "equals",
        "value": "new"
      }
    ],
    "value": "text",
    "values": [
      "text"
    ]
  },
  "limit": 1
}

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