List employees

Paginated directory of the people who work at your company.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

employees:read

Query Parameters

Name	Type	Required	Description
`limit`	number	Optional	Maximum number of items to return (1-100).Default: `20`
`offset`	number	Optional	Number of items to skip before starting to collect the result set.Default: `0`
`sortBy`	string	Optional	Field to sort by. Allowed values vary by endpoint.Default: `createdAt`
`sortOrder`	string asc desc	Optional	Sort direction.Default: `desc`
`search`	string	Optional	Free-text search across the resource’s primary fields.
`createdAfter`	string	Optional	ISO 8601 timestamp — only return items created after this time.
`createdBefore`	string	Optional	ISO 8601 timestamp — only return items created before this time.
`updatedAfter`	string	Optional	ISO 8601 timestamp — only return items updated after this time.
`status`	string ONBOARDING ACTIVE DEACTIVATED	Optional	Filter by employment status.
`departmentId`	string	Optional	Only employees in this department.
`jobTitleId`	string	Optional	Only employees with this job title.
`managerId`	string	Optional	Only employees reporting to this manager.
`includeBots`	boolean	Optional	Include AI agents, which are employees too. Omitted by default.Default: `false`

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/employees" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Employees retrieved successfully!",
  "content": {
    "employees": [
      {
        "id": "emp_abc123",
        "referenceId": 42,
        "bot": false,
        "status": "ACTIVE",
        "user": {
          "id": "usr_abc123",
          "fullname": "Ada Lovelace",
          "email": "ada@acme.com",
          "phoneNumber": "+15555550123"
        },
        "department": {
          "id": "dep_1",
          "name": "Engineering"
        },
        "jobTitle": {
          "id": "job_1",
          "name": "Staff Engineer"
        },
        "manager": {
          "id": "emp_xyz789",
          "user": {
            "id": "usr_xyz789",
            "fullname": "Grace Hopper"
          }
        }
      }
    ],
    "pagination": {
      "total": 42,
      "limit": 20,
      "offset": 0,
      "hasMore": true
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Employees → Directory

/employee/directory