Company

A Company

Information about a single company that your application has access to.

get/companies/{companyId}

Request

Base URL
https://api.paychex.com
Auth
none declared
TypeScript
https://skmtc.dev/paychex/apis/external-api/docs/companies/:companyId/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

includelineageboolean

Response

successful operation

Example response

{
  "content": {
    "companyId": "99Z5V9BTI8J2FCGESC05",
    "displayId": "09620579",
    "legalName": "Monsters, Inc",
    "communications": [
      {
        "communicationId": "00Z5V9BTINBT97UMERCA",
        "type": "STREET_ADDRESS",
        "usageType": "BUSINESS",
        "streetLineOne": "Mike St",
        "streetLineTwo": "Sulley Ln",
        "city": "ANAHEIM",
        "postalCode": "92802",
        "countrySubdivisionCode": "CA",
        "countryCode": "US"
      }
    ],
    "legalId": {
      "legalIdValue": "995886885"
    }
  }
}

Changes

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