Information and management of members in a program.
Get members
Returns a paged list of all members in a program. Default page size is 20, maximum page size is 100.
path Parameters
programIdquery Parameters
customerIdpageperPageHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get members › Responses
OK
All items for this page
totalItemsTotal items which could be returned
totalPagesTotal number of pages
Get member
Get a member by member ID in a program.
path Parameters
programIdmemberIdHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get member › Responses
OK
idcreatedAtcustomerIdCustomer id
organisationIdThe organisation this member belongs to
Metadata needed for the processing of events
updatedAtGet all transactions for a member
Paged list of all transactions for a member, sorted by validFrom descending. Default page size is 20, maximum page size is 100.
path Parameters
programIdmemberIdquery Parameters
orderIdpointDefinitionReferencepageperPageHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get all transactions for a member › Responses
OK
All items for this page
totalItemsTotal items which could be returned
totalPagesTotal number of pages
Point periods for member
Paged list of all point periods for a member in a program. It's ordered by the startAt field of the period, with the
most recent first. Default page size is 20, maximum page size is 100.
path Parameters
programIdmemberIdquery Parameters
pageperPageHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Point periods for member › Responses
OK
All items for this page
totalItemsTotal items which could be returned
totalPagesTotal number of pages
Get reward ladder for a member
Reward ladder for a member shows the levels available for a member, what is required to achieve each level and what rewards are given in each level.
path Parameters
programIdmemberIdHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get reward ladder for a member › Responses
OK
Program level details, including the specific requirements and rewards for each level in the program
Get points history for a member
Returns a paged list of points earned and consumed by a member in a program, ordered by created at descending. Default page size is 20, maximum page size is 100.
path Parameters
programIdmemberIdquery Parameters
pointDefinitionReferencepointEventTypecreatedAftercreatedBeforepageperPageHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get points history for a member › Responses
OK
All items for this page
totalItemsTotal items which could be returned
totalPagesTotal number of pages
Get suspension periods
Paged list of all suspension periods for a member, sorted by startAt descending. Default page size is 20, maximum page size is 100.
path Parameters
programIdmemberIdquery Parameters
pageperPageHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get suspension periods › Responses
OK
All items for this page
totalItemsTotal items which could be returned
totalPagesTotal number of pages
Get point period
Get a point period for a member in a program by the point period ID.
path Parameters
programIdmemberIdpointPeriodIdHeaders
ET-Client-NameEntur Client Header.
It is required that all consumers identify themselves by using this header.
Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers.
The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.
X-Correlation-IdCorrelation id
Get point period › Responses
OK
idThe ID of the point period
endAtThe end time of the point period
startAtThe start time of the point period
Metadata for a point period. Example:
Code