---
title: "Search for Programmes"
method: GET
path: "/programmes"
tags: ["Programmes"]
---

# Search for Programmes

`GET /programmes`

## Request

- Base URL: `https://resources.uk.eagleeye.com`
- URL: `https://resources.uk.eagleeye.com/programmes`
- Auth: none declared. Required headers: `X-EES-AUTH-CLIENT-ID`, `X-EES-AUTH-HASH`

This method allows the calling application to retrieve all Programmes.

## Query parameters

- `id` integer
- `status` 'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'PENDING' | 'DRAFT' | 'REJECTED' | 'READY' | 'STOPPED' | 'DELETED'
- `type` 'VOUCHER' | 'DEBIT' | 'PLASTIC', string
- `tag` string, string
- `accountClientType` string
- `startDate` string, date-time
- `endDate` string, date-time
- `dateCreated` string, date-time
- `lastUpdated` string, date-time
- `orderBy[]` 'id,ASC' | 'id,DESC' | 'status,ASC' | 'status,DESC' | 'lastUpdated,ASC' | 'lastUpdated,DESC', string
- `offset` integer
- `limit` integer

## Headers

- `X-EES-AUTH-CLIENT-ID` string, string, required
- `X-EES-AUTH-HASH` string, string, required
- `Accept-Encoding` '' | 'gzip' | 'deflate' | 'gzip,deflate'
- `X-EES-TRANSACTION-ID` string, string
- `X-EES-RETRY` string, string

## Response `200`

OK.

- ProgrammesSearchResponseEntity
  - `offset` integer: The number of Programmes skipped when returning the data.
  - `limit` integer: The number of Programmes limited in the results, up to a maximum of 100.
  - `total` integer: The total number of Programmes matching your search.
  - `orderBy` object[]: How the results from your search were ordered.
    - `name` string: What column is being used to order.
    - `order` 'ASC' | 'DESC': Whether the results are ordered ascending or descending.
  - `results` ProgrammesResponseEntity[]: The list of Programmes that match your search.
    - `id` Id (unresolved $ref)
    - `type` Type (unresolved $ref)
    - `status` Status (unresolved $ref)
    - `reference` Reference (unresolved $ref)
    - `details` Details (unresolved $ref)
    - `settings` Settings (unresolved $ref)
    - `partners` Partners (unresolved $ref)
    - `rules` Rules (unresolved $ref)
    - `dateCreated` DateCreated (unresolved $ref)
    - `lastUpdated` LastUpdated (unresolved $ref)

## Other responses

- `400`: Bad Request.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Not Found.
- `405`: Method Not Allowed.
- `429`: Too Many Requests
- `500`: Server Error
- `501`: Not Implemented
- `502`: Bad Gateway
- `503`: Service Unavailable
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/eagleeye/apis/resource-api.md) - [All operations](https://skmtc.dev/eagleeye/apis/resource-api/llms.txt) - [OpenAPI document](https://skmtc.dev/eagleeye/apis/resource-api/revisions/10217d37fdc5?raw)