---
title: "Company Locations"
method: GET
path: "/companies/{companyId}/locations"
tags: ["Company"]
---

# Company Locations

`GET /companies/{companyId}/locations`

## Request

- Base URL: `https://api.paychex.com`
- URL: `https://api.paychex.com/companies/{companyId}/locations`
- Auth: none declared
- TypeScript: <https://skmtc.dev/paychex/apis/external-api/docs/companies/:companyId/locations/get.ts> (a function with typed inputs; its response is checked against the schema)

Array of locations set at the company level.

## Path parameters

- `companyId` string, required

## Query parameters

- `asof` string

## Response `200`

successful operation

- object
  - `metadata` MetadataResource
    - `contentItemCount` integer
    - `pagination` PaginationMetadataResource
      - `offset` integer
      - `limit` integer
      - `itemCount` integer
      - `total` integer
  - `content` LocationResource: The state representation of Locations within a company.
    - `locationId` string: The unique identifier associated with this locations representation.
    - `name` string: The name of the location.
    - `address` CommunicationResource: Array of properties which specify communication information associated with an entity.
      - `communicationId` string: The unique ID associated with communication
      - `type` 'STREET_ADDRESS' | 'PO_BOX_ADDRESS' | 'PHONE' | 'MOBILE_PHONE' | 'FAX' | 'EMAIL' | 'PAGER': A set of communication types classifying an instruction that the customer, requester, or subject must comply with in order for the screening to go forward. NOTE: PHONE and EMAIL type supports BUSINESS and PERSONAL usage type only.MOBILE_PHONE, FAX and PAGER supports BUSINESS usage type only.This data field cannot be PATCHED.
      - `usageType` 'PERSONAL' | 'BUSINESS' | 'HOME' | 'WORK' | 'LOCATION_STREET_ADDRESS' | 'MAILING_ADDRESS': A code classifying a designated use associated with a contact method. For example, whether a telephone or email address is one for business communications or one primarily for personal use.This data field cannot be PATCHED.
      - `dialCountry` string: The country dialing code for a communication number.
      - `dialArea` string: The area dialing code for a communication number.
      - `dialNumber` string: The communication number, not including country dialing or area dialing codes.
      - `dialExtension` string: The extension of the associated communication number.
      - `uri` string: The mailto address as specified in RFC2368 .
      - `streetLineOne` string: The street address line one
      - `streetLineTwo` string: The street address line two
      - `postOfficeBox` string: The postal office box. This data field cannot be PATCHED.
      - `city` string: The city name
      - `postalCode` string: The zip-code
      - `postalCodeExtension` string: The zip-code extension
      - `countrySubdivisionCode` string: The state code (ISO 3166 subdivision code)
      - `countryCode` string: The country code (ISO 3166 alpha-2)
    - `links` Link[]
      - `rel` string
      - `href` string
      - `hreflang` string
      - `media` string
      - `title` string
      - `type` string
      - `deprecation` string
      - `profile` string
      - `name` string
    - `movedIn` string, date-time: The date which the location was moved into.
    - `movedOut` string, date-time: The date which the location was moved out.
  - `links` Link[]
    - `rel` string
    - `href` string
    - `hreflang` string
    - `media` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string

## Other responses

- `401`: Unauthorized
- `403`: User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)
- `404`: Invalid resource ID (API-7)
- `405`: Unsupported method type (API-59)
- `406`: Unsupported Accept header
- `500`: Internal Server Error.

---

[API](https://skmtc.dev/paychex/apis/external-api.md) - [All operations](https://skmtc.dev/paychex/apis/external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paychex/apis/external-api/revisions/07161d3e073f?raw)