Organizations

Endpoint: https://api.paychex.com/companies/{companyId}/organizations

Verbs supported: GET

GET: Array of organizations set at the company level.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.


Response: Organization Profile  

Endpoint: https://api.paychex.com/companies/{companyId}/organizations/{organizationId}

Verbs supported: GET

GET: Information about a single Organization.

Request:

Element NameTypeDescription
companyId stringThe ID of the company.
organizationIdstringThe ID of the organization.

Response: Organization Profile  

Response

Profile: Organization

The state representation of Organizations within a company.
Element NameTypeDescription
organizationIdstringThe unique identifier associated with this organizations representation.
namestringThe name of the organization.
numberstringThe number assigned to the organization.
levelstringThe level number within the organizational structures hierarchy.
linksobjectLinks for organization structural information.

 

{
  "content": [
    {
      "organizationId": "970000055981384",
      "name": "2 Division B",
      "number": "2",
      "level": "Level 2",
      "links": [
        {
          "rel": "self",
          "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/organizations/970000055981384"
        },
        {
          "rel": "parent",
          "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/organizations/970000055981383"
        },
        {
          "rel": "child",
          "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/organizations/970000055981385"
        },
        {
          "rel": "child",
          "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/organizations/970000055981386"
        }
         ]
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "https://api.paychex.com/companies/99Z5V9BTI8J2FCGESC05/organizations"
    }
  ]
}