Get all consumers

GET {{baseUrl}}/vault/consumers?limit=20

This endpoint includes all application consumers, along with an aggregated count of requests made.

Request Params

KeyDatatypeRequiredDescription
cursorstringCursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
limitnumberNumber of results to return. Minimum 1, Maximum 200, Default 20
resource_idnull

HEADERS

KeyDatatypeRequiredDescription
x-apideck-app-idstring(Required) The ID of your Unify application
Acceptstring

RESPONSES

status: OK

{"status_code":200,"status":"OK","data":[{"consumer_id":"test_consumer_id","application_id":"1111","metadata":{"account_name":"SpaceX","user_name":"Elon Musk","email":"elon@musk.com","image":"https://www.spacex.com/static/images/share.jpg"},"aggregated_request_count":101,"request_counts":{"unify":100,"proxy":10,"vault":21},"created":"2021-05-07T12:55:42.242Z","modified":"2021-05-07T12:55:42.242Z","request_count_updated":"2021-05-07T12:55:42.242Z","services":["salesforce","stripe"]},{"consumer_id":"test_consumer_id","application_id":"1111","metadata":{"account_name":"SpaceX","user_name":"Elon Musk","email":"elon@musk.com","image":"https://www.spacex.com/static/images/share.jpg"},"aggregated_request_count":101,"request_counts":{"unify":100,"proxy":10,"vault":21},"created":"2021-05-07T12:55:42.242Z","modified":"2021-05-07T12:55:42.242Z","request_count_updated":"2021-05-07T12:55:42.242Z","services":["salesforce","stripe"]}],"meta":{"items_on_page":50,"cursors":{"previous":"em9oby1jcm06OnBhZ2U6OjE=","current":"em9oby1jcm06OnBhZ2U6OjI=","next":"em9oby1jcm06OnBhZ2U6OjM="}},"links":{"previous":"https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D","current":"https://unify.apideck.com/crm/companies","next":"https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"}}