Expoints Documentation

The Expoints API offers a variety of functionalities available to developers who wish to integrate with Expoints to either get data from or to the platform.

The API supports OAuth 2.0 for authentication. More detailed explanations can be found under the context menu ‘Authentication’ as well as how to request access. Access tokens are valid for 1 hour (3600 seconds). Once expired, you will need to request a new access token.

Read the guidelines section below thoroughly before starting development. Common mistakes and questions are listed on the FAQ page.

Guidelines

Set the content type header for all requests to 'Content-Type: application/json; charset=utf-8' or 'Content-Type: application/xml; charset=utf-8'. Some programming languages or libraries use utf-16 by default, a mismatch in this charset can cause strange behavior.
Even though this API is based on web standards, some basic programming knowledge is required to use this API.
The API base URL is https://develop1.expoints.nl. Replace 'develop1' with your own instance name.
Use the latest version of the Expoints API. If you are using an older version, please migrate to the latest version.

Release notes

13-12-2023
- For the get Customer the 'LastActivityDateFilter' parameter is added. It is possible to filter based on this parameter and it is given back for each customer. This date is set from the moment a customer starts filling the questionnaire. For each change a customer makes from that point this date is updated.
- It is possible to add Dashboard notes and status of customers via the API (addformnotes & updateformstatus). For the Get Customer these parameters have been added as well.

Version 3.0 Current

Answer
/external/api/v3/answer

API	Description
GET /external/api/v3/answer/getopenanswers	Get a list of open answers with optional key performance indicator.

AverageScore
/external/api/v3/averagescore

API	Description
GET /external/api/v3/averagescore	Get the average score of questions.
GET /external/api/v3/averagescore/approvedreviewaveragescore	Get the average score of questions for approved reviews.

BaseQuestion
/external/api/v3/basequestion

API	Description
GET /external/api/v3/basequestion	Get a list of all base questions.

Customer
/external/api/v3/customer

API	Description
DELETE /external/api/v3/customer/deletebyid	Delete customer by id.
DELETE /external/api/v3/customer/deletebymailaddress	Delete customer by email address.
DELETE /external/api/v3/customer/deleteoptout	Delete opt-out by email or data.
GET /external/api/v3/customer	Get a list of customers.
GET /external/api/v3/customer/count	Count customers.
GET /external/api/v3/customer/getbouncers	Get a list of bouncers.
GET /external/api/v3/customer/getcustomerstatuses	Get all customer statuses.
GET /external/api/v3/customer/getdatelastinvited	Get date last invited for single customer.
GET /external/api/v3/customer/getoptouts	Get a list of opt-outs.
POST /external/api/v3/customer/add	Add new customers.
POST /external/api/v3/customer/adddataoptout	Add opt-out by data.
POST /external/api/v3/customer/addemailoptout?email={email}	Add opt-out by email.
POST /external/api/v3/customer/addexternal	Add external customers.
POST /external/api/v3/customer/addfinished	Add finished customer.
POST /external/api/v3/customer/addformnotes	Add form notes.
POST /external/api/v3/customer/addlock	Add lock.
POST /external/api/v3/customer/checkoptouts	Check whether customers are opt-out by email or data.
POST /external/api/v3/customer/updateformstatus?customerId={customerId}&status={status}&username={username}	Update form status.

CustomerDataColumn
/external/api/v3/customerdatacolumn

API	Description
GET /external/api/v3/customerdatacolumn	Gets a list of customer data columns.
GET /external/api/v3/customerdatacolumn/getcustomerdatacolumnvalues	Gets a list of all values within a certain customer data column, results can optionally be filtered on date and data.

Form
/external/api/v3/form

API	Description
GET /external/api/v3/form/getall?includeArchived={includeArchived}	Get a list of all form names and the corresponding id.
GET /external/api/v3/form?Id={Id}&LanguageCode={LanguageCode}&IncludeArchived={IncludeArchived}	Get a form by id.

PanelMember
/external/api/v3/panelmember

API	Description
DELETE /external/api/v3/panelmember?id[0]={id[0]}&id[1]={id[1]}	Delete panel member.
GET /external/api/v3/panelmember?Cursor={Cursor}&Limit={Limit}	Get a list of all panel members.
POST /external/api/v3/panelmember	Create panel member.
PUT /external/api/v3/panelmember	Update panel member.

Questionnaire
/external/api/v3/questionnaire

API	Description
GET /external/api/v3/questionnaire	Get a questionnaire by id or evaluate by data.
GET /external/api/v3/questionnaire/getall?includeArchived={includeArchived}	Get a list of all questionnaire names and the corresponding id.
GET /external/api/v3/questionnaire/getQuestionnaireCompletionTime	No documentation available.

Rating
/external/api/v3/rating

API	Description
GET /external/api/v3/rating	Get ratings for approved customers.

Review
/external/api/v3/review

API	Description
GET /external/api/v3/review/getreactions	Gets a list of review reactions.
POST /external/api/v3/review/addreactions	Add one or more review reactions.

Role
/external/api/v3/role

API	Description
GET /external/api/v3/role	Get a list of all role names and the corresponding id.
GET /external/api/v3/role?name={name}	Get the id of a role by the role name.

URL
/external/api/v3/url

API	Description
POST /external/api/v3/url	Get an URL for a questionnaire.
POST /external/api/v3/url/GenerateLuckyURL	No documentation available.

User
/external/api/v3/user

API	Description
DELETE /external/api/v3/user?names={names}	Delete users by username.
GET /external/api/v3/user	Get a list of all users and their roles.
GET /external/api/v3/user?name={name}	Get a single user by username.
POST /external/api/v3/user	Add a user.
PUT /external/api/v3/user	Update users.