GET
/
employer
/
pay-groups
/
{pay_group_id}
curl --request GET \
  --url https://api.tryfinch.com/employer/pay-groups/{pay_group_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Finch-API-Version: <finch-api-version>'
{
  "id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
  "name": "Monthly",
  "pay_frequencies": [
    "monthly"
  ],
  "individual_ids": [
    "be7b048c-a6f3-4194-a017-2f537d4f3565"
  ]
}

Authorizations

Authorization
string
headerrequired

Please use your Access Token

Headers

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

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

Path Parameters

pay_group_id
string
required

Response

200 - application/json
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
individual_ids
string[]