List Users

Overview

This endpoint allows you to retrieve a list of all users within the organization you are authenticated to. You can also refine this list by specifying user attributes. To access users within a sub-organization, you must include the org_id in your request's query parameters, along with a current_user_id associated with an admin user at the parent organization level.

When you pass multiple parameters, the endpoint returns users that match any of those parameters. A user does not need to match all parameters; a single match is sufficient. For instance, using the parameter jobs_need_approval=true&admin=true will return both admin users and users whose jobs require approval.

The only exception to this OR logic is when using the search parameter, which employs an AND/OR logic as follows:

(search AND (filter1 OR filter2 OR filter3))

Sample Response Body

{
    "pagination": {
        "current_page": 1,
        "total_pages": 1,
        "total": 2
    },
    "results": [
        {
            "id": 1537943,
            "first_name": "George",
            "last_name": "Bluth",
            "email": "[email protected]",
            "time_zone": "Pacific Time (US & Canada)",
            "aasm_state": "invited",
            "updated_at": "2023-07-26T15:47:04.634Z",
            "created_at": "2023-07-26T15:47:01.546Z",
            "require_job_approval": false,
            "last_sign_in_at": null,
            "acl_template": "admin",
            "test_data": true
        },
        {
            "id": 1537006,
            "first_name": "Buster",
            "last_name": "Bluth",
            "email": "[email protected]",
            "time_zone": "Pacific Time (US & Canada)",
            "aasm_state": "activated",
            "updated_at": "2023-07-25T23:46:52.171Z",
            "created_at": "2023-07-25T20:21:05.574Z",
            "require_job_approval": false,
            "last_sign_in_at": "2023-07-25T20:22:11.745Z",
            "acl_template": "admin",
            "test_data": true
        }
    ]
}

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!