ApiKeys

Get API Keys

get

Authorizations

api_key

X-API-KEYstringRequired

Query parameters

pagenumber · nullableOptionalDefault: 1

limitnumber · nullableOptionalDefault: 10

Responses

200

200

application/json

401

401

application/json

403

403

application/json

get

/clients/api/v1/api-keys

HTTPcURLJavaScriptPython

GET /clients/api/v1/api-keys HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": "text",
      "__entity": "Entity",
      "createdAt": "2026-03-27T15:47:09.539Z",
      "updatedAt": "2026-03-27T15:47:09.539Z",
      "deletedAt": "2026-03-27T15:47:09.540Z",
      "name": "text",
      "description": "text",
      "key": "text",
      "keyHash": "text",
      "active": true,
      "lastUsedAt": "2026-04-03T18:33:24.863Z",
      "accountId": "text",
      "roleId": "text"
    }
  ],
  "meta": {
    "itemCount": 1,
    "totalItems": 10,
    "itemsPerPage": 1,
    "totalPages": 10,
    "currentPage": 1
  }
}

Get API Key

get

Authorizations

api_key

X-API-KEYstringRequired

Path parameters

idstringRequired

Responses

200

200

application/json

idstringRequired

__entitystringOptionalExample: Entity

createdAtone ofRequiredExample: 2026-03-27T15:47:09.539Z

string · date-timeOptional

or

string · date-timeOptional

updatedAtone ofRequiredExample: 2026-03-27T15:47:09.539Z

string · date-timeOptional

or

string · date-timeOptional

deletedAtone of · nullableRequiredExample: 2026-03-27T15:47:09.540Z

string · date-timeOptional

or

string · date-timeOptional

namestringRequired

descriptionstring · nullableRequired

keystringRequired

keyHashstringRequired

activebooleanRequired

lastUsedAtstring · date-time · nullableRequired

accountIdstringRequired

roleIdstring · nullableRequired

401

401

application/json

403

403

application/json

404

404

application/json

get

/clients/api/v1/api-keys/{id}

HTTPcURLJavaScriptPython

GET /clients/api/v1/api-keys/{id} HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "__entity": "Entity",
  "createdAt": "2026-03-27T15:47:09.539Z",
  "updatedAt": "2026-03-27T15:47:09.539Z",
  "deletedAt": "2026-03-27T15:47:09.540Z",
  "name": "text",
  "description": "text",
  "key": "text",
  "keyHash": "text",
  "active": true,
  "lastUsedAt": "2026-04-03T18:33:24.863Z",
  "accountId": "text",
  "roleId": "text"
}

Deactivate API Key by id

patch

Authorizations

api_key

X-API-KEYstringRequired

Path parameters

idstringRequired

Body

application/json

objectOptional

Responses

202

202

application/json

400

400

application/json

401

401

application/json

404

404

application/json

500

500

application/json

patch

/clients/api/v1/api-keys/{id}/deactivate

HTTPcURLJavaScriptPython

PATCH /clients/api/v1/api-keys/{id}/deactivate HTTP/1.1
Host: platform.dalmoregroup.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "id": "text",
  "__entity": "Entity",
  "createdAt": "2026-03-27T15:47:09.539Z",
  "updatedAt": "2026-03-27T15:47:09.539Z",
  "deletedAt": "2026-03-27T15:47:09.540Z",
  "name": "text",
  "description": "text",
  "key": "text",
  "keyHash": "text",
  "active": true,
  "lastUsedAt": "2026-04-03T18:33:24.863Z",
  "accountId": "text",
  "roleId": "text"
}