Get recipients list
Get a list of recipients based on provided filters and pagination parameters. They are use to send webhooks and each store a name, a HMAC secret key and an optional API key.
GET
/v1/recipients/authorization<token>
To get an API key, please contact us. We'll be happy to help you.
In: header
Query Parameters
index?integer
Index of the page query parameter
Default
0Range
0 <= valuesize?integer
Number of record on a page query parameter (capped to 100)
Default
10Range
1 <= value <= 100Response Body
application/json
curl -X GET "http://localhost:4007/v1/recipients/"{
"data": [
{
"id": "5f99d799-73d4-43e0-b247-65918dcdb85f",
"createdAt": "2021-08-02T16:52:15.000Z",
"updatedAt": "2021-08-02T16:52:15.000Z",
"name": "recipient-test"
}
],
"meta": {
"totalPage": 1,
"totalCount": 2,
"currentPageIndex": 0,
"pageSize": 20
},
"links": {
"self": "https://url?page=0&pageSize=20",
"first": "https://url?page=0&pageSize=20",
"last": "https://url?page=0&pageSize=20",
"prev": null,
"next": null
}
}