Beta Ramps API
Integration keys

Get Integration Keys By Id

GET
/integration-keys/{id}

Authorization

headerAuthorizationBearer <token>

Scope: integration-keys:read

Path Parameters

id*string

Integration key ID (ik_…).

Response Body

The integration key (metadata only — no secret).

application/json
  1. response

Integration key metadata. The client secret is never returned by read endpoints; only its first 8 characters (secret_prefix) are exposed.

id*string

Integration key ID (ik_…).

name*string
client_id*string

OAuth2 client ID used at POST /auth/token.

secret_prefix*string

First 8 characters of the client secret, for identification.

permissions*array<string>

Granted scopes.

is_active*boolean
last_used_at*|
Formatdate-time
last_rotated_at*|
Formatdate-time
created_at*string
Formatdate-time
created_by*string

User ID of the key's creator.

Example Request
curl -X GET 'https://api.betaramps.com/integration-keys/string'
Example Response
{  "id": "ik_0192f4e3-8a9b-7c6d-5e4f-3a2b1c0d9e8f",  "name": "Production backend",  "client_id": "Xk9pQ2rT7vW4yZ1aB3cD5eF6gH8jK0mN",  "secret_prefix": "s3cR9xQa",  "permissions": [    "orders:read",    "orders:write",    "balances:read"  ],  "is_active": true,  "last_used_at": "2026-10-31T08:15:00Z",  "last_rotated_at": null,  "created_at": "2026-10-30T12:00:00Z",  "created_by": "auth0|6720f1a2b3c4d5e6f7a8b9c0"}