Get API key by ID

GET

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

const url = 'http://localhost:3000/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/api-keys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Retrieves a specific API key by its unique identifier.

Authorizations

api-key
bearer

Parameters

Path Parameters

orgId

required

string format: uuid

Organization UUID

required

string format: uuid

API Key UUID

Responses

200

API key retrieved successfully

application/json

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

Example

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

401

Unauthorized

403

Forbidden - Insufficient permissions

404

API key not found