Authentication and API Details
Base URL: https://app.retently.com
API Version: v2
Authentication: API Key (pass as api_key header)
GET CUSTOMERS
GET
/api/v2/nps/customers{?page,limit,sort}EXAMPLE URI
https://app.retently.com/api/v2/nps/customers?page=1&limit=20&sort=createdDateURI Parameters
Request
Response
200GET CUSTOMER BY ID
GET
/api/v2/nps/customers/{customerId}EXAMPLE URI
https://app.retently.com/api/v2/nps/customers/5a9d595701c85b38114b5a1Request
Response
200Response
400Response
401Response
404GET COMPANIES
GET
/api/v2/companies{?page,limit,sort}EXAMPLE URI
https://app.retently.com/api/v2/companies?page=1&limit=20&sort=-createdDateURI Parameters
Request
Sort Options
Response
200Response
400Response
401GET COMPANY BY ID
GET
/api/v2/companies/{companyId|domain}EXAMPLE URIS
https://app.retently.com/api/v2/companies/60444db01eeeb6bf89799999https://app.retently.com/api/v2/companies/acme.comRequest
Response
200Response
401Response
404GET REPORTS
GET
/api/v2/reports/EXAMPLE URI
https://app.retently.com/api/v2/reports/5f1ec45y27b8313876299999URI Parameters
Request
Response
200GET LATEST SCORE
GET
/api/v2/{metric}/scoreYou can get the last score based on the survey metric. In the link replace {metric} with: nps, star, csat, or ces. You can pull the score only for one metric at a time.
EXAMPLE URIS
https://app.retently.com/api/v2/nps/scorehttps://app.retently.com/api/v2/star/scorehttps://app.retently.com/api/v2/csat/scorehttps://app.retently.com/api/v2/ces/scoreRequest
Response
200Response
401GET FEEDBACK
GET
/api/v2/feedback{?page,limit,sort,startDate,endDate}EXAMPLE URI
https://app.retently.com/api/v2/feedback?page=1&limit=20&sort=-createdDate&startDate=1514764800&endDate=1526556971URI Parameters
Request
Response
200GET FEEDBACK BY ID
GET
/api/v2/feedback/{feedbackId|campaignId}EXAMPLE URI
https://app.retently.com/api/v2/feedback/5a9d595701c85b37224ab2d0Request
Response
200Response
400Response
401Response
404GET OUTBOX
GET
/api/v2/nps/outbox{?page, limit}EXAMPLE URI
https://app.retently.com/api/v2/nps/outbox?page=1&limit=50URI Parameters
Request
Response
200GET TEMPLATES
GET
/api/v2/templatesEXAMPLE URI
https://app.retently.com/api/v2/templatesRequest
Response
200Response
401GET CAMPAIGNS
GET
/api/v2/campaignsEXAMPLE URI
https://app.retently.com/api/v2/campaignsRequest
Notes
Response
200Response
401GET TRENDS GROUPS
GET
/api/v2/trendsList available trend groups for the authenticated account. Trends allow you to track performance metrics over time with custom filters.
EXAMPLE URI
https://app.retently.com/api/v2/trendsRequest
Response
200Response
401Response
403Response
500GET TREND GROUP DETAILS
GET
/api/v2/trends/:groupIdReturns the full data needed to render a single trend group including scores, trend lines, and respondent distribution. Pass 'default' as the groupId to get the group marked as default, matching the web application experience.
Score Fields:
current: Latest score in the selected date rangeprevious: First/oldest score in the selected date range (baseline)change: Absolute point difference (current - previous)changePercentage: Percentage point change calculated as:- For NPS: Normalizes -100 to 100 scale to 0-200 scale, then calculates:
(current+100 - previous+100) * 100 / 200. Example: current=-19, previous=-32 → 6.5% - For CSAT/CES: Simple difference since already 0-100 scale:
current - previous. Example: current=75, previous=70 → 5%
- For NPS: Normalizes -100 to 100 scale to 0-200 scale, then calculates:
EXAMPLE URI
https://app.retently.com/api/v2/trends/629505b15f6e06c05ca8a582URI Parameters
Request
Response
200Response
400Response
401Response
403Response
404Response
500CREATE OR UPDATE CUSTOMERS
POST
/api/v2/nps/customersMaximum number of customers per request should not exceed 1,000
EXAMPLE URI
https://app.retently.com/api/v2/nps/customersRequest Body Parameters
Request
Manage customer properties
Response
200SEND TRANSACTIONAL SURVEY
POST
/api/v2/surveyEXAMPLE URI
https://app.retently.com/api/v2/surveyRequest Body Parameters
Request
Manage customer properties
For transactional in-app survey
Note
Response
200Response
400Response
401Response
403Response
404ADD FEEDBACK TOPICS
POST
/api/v2/response/topicsEXAMPLE URI
https://app.retently.com/api/v2/response/topicsRequest Body Parameters
Request
Response
200ADD FEEDBACK TAGS
POST
/api/v2/response/tagsEXAMPLE URI
https://app.retently.com/api/v2/response/tagsRequest Body Parameters
Request
Response
200UNSUBSCRIBE CUSTOMERS
POST
/api/v2/nps/customers/unsubscribeEXAMPLE URI
https://app.retently.com/api/v2/nps/customers/unsubscribeRequest Body Parameters
Request
Response
200DELETE CUSTOMERS
DELETE
/api/v2/nps/customersEXAMPLE URI
https://app.retently.com/api/v2/nps/customersRequest Body Parameters
Request
Response
200GET RESPONSES (DEPRECATED)
GET
/api/v2/nps/customers/response{?page,limit,sort,startDate,endDate}EXAMPLE URI
https://app.retently.com/api/v2/nps/customers/response?page=1&limit=20&sort=createdDate&startDate='1514764800'&endDate='1526556971'URI Parameters
Request
Response
200GET TEMPLATES (DEPRECATED)
GET
/api/v2/nps/templatesEXAMPLE URI
https://app.retently.com/api/v2/nps/templatesRequest
Notes
Response
200GET CAMPAIGNS (DEPRECATED)
GET
/api/v2/nps/campaignsEXAMPLE URI
https://app.retently.com/api/v2/nps/campaignsRequest
Notes
Response
200Response
404SEND SURVEY (REMOVED)
POST
/api/v2/nps/customers/surveyThe
/api/v2/nps/customers/survey endpoint has been removed, and all requests to this endpoint will now return an error. If you are currently using this endpoint or planning to use our API to trigger surveys, please switch to the /api/v2/survey endpoint here.EXAMPLE URI
https://app.retently.com/api/v2/nps/customers/surveyRequest Body Parameters
Request
Response
200Response
403Response
404UPDATE FEEDBACK TAGS (DEPRECATED)
POST
/api/v2/nps/customers/response/tagsEXAMPLE URI
https://app.retently.com/api/v2/nps/customers/response/tagsRequest Body Parameters
Request
Response
200