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

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

async function main() {
  // Automatically fetches more pages as needed.
  for await (const payGroupListResponse of client.payroll.payGroups.list()) {
    console.log(payGroupListResponse.id);
  }
}

main();
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "pay_frequencies": [
      "annually"
    ]
  }
]

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
id
string

Finch id (uuidv4) for the pay group

name
string

Name of the pay group

pay_frequencies
enum<string>[]

List of pay frequencies associated with this pay group

Available options:
annually,
semi_annually,
quarterly,
monthly,
semi_monthly,
bi_weekly,
weekly,
daily,
other