---
title: "locations"
method: GET
path: "/v{version}/companies/{company_id}/locations"
tags: ["Location"]
---

# locations

`GET /v{version}/companies/{company_id}/locations`

## Request

- Base URL: `https://api-docs.ease.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.ease.com/v{version}/companies/{company_id}/locations`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ease/apis/version-2/docs/v:version/companies/:company_id/locations/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns all locations for a company.<p>Scopes: import_plan, export_payroll, export_company_info</p>

## Path parameters

- `company_id` string, required
- `version` string, required

## Response `200`

Success

- 0WrappedArrayLocation
  - `data` DtosLocation[], required: An array containing the list of relevant objects.
    - `id` string, required: The id of the location.
    - `name` string, required: The name of the location.
    - `created` string, date-time, required: The datetime the location was created.
    - `last_modified` string, date-time, required: The datetime the location was last modified.
    - `addr1` string: The Location Address 1.
    - `addr2` string: The Location Address 2.
    - `city` string: The Location City.
    - `state` string: The Location State.
    - `zip` string: The Location Zip.
    - `county` string: The Location County.
    - `country` 'Afghanistan' | 'Albania' | 'Algeria' | 'Argentina' | 'Armenia' | 'Australia' | 'Austria' | 'Azerbaijan' | 'Bahrain' | 'Bangladesh' | 'Belarus' | 'Belgium' | 'Belize' | 'Benin' | 'Bhutan' | 'Bolivarian Republic of Venezuela' | 'Bolivia' | 'Bosnia and Herzegovina' | 'Botswana' | 'Brazil' | 'Brunei Darussalam' | 'Bulgaria' | 'Burundi' | 'Cambodia' | 'Cameroon' | 'Canada' | 'Caribbean' | 'Chile' | 'Colombia' | 'Congo (DRC)' | 'Costa Rica' | 'Côte d'Ivoire' | 'Croatia' | 'Cuba' | 'Cyprus' | 'Czech Republic' | 'Denmark' | 'Djibouti' | 'Dominican Republic' | 'Ecuador' | 'Egypt' | 'El Salvador' | 'Eritrea' | 'Estonia' | 'Ethiopia' | 'Faroe Islands' | 'Fiji' | 'Finland' | 'France' | 'Gambia' | 'Georgia' | 'Germany' | 'Ghana' | 'Greece' | 'Greenland' | 'Guatemala' | 'Haiti' | 'Honduras' | 'Hong Kong S.A.R.' | 'Hungary' | 'Iceland' | 'India' | 'Indonesia' | 'Iran' | 'Iraq' | 'Ireland' | 'Islamic Republic of Pakistan' | 'Israel' | 'Italy' | 'Jamaica' | 'Japan' | 'Jordan' | 'Kazakhstan' | 'Kenya' | 'Korea' | 'Kuwait' | 'Kyrgyzstan' | 'Lao P.D.R.' | 'Latin America' | 'Latvia' | 'Lebanon' | 'Liberia' | 'Libya' | 'Liechtenstein' | 'Lithuania' | 'Luxembourg' | 'Macao S.A.R.' | 'Malaysia' | 'Maldives' | 'Mali' | 'Malta' | 'Mexico' | 'Moldova' | 'Mongolia' | 'Montenegro' | 'Morocco' | 'Myanmar' | 'Namibia' | 'Nepal' | 'Netherlands' | 'New Zealand' | 'Nicaragua' | 'Nigeria' | 'North Macedonia' | 'Norway' | 'Oman' | 'Palestine' | 'Panama' | 'Paraguay' | 'People's Republic of China' | 'Peru' | 'Philippines' | 'Poland' | 'Portugal' | 'Principality of Monaco' | 'Puerto Rico' | 'Qatar' | 'Réunion' | 'Romania' | 'Russia' | 'Rwanda' | 'Saudi Arabia' | 'Senegal' | 'Serbia' | 'Sierra Leone' | 'Singapore' | 'Slovakia' | 'Slovenia' | 'Somalia' | 'South Africa' | 'Spain' | 'Sri Lanka' | 'Sudan' | 'Sweden' | 'Switzerland' | 'Syria' | 'Taiwan' | 'Tajikistan' | 'Tanzania' | 'Thailand' | 'Trinidad and Tobago' | 'Tunisia' | 'Turkey' | 'Turkmenistan' | 'U.A.E.' | 'Uganda' | 'Ukraine' | 'United Kingdom' | 'United States' | 'Uruguay' | 'Uzbekistan' | 'Vietnam' | 'Yemen' | 'Zambia' | 'Zimbabwe': The Location Country.
    - `phone` string: The phone number of the location.
    - `ein` string: The EIN of the location.
    - `fax` string: The fax number of the location.
    - `headquarters` boolean: Is this the headquarters for the company?
  - `error` string: Contains any error messages, if applicable.

---

[API](https://skmtc.dev/ease/apis/version-2.md) - [All operations](https://skmtc.dev/ease/apis/version-2/llms.txt) - [OpenAPI document](https://skmtc.dev/ease/apis/version-2/revisions/be66ed178abe?raw)