Get program by ID

GET

/v1/programs/{id}

Returns a paginated list of programs. Supports filtering by carrier, program type, active status, and search.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Programs fetched successfully

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/programs/bd0ae55e-5ba2-4bac-856f-c23af1992b12' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
            "carrierId": "81a9910c-2657-4f54-9feb-7f6d85d613bc",
            "programType": "TI",
            "programCode": "inf-premier",
            "name": "string",
            "slug": "string",
            "ratingMethod": "factor",
            "isActive": true,
            "createdAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "pagination": {
        "limit": 50,
        "offset": 0,
        "total": 120
    }
}

Modified at 2026-04-18 17:10:22

List programs available to the caller

Get full detail on one program