Get API Key

GET 
/organizations/:organizationId/api-keys/:keyId

Get details of a specific API key. Note: The key hash/secret is NEVER returned.

Request

Path Parameters

organizationId stringrequired

Organization ID

keyId stringrequired

API Key ID

Responses

200

application/json

Schema

Schema

data objectrequired
Response data
id stringrequired
name stringrequired
keyPrefix stringrequired
status stringrequired
permissions string[]
lastUsedAt number
usageCount number
createdAt numberrequired
revokedAt number

Example (from schema)

{
  "data": {
    "id": "string",
    "name": "string",
    "keyPrefix": "string",
    "status": "string",
    "permissions": [
      "string"
    ],
    "lastUsedAt": 0,
    "usageCount": 0,
    "createdAt": 0,
    "revokedAt": 0
  }
}

Example

{}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

Loading...