GET
/
v1
/
users
curl --request GET \
  --url https://api.siit.io/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "count": 123,
    "total": 123,
    "current_page": 123,
    "per_page": 20,
    "next_page_link": "<string>",
    "previous_page_link": "<string>"
  },
  "results": [
    {
      "uid": "<string>",
      "emails": [
        "<string>"
      ],
      "role_name": "owner",
      "status": "employee",
      "full_name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "slack_user_id": "<string>",
      "department_uid": "<string>",
      "office_location_uid": "<string>",
      "legal_entity_uid": "<string>",
      "team_uids": [
        "<string>"
      ],
      "hire_date": "2023-12-25",
      "job_start_date": "2023-12-25",
      "job_leave_date": "2023-12-25",
      "gender": "female",
      "job_title": "<string>",
      "preferred_language": "<string>",
      "report_to_uid": "<string>",
      "timezone": "<string>",
      "work_phone": "<string>",
      "microsoft_entra_ids": [
        "<string>"
      ],
      "archived_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

​
Introduction

Notes:

  1. Fields that are disabled or restricted will not be returned.
  2. Archived users are NOT returned by default.

​
Usage

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
email_in[]
string[]

Filter by User's work emails.

​
personal_email_in[]
string[]

Filter by User's personal email.

​
status_in[]
enum<string>[]

Filter by User's status.

Available options:
hired,
employee,
alumni,
external
​
role_in[]
enum<string>[]

Filter by User's role.

Available options:
owner,
admin,
it,
hr,
ops,
finance,
custom,
user
​
include_archived
boolean
default:false

Whether the response should include archived users.

​
created_after
string

Filter Users created after a DateTime (ISO 8601).

​
created_before
string

Filter Users created before a DateTime (ISO 8601).

​
updated_after
string

Filter Users updated after a DateTime (ISO 8601).

​
updated_before
string

Filter Users updated before a DateTime (ISO 8601).

​
page
integer

The current page

​
per_page
integer

Number of results retrieved per page.

Response

200
application/json
successful
​
meta
object
​
results
object[]