Users

List users

Lists all users in your organization with pagination and optional filtering.

You can filter the results by exact email address or employee ID. Use pagination parameters to control the number of results returned per page.

get/v1/users

Request

Base URL
https://api.telgea.com
Auth
API key in header x-api-key

Query parameters

pageinteger

Page to return, starting at 1.

Example:1

pageSizeinteger

Items per page, at most 50. Defaults to 10.

Example:10

emailstring email

Filter by exact email address

Example:anna.holm@acme.example

employeeIdstring

Filter by exact employee ID

Example:EMP-0142

Response

Successfully retrieved list of users

pageinteger required

The page these items came from.

pageSizeinteger required

Items per page, as requested.

itemsCountinteger required

Total items across all pages. Divide by pageSize to get the number of pages.

Example response

{
  "page": 1,
  "pageSize": 50,
  "itemsCount": 142,
  "items": [
    {
      "id": "9c1f2a6e-3b7d-4e0a-8f21-5d6c7b8a9e01",
      "email": "anna.holm@acme.example",
      "firstName": "Anna",
      "lastName": "Holm",
      "teamId": "2f6b0d3a-8c1e-4a7f-9b2d-1e3c4d5f6a70",
      "employeeId": "EMP-0142",
      "costCode": "CC-4100"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.