List users | Abel

curl https://api.stage.abelpolice.com/v1/users \
     -H "x-api-key: <token>"

{
  "users": [
    {
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "agency_id": "41db4476-f346-4e7b-a83d-a3a5a5d5d832",
      "agency_name": "New York Police Department",
      "email": "john.mcclane@nyc.gov",
      "first_name": "John",
      "last_name": "McClane",
      "phone_number": "+1234567890",
      "badge_number": "881",
      "last_login_at_utc": "2021-01-01T00:00:00Z",
      "created_at_utc": "2021-01-01T00:00:00Z",
      "updated_at_utc": "2021-01-01T00:00:00Z",
      "writer_seat_assigned": false,
      "writer_seat_assigned_at_utc": "2021-01-01T00:00:00Z",
      "writer_seat_unassigned_at_utc": "2021-01-01T00:00:00Z",
      "chat_seat_assigned": false,
      "chat_seat_assigned_at_utc": "2021-01-01T00:00:00Z",
      "chat_seat_unassigned_at_utc": "2021-01-01T00:00:00Z",
      "global_admin": false,
      "is_onboarded": false,
      "role_name": "officer",
      "voice_tagging_enabled": false
    }
  ],
  "metadata": {
    "offset": 1,
    "limit": 1,
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1,
    "has_next_page": true,
    "has_previous_page": true,
    "records_in_page": 1
  }
}

Query parameters

user_idslist of strings or nullOptional

List of user IDs to filter by

agency_idslist of strings or nullOptional

List of agency IDs to filter by

user_roleslist of strings or nullOptional

List of user roles to filter by

limitintegerOptional1-1000Defaults to 1000

Maximum number of users to return

offsetintegerOptional>=0Defaults to 0

Number of users to skip

Response

Successful Response

userslist of objects

metadataobject

Errors

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error

Headers

Query parameters

Response

Errors