API DETAILS

  • Base URL: https://app.retently.com
  • API Version: v2
  • Rate Limits: 150 requests/min

AUTHENTICATION

X-Api-Key Header

  • Recommended authentication method. Send your API key using the X-Api-Key header. This method works reliably with all platforms including Microsoft Power Automate and Power BI.

API ENDPOINTS

GET /api/v2/feedback

  • Content-Type: application/json
  • X-Api-Key: YOUR_KEY

Authorization Header (Legacy)

  • This method is fully supported and will continue to work indefinitely, but we recommend using the X-Api-Key header for new integrations.

GET /api/v2/feedback

Query Parameter Authentication (Not Recommended)

  • Method: GET /api/v2/feedback?api_key=YOUR_KEY

Security Warning

  • API keys in URLs can be logged by browsers, proxies, and servers.
  • URLs may be cached or stored in browser history.
  • Use this method only if your tool does not support custom headers.

API KEY PERMISSIONS

  • Read Permission
    • Read-only access to your data. Ideal for dashboards, reporting tools, and data analysis.
      • Allowed methods: GET
  • Write Permission
    • Full access to read and modify data. Required for creating customers, sending surveys, and updating records.
      • Allowed methods: GET, POST, DELETE

Endpoints Requiring Write Permission

  • POST /api/v2/customers
  • DELETE /api/v2/customers
  • POST /api/v2/customers/unsubscribe
  • POST /api/v2/survey
  • POST /api/v2/import
  • POST /api/v2/response/tags
  • POST /api/v2/response/topics

GET ACCOUNT STATUS

  • GET /api/v2/ping
  • Returns a single-call snapshot of the authenticated account: identity, current plan, survey credit balance for the active period, and key usage counters (contacts, feedback, outbox, queue, suppressions).
  • Requires: Read permission

EXAMPLE URI

  • https://app.retently.com/api/v2/ping

GET CUSTOMERS

  • GET /api/v2/customers{?page,limit,sort,attributes}
  • Retrieves a paginated list of customers, allowing you to filter, sort, and search by email, or sort the data by creation date.
  • Requires: Read permission

EXAMPLE URIS

  • https://app.retently.com/api/v2/customers?page=1&limit=20&sort=createdDate
  • https://app.retently.com/api/v2/customers?attributes[0][name]=country&attributes[0][op]=equal&attributes[0][value]=US

URI Parameters

  • email string (optional)

  • page integer (optional)

    • Example: 1

  • limit integer (optional)

    • Example: 20

  • sort string (optional)

    • Example: 'createdDate'

  • startDate string (optional)

    • Example: '2024-01-01T00:00:00Z' or '1704067200'

  • endDate string (optional)

    • Example: '2024-12-31T23:59:59Z' or '1735689599'

  • attributes array (optional)

    • Example: attributes[0][name]=country&attributes[0][op]=equal&attributes[0][value]=US
Attributes Filtering
  • GET /api/v2/customers/{customerId}
  • Retrieves detailed information about a specific customer by their unique customer ID.

EXAMPLE URI

  • https://app.retently.com/api/v2/customers/5a9d595701c85b38114b5a1

GET COMPANIES

  • GET /api/v2/companies{?page,limit,sort}
  • Retrieves a paginated list of companies including details like industry, tags, NPS, CSAT or CES metrics, and customer counts per company.

EXAMPLE URI

  • https://app.retently.com/api/v2/companies?page=1&limit=20&sort=-createdDate

Endpoint URI Parameters

  • page integer (optional)
  • limit integer (optional)
  • sort string (optional)

GET CAMPAIGN REPORTS

  • GET /api/v2/reports/
  • Retrieves reports for one or all survey campaigns, including trend data, delivery stats, and additional rating questions stats.

EXAMPLE URI

  • https://app.retently.com/api/v2/reports/5f1ec45y27b8313876299999

GET FEEDBACK

  • GET /api/v2/feedback{?page,limit,sort,startDate,endDate,attributes}
  • Retrieves customer survey responses, allowing you to filter by customer (email or ID), campaign, date range, or other attributes and view detailed response data.

EXAMPLE URIS

  • https://app.retently.com/api/v2/feedback?page=1&limit=20&sort=-createdDate&startDate=1514764800&endDate=1526556971

POST /api/v2/survey

  • Queues for sending a transactional email or in-app survey via the specified campaign to one or more customers, with the possibility to configure a survey delay.

EXAMPLE URI

  • https://app.retently.com/api/v2/survey

IMPORT FEEDBACK

  • POST /api/v2/import

DELETE CUSTOMERS

  • DELETE /api/v2/customers

  • Deletes one or more customers and all their associated data using their email addresses for identification.

EXAMPLE URI

  • https://app.retently.com/api/v2/customers