Pagination

Ada’s APIs use cursor-based pagination when retrieving large lists. API calls can include an optional limit query parameter to specify the number of records returned per request.

Request example

GET
/api/v2/end-users/
1import requests
2
3url = "https://example.ada.support/api/v2/end-users/"
4
5headers = {"Authorization": "Bearer <token>"}
6
7response = requests.get(url, headers=headers)
8
9print(response.json())

Query parameters

  • limit: The number of records to return.
  • cursor: The id that marks the start or beginning of the returned records. This is also provided in the next_page_url from the previous response.

Response example

Response
1{
2 "data": [
3 {
4 "end_user_id": "5f7e0e2c1e7c7e000f0f9c3a",
5 "profile": {
6 "first_name": "Ada",
7 "last_name": "Lovelace",
8 "email": {}
9 }
10 }
11 ],
12 "meta": {
13 "next_page_url": "https://example.ada.support/api/v2/end-users/?cursor=65a17e3f43bec88e2792d0eb"
14 }
15}

Use the next_page_url to continue fetching additional data with subsequent requests.