Get all programs

Authorization

api-key<token>

API key authentication

In: header

api-key<token>

API key authentication via query parameter

In: query

Query Parameters

statusstring

Filter programs by status

Value in: "active" | "inactive" | "completed"

limitinteger

Maximum number of programs to return

Default: 20Minimum: 1Maximum: 100

offsetinteger

Number of programs to skip

Default: 0Minimum: 0

curl -X GET "https://api.refref.com/v1/programs?status=active" \
  -H "api-key: <token>"

Successful operation

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "startDate": "2019-08-24",
      "endDate": "2019-08-24",
      "status": "active",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}

Authorization

Query Parameters

Response

TypeScript