Sign in
Companies

Retrieve Company

get/v2/companies/{id}

Path parameters

idinteger required

Company ID

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

OK

idnumber required
namestring required
countrystring required
photostring nullable required
plan_idstring required
createdstring date-time required
modifiedstring date-time nullable required
expiresstring date-time nullable required
days_to_expirenumber nullable required
convertedstring date-time nullable required
posstring nullable required
status'active' | 'trial' | 'cancelled' | 'delinquent' | 'expired' | 'unknown' required
start_week_onnumber nullable required