Skip to main content
GET
JavaScript
Availability: Automated providers only This is a live request to the provider. Latencies may vary from seconds to minutes depending on the provider and number of benefits.
This endpoint returns a bare array[ { … } ] — not an object. In the schema below, the items. prefix labels each element of the array, not a top-level items field.

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]))
Content-Type
string
default:application/json
required

Used to indicate the original media type of the resource

Path Parameters

benefit_id
string
required

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

comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals

Example:

"d675d2b7-6d7b-41a8-b2d3-001eb3fb88f6,d02a6346-1f08-4312-a064-49ff3cafaa7a"

Response

Success

individual_id
string
required
code
integer
required
body
IndividualBenefit · object
required