GET List all Tracks¶
This API retrieves a paginated list of tracks available under your account.
Request URL¶
GET /tracks
Warning
Make sure to add your API key in Header of the request
Parameters¶
Parameter |
Type |
Description |
|---|---|---|
page |
integer |
Page number for pagination. Default is |
per_page |
integer |
Number of records per page. Allowed range is |
name |
string |
Case-insensitive partial filter on track title. |
active |
boolean |
Filter tracks by active or inactive status. |
sort_by |
string |
Sort field. Allowed values: |
sort_order |
string |
Sort direction. Allowed values: |
from_date |
date |
Inclusive start date in |
to_date |
date |
Inclusive end date in |
timeframe_field |
string |
Date field used for range filters. Allowed values: |
Response¶
A JSON response containing paginated track records and pagination metadata.
{
"data": [
{
"track_id": "integer",
"title": "string",
"active": "boolean",
"created_by": "integer",
"created_at": "string",
"updated_at": "string",
"job_details": { },
"link_to_apply": "string"
}
],
"pagination": {
"page": "integer",
"per_page": "integer",
"total": "integer",
"total_pages": "integer",
"has_next": "boolean",
"has_prev": "boolean"
},
"X-API-Remaining-Calls": "integer"
}