Skip to main content
GET
/
api_keys
List user API keys
curl --request GET \
  --url https://api.partoo.co/v2/api_keys \
  --header 'x-APIKey: <api-key>'
{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "api_keys": [
    {
      "id": 3245,
      "label": "API key name",
      "user_id": "5309c3a237bbc544d8e26737",
      "user_name": "Perceval de Galles",
      "user_role": "BUSINESS_MANAGER",
      "disabled": false,
      "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"
      ]
    }
  ]
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Query Parameters

​
status
enum<string>

Filter api_keys by status. A key is inactive when expired or disabled.

Available options:
active,
inactive,
disabled,
expired
Example:

"active"

Response

OK

​
page
integer

Current page number

Example:

1

​
max_page
integer

Last page number

Example:

10

​
count
integer

Number of resources complying with filters

Example:

287

​
api_keys
object[]

List of API keys