Skip to main content
GET
JavaScript

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.

Pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))

Query Parameters

entity_ids
string<uuid>[]

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.

Required array length: 1 element
Example:
individual_id
string<uuid>
pay_frequencies
string[]

Response

200 - application/json

Company pay groups

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