GET
/
employer
/
pay-groups
curl --request GET \
  --url https://api.tryfinch.com/employer/pay-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Finch-API-Version: <finch-api-version>'
{
  "responses": [
    {
      "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
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.

Query Parameters

individual_id
string
pay_frequencies
string[]

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