Search for Programmes

This method allows the calling application to retrieve all Programmes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Optional Filtering criteria based on one or more ids.

string
enum

This is a status of the Programme.

string
enum

Optional Filtering criteria (e.g. type=VOUCHER) allow the calling application to narrow down returned results by type.

Allowed:
string

EES AIR Programme Tag.

string

The default client type for an Account unless otherwise stated during individual Account creation.

date-time

When the Programme starts.

date-time

When the Programme ends.

date-time

The date the Programme was created.

date-time

The date the Programme was last updated.

string
enum
Defaults to id,ASC

This optional request parameter allows the calling application to request a specific sorting order for a result set. Currently supported field names are: id, status and lastUpdated

Allowed:
integer

Offset allows you to skip a number of items before returning data.

integer

The number of items to return.

Headers
string
required

Client ID, This will be provided by EES and is unique to the company calling the API.

string
required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret.

string
enum

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

Allowed:
string

Unique Reference for the API transaction within the calling company.

string

This flag denotes the number of attempts that have been made for this request.

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json