GET /api/public/user/

Get a list of users.

Returns users within the company.

Response is paginated, with a default page size of 100 objects.

Servers

Query parameters

Name Type Required Description
updated_after String No

Only include users with updated date greater than or equal to the value.

location String No

Filter users by location.

is_company_admin Boolean No

Filter users by company admin status.

first_name String No

Filter users by first name.

is_active Boolean No

Filter users by status.

created_before String No

Only include users with creation date less than or equal to the value.

order_by String No

Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".

Possible values:

  • "create_ts"
  • "email"
  • "id"
  • "update_ts"
  • "employee_id"
page Integer No

Results page

email String No

Filter users by email.

last_name String No

Filter users by last name.

employee_id String No

Filter users by employee ID.

created_after String No

Only include users with creation date greater than or equal to the value.

updated_before String No

Only include users with updated date less than or equal to the value.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.