List API keys

GET

/api/v1/organizations/{orgId}/api-keys

const url = 'http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/api-keys?search=production&limit=20&offset=0';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/api-keys?search=production&limit=20&offset=0' \
  --header 'X-API-Key: <X-API-Key>'

Retrieves all API keys for the organization with pagination.

Authorizations

api-key
bearer

Parameters

Path Parameters

orgId

required

string format: uuid

Organization UUID

Query Parameters

search

string

Example

production

Search by API key name

limit

number

default: 20 >= 1 <= 100

Example

Maximum number of results to return

offset

number

Example

Number of results to skip for pagination

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

API keys retrieved successfully

application/json

object

items

required

List of API keys

Array<object>

object

required

Unique API key identifier

string format: uuid

name

required

Display name for the API key

string

description

Description of the API key purpose

string

keyPrefix

required

Prefix of the API key for identification (first 8 characters)

string

permissions

required

List of permission keys granted to this API key

Array<string>

lastUsedAt

When the API key was last used

string format: date-time

expiresAt

When the API key expires

string format: date-time

createdAt

required

When the API key was created

string format: date-time

createdBy

User ID who created this API key

string format: uuid

total

required

Total number of API keys matching the query

number

limit

required

Number of results returned

number

offset

required

Number of results skipped

number

Example

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Production CI/CD Key",
      "description": "Used by GitHub Actions for automated deployments",
      "keyPrefix": "mwfm_abc",
      "permissions": [
        "devices:read",
        "deployments:read",
        "deployments:write"
      ],
      "lastUsedAt": "2024-06-20T14:45:00Z",
      "expiresAt": "2025-12-31T23:59:59Z",
      "createdAt": "2024-01-15T10:30:00Z",
      "createdBy": "550e8400-e29b-41d4-a716-446655440001"
    }
  ],
  "total": 5,
  "limit": 20,
  "offset": 0
}

401

Unauthorized

403

Forbidden - Insufficient permissions