{ "info": { "_postman_id": "55d8e49b-9d7c-4dc2-bceb-9fda8c0a46d4", "name": "Clerk Backend Account Portal API Keys API", "description": "The Clerk REST Backend API, meant to be accessed by backend servers.\n\n### Versions\n\nWhen the API changes in a way that isn't compatible with older versions, a new version is released.\nEach version is identified by its release date, e.g. `2025-04-10`. For more information, please see [Clerk API Versions](https://clerk.com/docs/versioning/available-versions).\n\nPlease see https://clerk.com/docs for more information.\n\nContact Support:\n Name: Clerk Platform Team\n Email: support@clerk.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:22:19.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "lastUpdatedBy": "35240", "uid": "35240-55d8e49b-9d7c-4dc2-bceb-9fda8c0a46d4" }, "item": [ { "name": "api_keys", "item": [ { "name": "{apiKeyID}", "item": [ { "name": "secret", "item": [ { "name": "Get an API Key Secret", "id": "ce457374-46db-42d3-b774-26e93cc935d0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID/secret", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID", "secret" ], "variable": [ { "id": "58357cec-4d5d-469e-928b-70fc1c129be4", "key": "apiKeyID", "value": "api_key_5df4c1DD4f734A30bda74A816FaB1Fa7", "description": "(Required) " } ] } }, "response": [ { "id": "1e1e9229-69b4-4808-941f-3937847ebbc5", "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID/secret", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID", "secret" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"secret\": \"\"\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-1e1e9229-69b4-4808-941f-3937847ebbc5" }, { "id": "5902f296-fad3-44ab-8989-44bc5c25393a", "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID/secret", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID", "secret" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-5902f296-fad3-44ab-8989-44bc5c25393a" }, { "id": "eb3a4a5a-d101-46c7-8c1b-2c5d1a5cd776", "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID/secret", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID", "secret" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-eb3a4a5a-d101-46c7-8c1b-2c5d1a5cd776" } ], "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-ce457374-46db-42d3-b774-26e93cc935d0" } ], "id": "30f88528-1da4-4d8f-b935-d144d4919498", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-30f88528-1da4-4d8f-b935-d144d4919498" }, { "name": "revoke", "item": [ { "name": "Revoke an API Key", "id": "502679a7-196d-4e8c-9d84-b6b903a9b32a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"revocation_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID/revoke", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID", "revoke" ], "variable": [ { "id": "4ad486f4-99c8-4d23-a232-3c29add94ad5", "key": "apiKeyID", "value": "api_key_5df4c1DD4f734A30bda74A816FaB1Fa7", "description": "(Required) " } ] } }, "response": [ { "id": "431126ec-5c37-4292-b8f4-a6ae0945af8f", "name": "200 OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"revocation_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID/revoke", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID", "revoke" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"api_key\",\n \"id\": \"ak_7FcFCfDeAb80f90d004Fe1ab83acAf3B\",\n \"type\": \"\",\n \"subject\": \"mch_SiZ930Od_QFy2hYakMZP2lvc4ez\",\n \"name\": \"\",\n \"claims\": {\n \"nullable\": true,\n \"example\": {\n \"foo\": \"bar\"\n }\n },\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"revoked\": \"\",\n \"revocation_reason\": \"\",\n \"expired\": \"\",\n \"expiration\": \"\",\n \"created_by\": \"user_sYrWWi9oe8irOHmObhRESpUZoaG\",\n \"last_used_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-431126ec-5c37-4292-b8f4-a6ae0945af8f" }, { "id": "7bd52a52-de33-4222-8ef4-2a2bcdfb0877", "name": "400 Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"revocation_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID/revoke", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID", "revoke" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-7bd52a52-de33-4222-8ef4-2a2bcdfb0877" }, { "id": "20be6db0-c53a-4b7a-a966-12c46d9940ca", "name": "404 Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"revocation_reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID/revoke", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID", "revoke" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-20be6db0-c53a-4b7a-a966-12c46d9940ca" } ], "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-502679a7-196d-4e8c-9d84-b6b903a9b32a" } ], "id": "7643fb6c-b2a7-420c-aef6-3cdec64f92c1", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-7643fb6c-b2a7-420c-aef6-3cdec64f92c1" }, { "name": "Get an API Key by ID", "id": "fff704e5-2cbf-42d1-b4af-bf1aa5edbb07", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID" ], "variable": [ { "id": "5f4844d2-b0d7-489e-b82e-eb80df700c6d", "key": "apiKeyID", "value": "api_key_5df4c1DD4f734A30bda74A816FaB1Fa7", "description": "(Required) " } ] } }, "response": [ { "id": "2941fd97-285e-4c28-8ad1-dd6acb637c7d", "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"api_key\",\n \"id\": \"ak_7FcFCfDeAb80f90d004Fe1ab83acAf3B\",\n \"type\": \"\",\n \"subject\": \"mch_SiZ930Od_QFy2hYakMZP2lvc4ez\",\n \"name\": \"\",\n \"claims\": {\n \"nullable\": true,\n \"example\": {\n \"foo\": \"bar\"\n }\n },\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"revoked\": \"\",\n \"revocation_reason\": \"\",\n \"expired\": \"\",\n \"expiration\": \"\",\n \"created_by\": \"user_sYrWWi9oe8irOHmObhRESpUZoaG\",\n \"last_used_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-2941fd97-285e-4c28-8ad1-dd6acb637c7d" }, { "id": "f81cb77e-6524-4457-a71c-fe89eba9cd9c", "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-f81cb77e-6524-4457-a71c-fe89eba9cd9c" }, { "id": "23ab9ce7-aa23-4821-82a0-e044ab714219", "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-23ab9ce7-aa23-4821-82a0-e044ab714219" } ], "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-fff704e5-2cbf-42d1-b4af-bf1aa5edbb07" }, { "name": "Update an API Key", "id": "26699ef6-4fe5-46f6-9879-c04e863c6f47", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"claims\": {\n \"nullable\": true\n },\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"subject\": \"mch_0QJarc_9vYdqGnDrjfAF1ny0XhO\",\n \"seconds_until_expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID" ], "variable": [ { "id": "65407e67-eebc-46ac-8f30-e66d47af37fb", "key": "apiKeyID", "value": "api_key_5df4c1DD4f734A30bda74A816FaB1Fa7", "description": "(Required) " } ] } }, "response": [ { "id": "0e501129-9082-4105-80b2-d204bf80ca8b", "name": "200 OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"claims\": {\n \"nullable\": true\n },\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"subject\": \"mch_0QJarc_9vYdqGnDrjfAF1ny0XhO\",\n \"seconds_until_expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"api_key\",\n \"id\": \"ak_7FcFCfDeAb80f90d004Fe1ab83acAf3B\",\n \"type\": \"\",\n \"subject\": \"mch_SiZ930Od_QFy2hYakMZP2lvc4ez\",\n \"name\": \"\",\n \"claims\": {\n \"nullable\": true,\n \"example\": {\n \"foo\": \"bar\"\n }\n },\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"revoked\": \"\",\n \"revocation_reason\": \"\",\n \"expired\": \"\",\n \"expiration\": \"\",\n \"created_by\": \"user_sYrWWi9oe8irOHmObhRESpUZoaG\",\n \"last_used_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-0e501129-9082-4105-80b2-d204bf80ca8b" }, { "id": "51c3561d-bd3d-4036-8d47-1ef3603be5b5", "name": "400 Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"claims\": {\n \"nullable\": true\n },\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"subject\": \"mch_0QJarc_9vYdqGnDrjfAF1ny0XhO\",\n \"seconds_until_expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-51c3561d-bd3d-4036-8d47-1ef3603be5b5" }, { "id": "f62db43d-6df8-49b0-8f54-bb0f50fa637f", "name": "404 Not Found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"claims\": {\n \"nullable\": true\n },\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"subject\": \"mch_0QJarc_9vYdqGnDrjfAF1ny0XhO\",\n \"seconds_until_expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-f62db43d-6df8-49b0-8f54-bb0f50fa637f" } ], "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-26699ef6-4fe5-46f6-9879-c04e863c6f47" }, { "name": "Delete an API Key", "id": "90cf9271-8c46-405d-83e3-dd537ad9d6cc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID" ], "variable": [ { "id": "6aa37a1c-c461-43b8-b54d-70cbcb94a9a6", "key": "apiKeyID", "value": "api_key_5df4c1DD4f734A30bda74A816FaB1Fa7", "description": "(Required) " } ] } }, "response": [ { "id": "54cbcfa2-01b9-4a4f-8695-dd386cec51c0", "name": "200 OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"object\": \"api_key\",\n \"deleted\": true\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-54cbcfa2-01b9-4a4f-8695-dd386cec51c0" }, { "id": "96802290-f249-434a-8df9-d4ecc1b18abd", "name": "400 Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-96802290-f249-434a-8df9-d4ecc1b18abd" }, { "id": "505229e4-ac5c-4d91-a2fc-ce4c733788fe", "name": "404 Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_keys/:apiKeyID", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", ":apiKeyID" ], "variable": [ { "key": "apiKeyID" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-505229e4-ac5c-4d91-a2fc-ce4c733788fe" } ], "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-90cf9271-8c46-405d-83e3-dd537ad9d6cc" } ], "id": "7c7bc976-f486-41c7-9cfe-813bea849efe", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-7c7bc976-f486-41c7-9cfe-813bea849efe" }, { "name": "verify", "item": [ { "name": "Verify an API Key", "id": "727eaad4-ccb1-4b9b-8174-72e0b7219995", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"secret\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys/verify", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", "verify" ] } }, "response": [ { "id": "f9406d02-901d-4c64-bcde-a8980442120c", "name": "200 OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"secret\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys/verify", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", "verify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"api_key\",\n \"id\": \"ak_7FcFCfDeAb80f90d004Fe1ab83acAf3B\",\n \"type\": \"\",\n \"subject\": \"mch_SiZ930Od_QFy2hYakMZP2lvc4ez\",\n \"name\": \"\",\n \"claims\": {\n \"nullable\": true,\n \"example\": {\n \"foo\": \"bar\"\n }\n },\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"revoked\": \"\",\n \"revocation_reason\": \"\",\n \"expired\": \"\",\n \"expiration\": \"\",\n \"created_by\": \"user_sYrWWi9oe8irOHmObhRESpUZoaG\",\n \"last_used_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-f9406d02-901d-4c64-bcde-a8980442120c" }, { "id": "429571a0-7a50-4e17-8e79-fc00b2401dae", "name": "400 Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"secret\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys/verify", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", "verify" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-429571a0-7a50-4e17-8e79-fc00b2401dae" }, { "id": "581d4ed5-1453-4977-b3d2-fba246b30ff5", "name": "404 Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"secret\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys/verify", "host": [ "{{baseUrl}}" ], "path": [ "api_keys", "verify" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-581d4ed5-1453-4977-b3d2-fba246b30ff5" } ], "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-727eaad4-ccb1-4b9b-8174-72e0b7219995" } ], "id": "3b5e8582-b46c-4dd4-b2c8-a10df8a6befc", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-3b5e8582-b46c-4dd4-b2c8-a10df8a6befc" }, { "name": "Create an API Key", "id": "2476136d-25ff-430e-9dd7-ffbaacb161cd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \" \",\n \"subject\": \"scim_Bc0nL8KitqcCLPCsctkD1QDw4gm\",\n \"type\": \"api_key\",\n \"description\": \"\",\n \"claims\": {\n \"nullable\": true\n },\n \"created_by\": \"user__ixQzUTG6wST4sdzD9cXhQH68k2\",\n \"seconds_until_expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys", "host": [ "{{baseUrl}}" ], "path": [ "api_keys" ] } }, "response": [ { "id": "f788c26a-1312-41e8-bc24-c2efc6885597", "name": "200 OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \" \",\n \"subject\": \"scim_Bc0nL8KitqcCLPCsctkD1QDw4gm\",\n \"type\": \"api_key\",\n \"description\": \"\",\n \"claims\": {\n \"nullable\": true\n },\n \"created_by\": \"user__ixQzUTG6wST4sdzD9cXhQH68k2\",\n \"seconds_until_expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys", "host": [ "{{baseUrl}}" ], "path": [ "api_keys" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"api_key\",\n \"id\": \"ak_e83c3dee95Ee2c08ce9Ccd110e3BAa01\",\n \"type\": \"\",\n \"subject\": \"mch_3HKTt6YB69TBwhvgzRHSFsruqIL\",\n \"name\": \"\",\n \"claims\": {\n \"nullable\": true,\n \"example\": {\n \"foo\": \"bar\"\n }\n },\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"secret\": \"\",\n \"revoked\": \"\",\n \"revocation_reason\": \"\",\n \"expired\": \"\",\n \"expiration\": \"\",\n \"created_by\": \"user_myx9hRWIdFEHaLV9guPCuIEBUNL\",\n \"last_used_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-f788c26a-1312-41e8-bc24-c2efc6885597" }, { "id": "518d0bc4-69bc-4c7b-bc7a-a04e59bd3992", "name": "400 Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \" \",\n \"subject\": \"scim_Bc0nL8KitqcCLPCsctkD1QDw4gm\",\n \"type\": \"api_key\",\n \"description\": \"\",\n \"claims\": {\n \"nullable\": true\n },\n \"created_by\": \"user__ixQzUTG6wST4sdzD9cXhQH68k2\",\n \"seconds_until_expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys", "host": [ "{{baseUrl}}" ], "path": [ "api_keys" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-518d0bc4-69bc-4c7b-bc7a-a04e59bd3992" }, { "id": "751b936f-2c70-4a6c-a99b-02daf6982f00", "name": "409 Conflict", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \" \",\n \"subject\": \"scim_Bc0nL8KitqcCLPCsctkD1QDw4gm\",\n \"type\": \"api_key\",\n \"description\": \"\",\n \"claims\": {\n \"nullable\": true\n },\n \"created_by\": \"user__ixQzUTG6wST4sdzD9cXhQH68k2\",\n \"seconds_until_expiration\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_keys", "host": [ "{{baseUrl}}" ], "path": [ "api_keys" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-751b936f-2c70-4a6c-a99b-02daf6982f00" } ], "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-2476136d-25ff-430e-9dd7-ffbaacb161cd" }, { "name": "Get API Keys", "id": "73082e2a-97de-4411-9c9e-16abef1f29df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api_keys?type=api_key&subject=scim_6iUayIcuQmB8QHy0H4pEBI4De9t&include_invalid=false&limit=10&offset=0&query=", "host": [ "{{baseUrl}}" ], "path": [ "api_keys" ], "query": [ { "key": "type", "value": "api_key" }, { "description": "(Required) ", "key": "subject", "value": "scim_6iUayIcuQmB8QHy0H4pEBI4De9t" }, { "key": "include_invalid", "value": "false" }, { "key": "limit", "value": "10" }, { "key": "offset", "value": "0" }, { "key": "query", "value": "" } ] } }, "response": [ { "id": "e0f80f80-fede-4fc4-af67-b62f39e737a1", "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_keys?type=api_key&subject=scim_6iUayIcuQmB8QHy0H4pEBI4De9t&include_invalid=false&limit=10&offset=0&query=", "host": [ "{{baseUrl}}" ], "path": [ "api_keys" ], "query": [ { "key": "type", "value": "api_key" }, { "description": "(Required) ", "key": "subject", "value": "scim_6iUayIcuQmB8QHy0H4pEBI4De9t" }, { "key": "include_invalid", "value": "false" }, { "key": "limit", "value": "10" }, { "key": "offset", "value": "0" }, { "key": "query", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"object\": \"api_key\",\n \"id\": \"ak_7AF7EbB7bc9efBE0Ef6B3A3f43cC9d5A\",\n \"type\": \"\",\n \"subject\": \"user_ve2vQJlFS4XAedSzHfgDfwDrfeX\",\n \"name\": \"\",\n \"claims\": {\n \"nullable\": true,\n \"example\": {\n \"foo\": \"bar\"\n }\n },\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"revoked\": \"\",\n \"revocation_reason\": \"\",\n \"expired\": \"\",\n \"expiration\": \"\",\n \"created_by\": \"user_Z5tp61KE8EPDhlFEHzihbBR4u_m\",\n \"last_used_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n },\n {\n \"object\": \"api_key\",\n \"id\": \"ak_e49a6ece6A9FddE7d224e12e5fb4FDBb\",\n \"type\": \"\",\n \"subject\": \"org_KEgpAclRQwgTNrwnPO1CNVwVZyF\",\n \"name\": \"\",\n \"claims\": {\n \"nullable\": true,\n \"example\": {\n \"foo\": \"bar\"\n }\n },\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"revoked\": \"\",\n \"revocation_reason\": \"\",\n \"expired\": \"\",\n \"expiration\": \"\",\n \"created_by\": \"user_UxF23tzPR7XjsbphfV0ezFvPMGd\",\n \"last_used_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n }\n ],\n \"total_count\": \"\"\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-e0f80f80-fede-4fc4-af67-b62f39e737a1" }, { "id": "344731b5-aa61-45f4-8ebf-7c735496121c", "name": "400 Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_keys?type=api_key&subject=scim_6iUayIcuQmB8QHy0H4pEBI4De9t&include_invalid=false&limit=10&offset=0&query=", "host": [ "{{baseUrl}}" ], "path": [ "api_keys" ], "query": [ { "key": "type", "value": "api_key" }, { "description": "(Required) ", "key": "subject", "value": "scim_6iUayIcuQmB8QHy0H4pEBI4De9t" }, { "key": "include_invalid", "value": "false" }, { "key": "limit", "value": "10" }, { "key": "offset", "value": "0" }, { "key": "query", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-344731b5-aa61-45f4-8ebf-7c735496121c" }, { "id": "c744b557-8be3-4b37-bd45-16c893b36592", "name": "404 Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_keys?type=api_key&subject=scim_6iUayIcuQmB8QHy0H4pEBI4De9t&include_invalid=false&limit=10&offset=0&query=", "host": [ "{{baseUrl}}" ], "path": [ "api_keys" ], "query": [ { "key": "type", "value": "api_key" }, { "description": "(Required) ", "key": "subject", "value": "scim_6iUayIcuQmB8QHy0H4pEBI4De9t" }, { "key": "include_invalid", "value": "false" }, { "key": "limit", "value": "10" }, { "key": "offset", "value": "0" }, { "key": "query", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-c744b557-8be3-4b37-bd45-16c893b36592" } ], "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-73082e2a-97de-4411-9c9e-16abef1f29df" } ], "id": "92dbe93d-930b-4b12-bb62-7dfd8a89dcfb", "createdAt": "2026-07-28T01:22:20.000Z", "updatedAt": "2026-07-28T01:22:20.000Z", "uid": "35240-92dbe93d-930b-4b12-bb62-7dfd8a89dcfb" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.clerk.com/v1" } ] }