PilotFoxDocs

List API keys

GET
/api/v1/orgs/{orgId}/api-keys

Every key of the organization, newest first, with its permissions, sites (siteIds null: every site) and dates; never the key itself (start is its first characters). lastUsedAt can lag by up to a minute.

Requires apiKey:read in the organization (an API key, or a signed-in member's role; a member restricted to some sites holds a viewer's permissions here). API keys limited to some sites: 403. Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: apiKey:read

Path Parameters

orgId*string

Response Body

OK

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://pilotfox.app/api/v1/orgs/string/api-keys'
Example Response200
{  "data": [    {      "id": "string",      "name": "string",      "start": "string",      "permissions": {        "property1": [          "string"        ],        "property2": [          "string"        ]      },      "siteIds": [        "string"      ],      "createdAt": "2019-08-24T14:15:22Z",      "lastUsedAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z"    }  ]}