Get API keys

Retrieve all API keys. This does not return the full API key, but only a portion (for security purposes).

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/apikeys

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

apiKeys*array of object

List of API keys.

id*integer

apiKey*string

name*string

created*string (date-time)

role*enum

adminmember

isTransformationJobKey*boolean

Request

Response

Get API keys

Retrieve all API keys. This does not return the full API key, but only a portion (for security purposes).

GEThttps://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/apikeys

Path parameters

organizationId*integer

Organization ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

apiKeys*array of object

List of API keys.

id*integer

apiKey*string

name*string

created*string (date-time)

role*enum

adminmember

isTransformationJobKey*boolean

Request

Response

const response = await fetch('https://studio.edgeimpulse.com/v1/api/organizations/{organizationId}/apikeys', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "success": false,
  "error": "text",
  "apiKeys": [
    {
      "id": 0,
      "apiKey": "text",
      "name": "text",
      "created": "2024-12-03T16:51:15.130Z",
      "role": "admin",
      "isTransformationJobKey": false
    }
  ]
}