Skip to main content
GET
/
api
/
v1
/
users
List users
curl --request GET \
  --url https://api.accessowl.com/api/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "deactivated_at": null,
      "departments": [
        "Engineering"
      ],
      "email": "john@example.com",
      "employment_type": "full_time",
      "first_name": "John",
      "full_name": "John Doe",
      "id": "7488a646-e31f-11e4-aace-600308960662",
      "inserted_at": "2023-01-01T00:00:00Z",
      "job_title": "Software Engineer",
      "last_name": "Doe",
      "location_city": "San Francisco",
      "manager_user_id": null,
      "status": "active",
      "teams": [
        "Engineering",
        "Backend"
      ],
      "updated_at": "2023-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 20,
    "total_count": 100,
    "total_pages": 5
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Pass your AccessOwl API token in the Authorization header as Bearer <token>.

Query Parameters

​
limit
integer

Maximum results to return (default: 20, max: 100)

​
cursor
string

Opaque cursor returned in the previous response's meta.next_cursor. Omit for the first page.

​
status
enum<string>

Filter users by status. Returns active users by default

Available options:
onboarding_provisioning_planned,
onboarding,
active,
inactive,
offboarding_planned,
offboarding,
offboarded,
all

Response

User list

Paginated list of users

​
data
User · object[]
required

List of users

​
meta
PaginationMeta · object
required

Pagination metadata

Example:
{
  "page": 1,
  "page_size": 20,
  "total_count": 100,
  "total_pages": 5
}