PApartoo
ApiKeys

API key information

Given an API key ID, this endpoint gives you information about one key.

For more details on how API keys work, and how to handle them securely, see the Security and API Key Usage guide.

get/api_keys/{key_id}

Request

Path parameters

key_idinteger required
Example:3245

Key ID

Query parameters

include_all_permissionsboolean

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

idinteger
labelstring

Name given to recognize the Api key

descriptionstring

Description of the API key

user_idstring

User id

user_namestring

User first name and last name concatenated. Can be null if it's your org integration api key.

user_role'PROVIDER' | 'ORG_ADMIN' | 'ORG_MANAGER' | 'GROUP_MANAGER' | 'BUSINESS_MANAGER' | 'PUBLISHER'

User role in the application

user_type'bot' | 'user'

Whether the API key belongs to a bot user (created automatically for integrations) or a regular human user.

disabledboolean

Is true if someone revoked the key.

expiration_datestring

Must be at least the day after today. If you want it to expire today you must revoke it. You can set it to null.

last_used_atstring
created_bystring

User id

created_by_namestring

First name and last name concatenated of the user that created the key

created_atstring
revoked_bystring

User id

revoked_by_namestring

First name and last name concatenated of the user that revoked the key

revoked_atstring
ip_whiteliststring[]

List of IP or CIDR network notations to which API Key calls are restricted.

Empty list means no restriction.

has_restricted_permissionsboolean

Whether or not the API key has customized permissions. If false, it has the same permissions as the user who created the key.

permissionsstring[]

List of permission names linked to the API Key.

Example response

{
  "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"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.