Sign in

v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Users

List User Contacts

get/v2/company/{company_id}/contacts

Path parameters

company_idinteger required

Company ID

Query parameters

include_hidden_adminsboolean

When set to "false", this parameter will remove Admins from the response if they have their "appear as employee" setting turned off

namestring

Filter by partial or full employee name

cursorstring

Cursor for the next or previous page of results.

limitinteger

The number of results desired per page.

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

The Contact's data

object'contacts' required

Example response

{
  "data": [
    {
      "photo": "762fd6fa78d97b0f3f62b9fa4_470.jpg"
    }
  ]
}