Retrieve a list of company locations

Retrieve a list of company locations. If no CompanyId is provided the user's companyId is used (if set). If the user's company Id is also not set and error will be returned.

Securityapi_key or session_token

Request

query Parameters

companyId

string (HashedId) <= 128 characters /^\w+$/

Responses

200

A location list response

401

API key is missing or invalid

403

Request is completely forbidden. API not provided or method and or endpoint not supported

404

404 Not found

429

429 too many requests response

500

Service Error

default

unexpected error response

get/location/list

Request samples

curl
JavaScript
Node.js
Python

Response samples

application/json

{"code": "Success",
"message": "string",
"location_list": [{"city": "string",
"companyId": "string",
"createdAt": "2020-07-21 17:32:28Z",
"customFields": [{"deletedAt": "2020-07-21 17:32:28Z",
"id": "string",
"isRequired": true,
"isShownInList": true,
"name": "string",
"options": { },
"title": "string",
"type": ""
}
],
"departments": [{"id": "string",
"locationId": "string",
"name": "string"
}
],
"id": "string",
"locationReference": "string",
"name": "string",
"shifts": [{"id": "string",
"locationId": "string",
"name": "string"
}
],
"state": "AL",
"street": "string",
"street2": "string",
"timezone": "US/Hawaii",
"updatedAt": "2020-07-21 17:32:28Z",
"zip": "string"
}
]
}