Skip to main content
GET
/
employer
/
pay-groups
/
{pay_group_id}
JavaScript
import Finch from '@tryfinch/finch-api';

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

const payGroup = await client.payroll.payGroups.retrieve('pay_group_id');

console.log(payGroup.id);
{
  "id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
  "name": "Monthly",
  "pay_frequencies": [
    "monthly"
  ],
  "individual_ids": [
    "be7b048c-a6f3-4194-a017-2f537d4f3565"
  ]
}

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Headers

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

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

Path Parameters

​
pay_group_id
string
required

Query Parameters

​
entity_ids
string<uuid>[]

The entity IDs to specify which entities' data to access.

Required array length: 1 element
Example:
["550e8400-e29b-41d4-a716-446655440000"]

Response

200 - application/json

Pay group data

​
id
string<uuid>
required

Finch id (uuidv4) for the pay group

​
name
string
required

Name of the pay group

​
pay_frequencies
enum<string>[]
required

List of pay frequencies associated with this pay group

Available options:
annually,
bi_weekly,
daily,
monthly,
other,
quarterly,
semi_annually,
semi_monthly,
weekly
​
individual_ids
string<uuid>[]
required

Finch id (uuidv4) for an individual assigned to this pay group