API Keys

API key management

List API keys

get

List all API keys scoped to the specified organization.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Query parameters

organizationIdstring · uuidRequired

Organization ID — only keys belonging to this organization are returned. Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Default Response

application/json

400

Default Response

application/json

401

Default Response

application/json

404

Default Response

application/json

get/v3/api-keys

HTTPcURLJavaScriptPython

GET /v3/api-keys?organizationId=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "keys": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "organizationId": "550e8400-e29b-41d4-a716-446655440000",
      "keyPrefix": "cc_abc123",
      "name": "text",
      "lastUsedAt": "2025-01-15T10:30:00Z",
      "expiresAt": "2025-01-15T10:30:00Z",
      "revokedAt": "2025-01-15T10:30:00Z",
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:30:00Z"
    }
  ]
}

Create API key

post

Create a new API key for the specified organization. The key authenticates requests as a member of that organization.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Body

application/json

organizationIdstring · uuidRequired

The organization this API key belongs to. Requests authenticated with this key will be made as a member of this organization. Example: 550e8400-e29b-41d4-a716-446655440000

namestring · max: 255Required

Name for the API key

expiresInDaysnumberOptional

Number of days until the key expires

Responses

201

Default Response

application/json

idstring · uuidRequiredExample: 550e8400-e29b-41d4-a716-446655440000

organizationIdstring · uuidRequiredExample: 550e8400-e29b-41d4-a716-446655440000

keyPrefixstringRequiredExample: cc_abc123

namestringRequired

fullKeystringRequired

Full API key. Only returned once at creation — save it immediately.

expiresAtstring · date-time · nullableOptionalExample: 2025-01-15T10:30:00Z

createdAtstring · date-timeRequiredExample: 2025-01-15T10:30:00Z

messagestringRequired

400

Default Response

application/json

401

Default Response

application/json

404

Default Response

application/json

post/v3/api-keys

HTTPcURLJavaScriptPython

POST /v3/api-keys HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "expiresInDays": 1
}

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "organizationId": "550e8400-e29b-41d4-a716-446655440000",
  "keyPrefix": "cc_abc123",
  "name": "text",
  "fullKey": "text",
  "expiresAt": "2025-01-15T10:30:00Z",
  "createdAt": "2025-01-15T10:30:00Z",
  "message": "text"
}

Revoke an API key

delete

Revoke an API key. The organization is derived from the key itself.

Authorizations

ApiKeyAuthBearerAuthOAuth2

x-api-keystringRequired

API key in the format: cc_xxx_yyy (for customer API routes)

Path parameters

apiKeyIdstringRequired

Responses

200

Default Response

application/json

successbooleanRequired

messagestringRequired

400

Default Response

application/json

401

Default Response

application/json

404

Default Response

application/json

delete/v3/api-keys/{apiKeyId}

HTTPcURLJavaScriptPython

DELETE /v3/api-keys/{apiKeyId} HTTP/1.1
Host: api.creditcoop.xyz
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "text"
}