Company

Company Locations

Array of locations set at the company level.

get/companies/{companyId}/locations

Request

Base URL
https://api.paychex.com
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.

Path parameters

companyIdstring required

The ID of the company.

Query parameters

asofstring

Returns all locations as of the date used in the request.

Response

successful operation

Example response

{
  "content": {
    "locationId": "970000082973090",
    "name": "Default Location",
    "address": {
      "communicationId": "00Z5V9BTINBT97UMERCA",
      "type": "STREET_ADDRESS",
      "usageType": "BUSINESS",
      "streetLineOne": "Mike St",
      "streetLineTwo": "Sulley Ln",
      "city": "ANAHEIM",
      "postalCode": "92802",
      "countrySubdivisionCode": "CA",
      "countryCode": "US"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.