Get Company Setup data
The Companies API allows your Partner App to retrieve the list of companies that your application has access to. Your app may be granted access to one or more clients that are associated with one or more product lines within Paychex.
Use the GET /companies endpoint to return the list of all companies your application has access to. This sample request lists the Companies:
curl --location 'https://api.paychex.com/companies' \
--header 'Authorization: Bearer <your_bearerToken_here>' \
--header 'Accept: application/vnd.paychex.companies.v1+json'
Copy the cURL, Open Postman, Click New and choose HTTP Request to create a new request, Paste the cURL in the URL field, and paste the access token you received in the Authorization header.
Sample Response
{
"metadata": {
"contentItemCount": 1,
"pagination": {
"offset": 10,
"limit": 1,
"itemCount": 0,
"total": 57
}
},
"content": [
{
"companyId": "008WQ28JLVLUDRTZPZRQ",
"displayId": "70417223",
"legalName": "CLIENTIMPA1",
"hasPermission": true,
"legalId": {
"legalIdType": "FEIN",
"legalIdValue": "919964489"
},
"communications": [
{
"type": "STREET_ADDRESS",
"usageType": "BUSINESS",
"streetLineOne": "address line 1",
"city": "Elk Grove Village",
"postalCode": "60007",
"countrySubdivisionCode": "IL",
"countryCode": "US"
}
],
"links": [
{
"rel": "self",
"href": "https://api.paychex.com/companies/008WQ28JLVLUDRTZPZRQ"
},
{
"rel": "workers",
"href": "https://api.paychex.com/companies/008WQ28JLVLUDRTZPZRQ/workers"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://api.paychex.com/companies"
}
]
}