GET
/
employer
/
pay-groups
JavaScript
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

// Automatically fetches more pages as needed.
for await (const payGroupListResponse of client.payroll.payGroups.list()) {
  console.log(payGroupListResponse.id);
}
[
  {
    "id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
    "name": "Monthly",
    "pay_frequencies": [
      "monthly"
    ]
  },
  {
    "id": "9349eed4-4064-4641-ba8e-9e1ad7e1d014",
    "name": "Weekly",
    "pay_frequencies": [
      "weekly"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Headers

​
Finch-API-Version
string
default:2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Query Parameters

​
individual_id
string
​
pay_frequencies
string[]

Response

200 - application/json

Company pay groups

The response is of type object[].