Get company locations
GET {{baseUrl}}/v1/companies/:company_id/locations?page=<number>&per=<number>
Company locations represent all addresses associated with a company. These can be filing addresses, mailing addresses, and/or work locations; one address may serve multiple, or all, purposes.
Since all company locations are subsets of locations, retrieving or updating an individual record should be done via the locations endpoints.
scope: companies:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | string | The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. | |
per | string | Number of objects per page. For majority of endpoints will default to 25 |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Accept | string |
RESPONSES
status: OK
[{"company_uuid":"6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb","version":"7d9753112507b9dda4fb97910f39b06e","phone_number":"5825710808","uuid":"04552eb9-7829-4b18-ae96-6983552948df","street_1":"412 Kiera Stravenue","street_2":"Suite 391","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"filing_address":false,"mailing_address":false,"created_at":"2023-09-12T16:42:25.000-07:00","updated_at":"2023-09-12T16:42:25.000-07:00"},{"company_uuid":"6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb","version":"15e6b9680e00f3122729e64e3cef3224","phone_number":"2866070827","uuid":"fa94a2fd-11a8-4024-87ff-85c587d9d2b4","street_1":"644 Fay Vista","street_2":"Suite 842","city":"Richmond","state":"VA","zip":"23218","country":"USA","active":true,"filing_address":false,"mailing_address":false,"created_at":"2023-09-12T16:42:25.000-07:00","updated_at":"2023-09-12T16:42:25.000-07:00"}]