v1

latestOpenAPI 3.0.22026-07-24154101.1 MB

Users

List Users

get/v2/company/{company_id}/users

company_idinteger required

Company ID

modified_sincestring

Return users that have been modified since the specified date. Format YYYY-MM-DD

location_idinteger

Location ID (cannot be used in conjunction with Department ID and Role ID)

department_idinteger

Department ID (cannot be used in conjunction with Location ID and Role ID)

role_idinteger

Role ID (cannot be used in conjunction with Location ID and Department ID)

status'active' | 'inactive'

The user status

namestring

Filter by partial or full employee name

sort_bystring

Sort the paginated result by the given field and direction.

cursorstring

Cursor for the next or previous page of results.

limitinteger

The number of results desired per page.

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

object'users' required

{
  "data": [
    {
      "timezone": "America/Chicago",
      "language": "en",
      "skill_level": 2,
      "wage_type": "salary"
    }
  ]
}