---
title: "Companies"
method: GET
path: "/companies"
tags: ["Company"]
---

# Companies

`GET /companies`

## Request

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

Array of companies that your application has been granted with some level of access. Your Application (API Key) can be granted access to one or more companies (clients) accounts that are associated with one or more product lines within Paychex.

## Query parameters

- `displayid` string

## Response `200`

successful operation

- object
  - `metadata` MetadataResource
    - `contentItemCount` integer
    - `pagination` PaginationMetadataResource
      - `offset` integer
      - `limit` integer
      - `itemCount` integer
      - `total` integer
  - `content` CompanyResource: The state representation of a company
    - `companyId` string: The unique identifier associated with this companies representation.
    - `displayId` string: The client account number used for identification purposes. (no dash or spaces allowed, only the last 8 characters of the ID)
    - `legalName` string: The legal name of the company.
    - `communications` CommunicationResource[]
      - `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)
    - `hasPermission` boolean: Indicates whether the provisioned company has active payroll product codes. Companies without active payroll product codes will not be accessible via the API.
    - `legalId` LegalIdResource: The workers legal tax identification information. This data field cannot be PATCHED for ACTIVE workers.
      - `legalIdType` 'SSN' | 'FEIN': A value that identifies the type of taxpayer identification number provided. SSN: Social Security Number - 9 digit number , FEIN: Federal Employer Identification Number (EIN)
      - `legalIdValue` string: The federal level taxpayer id number assigned to a business
    - `lineage` LineageInfoResource: Client lineage information
      - `successors` object: Successors lineage information of the company.
      - `predecessors` object: Predecessors lineage information of the company.
    - `links` Link[]
      - `rel` string
      - `href` string
      - `hreflang` string
      - `media` string
      - `title` string
      - `type` string
      - `deprecation` string
      - `profile` string
      - `name` string
  - `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)
- `404`: No companies found matching search criteria. (API-43)
- `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)