Every endpoint that lists a collection (invites, users, destinations, senders, API keys, events) shares the same pagination query parameters and the same response envelope.
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
Qt | integer | 10 | Items per page |
Pg | integer | 1 | Page number, 1-based |
CpOrd | string | id | Sort field, case-insensitive — must be a real property of the resource |
TpOrd | Asc | Desc | Desc | Sort direction |
Each resource page in this reference lists any additional filter parameters it accepts (for
example Status on Users, or From/To on Events).
Response envelope
{
"total": 42,
"items": [
// ...page of resource objects
]
}
total— total number of matching items across all pages, not just the current pageitems— the current page, sized byQt(or fewer, on the last page)
Example
var url = "https://api.hooksentry.com/api/v1/events?Qt=25&Pg=2&CpOrd=acceptedAt&TpOrd=Desc";
var request = new HttpRequestMessage(HttpMethod.Get, url);
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
using var client = new HttpClient();
var response = await client.SendAsync(request);
Invalid sort field:
Passing a CpOrd value that isn't a real property of the resource returns 400 Bad Request.