Skip to main content
GET
List compensations

Parameters

number
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
Only return compensations for this worker.
string
Only return compensations in this status, one of accepted, pending, or in_progress.
string
A value from a previous response that lets you fetch the next page.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

Returns

A dictionary with a compensations property that contains an array of up to limit compensations, starting after compensation starting_after. Each entry in the array is a separate compensation object. If no more compensations are available, the resulting array will be empty.