List user API keys
This endpoint lets you list all the API keys you have access to.
For more details on how API keys work, and how to handle them securely, see the Security and API Key Usage guide.
Query parameters
Page number. Starts at 1. Any value lower than 1 will be considered as 1. For the number of items per page, see the per_page query parameter.
Number of items to return per page. Currently limited to 100.
Filter API keys by status. A key is inactive when its status is either expired or disabled.
Filter API keys by the type of user the key belongs to.
Free-text search filter matched against:
- api_key — the actual API key string value
- label — the human-readable label/name assigned to the key
Controls whether permissions are filtered based on what the API key's user is actually allowed to access. An API key can have broader permissions than its attached user's own permissions, however they won't be taken into account unless the user has them.
- false (default) — The returned permissions list is filtered down with only those the user has access to.
- true — The returned permissions list is not filtered. All permissions are included in the response, regardless of what the user has access to.
Response
OK
Example response
{
"page": 1,
"max_page": 10,
"count": 287,
"api_keys": [
{
"id": 3245,
"label": "API key name",
"description": "API key for updating business name, and categories.",
"user_id": "5309c3a237bbc544d8e26737",
"user_name": "Perceval de Galles",
"user_role": "BUSINESS_MANAGER",
"user_type": "user",
"expiration_date": "2022-06-05",
"last_used_at": "2019-08-22 11:46:38.914467+00",
"created_by": "5309c3a237bbc544d8e26737",
"created_by_name": "John Smith",
"created_at": "2018-03-12 11:49:03.399475+00",
"revoked_by": "5309c3a237bbc544d8e26737",
"revoked_by_name": "John Smith",
"revoked_at": "2020-10-20 11:46:38.914467+00",
"ip_whitelist": [
"172.16.0.0/12",
"127.0.0.1"
],
"has_restricted_permissions": true,
"permissions": [
"business_edit",
"business_edit_name",
"business_edit_categories"
]
}
]
}