{ "info": { "_postman_id": "beb0f685-4126-449f-98d8-57fae91433ba", "name": "Clerk Backend Account Portal Organization Roles 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:24:33.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "lastUpdatedBy": "35240", "uid": "35240-beb0f685-4126-449f-98d8-57fae91433ba" }, "item": [ { "name": "organization_roles", "item": [ { "name": "{organization_role_id}", "item": [ { "name": "permissions", "item": [ { "name": "{permission_id}", "item": [ { "name": "Assign a Permission to an Organization Role", "id": "e26a3a78-7507-41a9-a034-259acfcb7d78", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id/permissions/:permission_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id", "permissions", ":permission_id" ], "variable": [ { "id": "d553476f-0e56-4722-9018-be7523a4007a", "key": "organization_role_id", "value": "", "description": "(Required) The ID of the organization role" }, { "id": "fe1e5743-2dec-420c-ac44-eefbd7b6472a", "key": "permission_id", "value": "", "description": "(Required) The ID of the permission to assign" } ] }, "description": "Assigns a permission to an organization role" }, "response": [ { "id": "6e621233-1306-499f-b903-951bbbf141f6", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id/permissions/:permission_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id", "permissions", ":permission_id" ], "variable": [ { "key": "organization_role_id" }, { "key": "permission_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"role\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"is_creator_eligible\": \"\",\n \"permissions\": [\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-6e621233-1306-499f-b903-951bbbf141f6" }, { "id": "293eae37-e389-439a-ab80-829857e546b1", "name": "Authentication invalid", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id/permissions/:permission_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id", "permissions", ":permission_id" ], "variable": [ { "key": "organization_role_id" }, { "key": "permission_id" } ] } }, "status": "Unauthorized", "code": 401, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-293eae37-e389-439a-ab80-829857e546b1" }, { "id": "8bf9e172-889d-4160-8236-ca1cc5a60612", "name": "Authorization invalid", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id/permissions/:permission_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id", "permissions", ":permission_id" ], "variable": [ { "key": "organization_role_id" }, { "key": "permission_id" } ] } }, "status": "Forbidden", "code": 403, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-8bf9e172-889d-4160-8236-ca1cc5a60612" }, { "id": "308097f8-e30d-424b-bfaa-9b60653337d1", "name": "Resource not found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id/permissions/:permission_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id", "permissions", ":permission_id" ], "variable": [ { "key": "organization_role_id" }, { "key": "permission_id" } ] } }, "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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-308097f8-e30d-424b-bfaa-9b60653337d1" }, { "id": "8dd375f5-4f5d-4679-9103-d56ec32289dc", "name": "Conflict", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id/permissions/:permission_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id", "permissions", ":permission_id" ], "variable": [ { "key": "organization_role_id" }, { "key": "permission_id" } ] } }, "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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-8dd375f5-4f5d-4679-9103-d56ec32289dc" } ], "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-e26a3a78-7507-41a9-a034-259acfcb7d78" }, { "name": "Remove a Permission from an Organization Role", "id": "9f631faf-fdff-4642-8a06-5c1e46548511", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id/permissions/:permission_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id", "permissions", ":permission_id" ], "variable": [ { "id": "aa26c3af-ed7a-46f4-bb51-d5a40e6645b2", "key": "organization_role_id", "value": "", "description": "(Required) The ID of the organization role" }, { "id": "9e9de523-dd48-4cf7-aef0-b4d1b95ac604", "key": "permission_id", "value": "", "description": "(Required) The ID of the permission to remove" } ] }, "description": "Removes a permission from an organization role" }, "response": [ { "id": "70b82d88-1348-4e00-a3ba-6602786cea68", "name": "Success", "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}}/organization_roles/:organization_role_id/permissions/:permission_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id", "permissions", ":permission_id" ], "variable": [ { "key": "organization_role_id" }, { "key": "permission_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"role\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"is_creator_eligible\": \"\",\n \"permissions\": [\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-70b82d88-1348-4e00-a3ba-6602786cea68" }, { "id": "5dca41f0-4dea-4dc3-8eb1-00baa670832b", "name": "Authentication invalid", "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}}/organization_roles/:organization_role_id/permissions/:permission_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id", "permissions", ":permission_id" ], "variable": [ { "key": "organization_role_id" }, { "key": "permission_id" } ] } }, "status": "Unauthorized", "code": 401, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-5dca41f0-4dea-4dc3-8eb1-00baa670832b" }, { "id": "675b70ff-e84a-40cb-830d-3c1f3f733a9b", "name": "Authorization invalid", "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}}/organization_roles/:organization_role_id/permissions/:permission_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id", "permissions", ":permission_id" ], "variable": [ { "key": "organization_role_id" }, { "key": "permission_id" } ] } }, "status": "Forbidden", "code": 403, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-675b70ff-e84a-40cb-830d-3c1f3f733a9b" }, { "id": "5f15286c-e23d-44e2-b251-1c2089f2ec28", "name": "Resource 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}}/organization_roles/:organization_role_id/permissions/:permission_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id", "permissions", ":permission_id" ], "variable": [ { "key": "organization_role_id" }, { "key": "permission_id" } ] } }, "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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-5f15286c-e23d-44e2-b251-1c2089f2ec28" }, { "id": "c3479eb5-5924-46b4-b265-aaf09b91da34", "name": "Invalid request parameters", "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}}/organization_roles/:organization_role_id/permissions/:permission_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id", "permissions", ":permission_id" ], "variable": [ { "key": "organization_role_id" }, { "key": "permission_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-c3479eb5-5924-46b4-b265-aaf09b91da34" } ], "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-9f631faf-fdff-4642-8a06-5c1e46548511" } ], "id": "d3235e10-e96b-4fb0-854f-d4815ae39997", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-d3235e10-e96b-4fb0-854f-d4815ae39997" } ], "id": "a988da44-3ace-4914-960f-7a574ee32868", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-a988da44-3ace-4914-960f-7a574ee32868" }, { "name": "Retrieve an Organization Role", "id": "72301eec-be96-4c15-8642-9206ffaf7da1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "id": "6f6c3312-b5d9-43fb-a0f3-d090de9df070", "key": "organization_role_id", "value": "", "description": "(Required) The ID of the organization role" } ] }, "description": "Use this request to retrieve an existing organization role by its ID." }, "response": [ { "id": "5ccbc2a5-8176-42f1-907d-a414863c633e", "name": "Success", "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}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"role\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"is_creator_eligible\": \"\",\n \"permissions\": [\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-5ccbc2a5-8176-42f1-907d-a414863c633e" }, { "id": "f2b79d4a-9846-4aa5-a16c-188af679a2a4", "name": "Authentication invalid", "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}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "status": "Unauthorized", "code": 401, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-f2b79d4a-9846-4aa5-a16c-188af679a2a4" }, { "id": "7d01f4a6-a930-4af9-8a9a-db8aa00a14f2", "name": "Authorization invalid", "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}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "status": "Forbidden", "code": 403, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-7d01f4a6-a930-4af9-8a9a-db8aa00a14f2" }, { "id": "86adaa03-b0ac-4715-b47c-54f0c598a380", "name": "Resource 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}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-86adaa03-b0ac-4715-b47c-54f0c598a380" } ], "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-72301eec-be96-4c15-8642-9206ffaf7da1" }, { "name": "Update an Organization Role", "id": "7127cc72-141c-4e05-a019-0875c3050cdd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "id": "b867fd1f-2b20-4e57-a7f0-af1b945faab7", "key": "organization_role_id", "value": "", "description": "(Required) The ID of the organization role to update" } ] }, "description": "Updates an existing organization role.\nYou can update the name, key, description, and permissions of the role.\nAll parameters are optional - you can update only the fields you want to change.\nIf the role is used as a creator role or domain default role, updating the key will cascade the update to the organization settings." }, "response": [ { "id": "cd12a0d0-4670-4296-a555-5068270b2f15", "name": "Success", "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 \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"role\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"is_creator_eligible\": \"\",\n \"permissions\": [\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-cd12a0d0-4670-4296-a555-5068270b2f15" }, { "id": "d14b862d-19dc-47c9-8c42-4807ff71d500", "name": "Request was not successful", "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 \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-d14b862d-19dc-47c9-8c42-4807ff71d500" }, { "id": "085ddb64-84b3-4b9a-8416-d15ab4ebe996", "name": "Authentication invalid", "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 \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "status": "Unauthorized", "code": 401, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-085ddb64-84b3-4b9a-8416-d15ab4ebe996" }, { "id": "6589c249-ef08-45bd-a37c-e9b551a6c6ba", "name": "Authorization invalid", "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 \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "status": "Forbidden", "code": 403, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-6589c249-ef08-45bd-a37c-e9b551a6c6ba" }, { "id": "a2317f93-5015-4087-89de-e61eae6fa6ab", "name": "Resource 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 \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-a2317f93-5015-4087-89de-e61eae6fa6ab" }, { "id": "51d205c1-5f28-4886-bc07-460d4390072e", "name": "Invalid request parameters", "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 \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-51d205c1-5f28-4886-bc07-460d4390072e" } ], "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-7127cc72-141c-4e05-a019-0875c3050cdd" }, { "name": "Delete an Organization Role", "id": "5a3145e8-1fdd-4b77-9db1-8f22d02757d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "id": "04bc8487-bec0-408e-994d-c3c1a5e82349", "key": "organization_role_id", "value": "", "description": "(Required) The ID of the organization role to delete" } ] }, "description": "Deletes the organization role.\nThe role cannot be deleted if it is currently used as the default creator role, domain default role, assigned to any members, or exists in any invitations." }, "response": [ { "id": "c58b18f6-c75f-4d76-a612-542d138f9651", "name": "Deleted Object", "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}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"\",\n \"deleted\": \"\",\n \"id\": \"\",\n \"slug\": \"\",\n \"external_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-c58b18f6-c75f-4d76-a612-542d138f9651" }, { "id": "a4c718e2-16e7-475d-b68d-51321fe95547", "name": "Authentication invalid", "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}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "status": "Unauthorized", "code": 401, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-a4c718e2-16e7-475d-b68d-51321fe95547" }, { "id": "7062ecf0-32c3-40ff-bdc1-2bb6a9209ec4", "name": "Authorization invalid", "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}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "status": "Forbidden", "code": 403, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-7062ecf0-32c3-40ff-bdc1-2bb6a9209ec4" }, { "id": "2c0c4c6e-212a-4bb3-b65c-91e782a62382", "name": "Resource 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}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-2c0c4c6e-212a-4bb3-b65c-91e782a62382" }, { "id": "4a79919b-9357-4caa-88f1-e360bf35bc65", "name": "Invalid request parameters", "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}}/organization_roles/:organization_role_id", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles", ":organization_role_id" ], "variable": [ { "key": "organization_role_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-4a79919b-9357-4caa-88f1-e360bf35bc65" } ], "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-5a3145e8-1fdd-4b77-9db1-8f22d02757d9" } ], "id": "2ab063d7-683f-42ce-940c-9a22d7ad12fc", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-2ab063d7-683f-42ce-940c-9a22d7ad12fc" }, { "name": "Get a List of Organization Roles", "id": "875042e3-0b1e-4d20-9faa-2ac633aa3339", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/organization_roles?query=&order_by=-created_at&limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ], "query": [ { "description": "Returns organization roles with ID, name, or key that match the given query.\nUses exact match for organization role ID and partial match for name and key.", "key": "query", "value": "" }, { "description": "Allows to return organization roles in a particular order.\nAt the moment, you can order the returned organization roles by their `created_at`, `name`, or `key`.\nIn order to specify the direction, you can use the `+/-` symbols prepended in the property to order by.\nFor example, if you want organization roles to be returned in descending order according to their `created_at` property, you can use `-created_at`.\nIf you don't use `+` or `-`, then `+` is implied.\nDefaults to `-created_at`.", "key": "order_by", "value": "-created_at" }, { "description": "Applies a limit to the number of results returned.\nCan be used for paginating the results together with `offset`.", "key": "limit", "value": "10" }, { "description": "Skip the first `offset` results when paginating.\nNeeds to be an integer greater or equal to zero.\nTo be used in conjunction with `limit`.", "key": "offset", "value": "0" } ] }, "description": "This request returns the list of organization roles for the instance.\nResults can be paginated using the optional `limit` and `offset` query parameters.\nThe organization roles are ordered by descending creation date.\nMost recent roles will be returned first." }, "response": [ { "id": "dfc65aef-43e0-4c5a-a52e-3011e48aba2e", "name": "Success", "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}}/organization_roles?query=&order_by=-created_at&limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ], "query": [ { "description": "Returns organization roles with ID, name, or key that match the given query.\nUses exact match for organization role ID and partial match for name and key.", "key": "query", "value": "" }, { "description": "Allows to return organization roles in a particular order.\nAt the moment, you can order the returned organization roles by their `created_at`, `name`, or `key`.\nIn order to specify the direction, you can use the `+/-` symbols prepended in the property to order by.\nFor example, if you want organization roles to be returned in descending order according to their `created_at` property, you can use `-created_at`.\nIf you don't use `+` or `-`, then `+` is implied.\nDefaults to `-created_at`.", "key": "order_by", "value": "-created_at" }, { "description": "Applies a limit to the number of results returned.\nCan be used for paginating the results together with `offset`.", "key": "limit", "value": "10" }, { "description": "Skip the first `offset` results when paginating.\nNeeds to be an integer greater or equal to zero.\nTo be used in conjunction with `limit`.", "key": "offset", "value": "0" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"object\": \"role\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"is_creator_eligible\": \"\",\n \"permissions\": [\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"object\": \"role\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"is_creator_eligible\": \"\",\n \"permissions\": [\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"total_count\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-dfc65aef-43e0-4c5a-a52e-3011e48aba2e" }, { "id": "fdf29813-b065-44af-ad6d-09aafe0ee739", "name": "Request was not successful", "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}}/organization_roles?query=&order_by=-created_at&limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ], "query": [ { "description": "Returns organization roles with ID, name, or key that match the given query.\nUses exact match for organization role ID and partial match for name and key.", "key": "query", "value": "" }, { "description": "Allows to return organization roles in a particular order.\nAt the moment, you can order the returned organization roles by their `created_at`, `name`, or `key`.\nIn order to specify the direction, you can use the `+/-` symbols prepended in the property to order by.\nFor example, if you want organization roles to be returned in descending order according to their `created_at` property, you can use `-created_at`.\nIf you don't use `+` or `-`, then `+` is implied.\nDefaults to `-created_at`.", "key": "order_by", "value": "-created_at" }, { "description": "Applies a limit to the number of results returned.\nCan be used for paginating the results together with `offset`.", "key": "limit", "value": "10" }, { "description": "Skip the first `offset` results when paginating.\nNeeds to be an integer greater or equal to zero.\nTo be used in conjunction with `limit`.", "key": "offset", "value": "0" } ] } }, "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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-fdf29813-b065-44af-ad6d-09aafe0ee739" }, { "id": "451c60ff-7e93-4655-b693-dc7a6a3690bd", "name": "Authentication invalid", "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}}/organization_roles?query=&order_by=-created_at&limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ], "query": [ { "description": "Returns organization roles with ID, name, or key that match the given query.\nUses exact match for organization role ID and partial match for name and key.", "key": "query", "value": "" }, { "description": "Allows to return organization roles in a particular order.\nAt the moment, you can order the returned organization roles by their `created_at`, `name`, or `key`.\nIn order to specify the direction, you can use the `+/-` symbols prepended in the property to order by.\nFor example, if you want organization roles to be returned in descending order according to their `created_at` property, you can use `-created_at`.\nIf you don't use `+` or `-`, then `+` is implied.\nDefaults to `-created_at`.", "key": "order_by", "value": "-created_at" }, { "description": "Applies a limit to the number of results returned.\nCan be used for paginating the results together with `offset`.", "key": "limit", "value": "10" }, { "description": "Skip the first `offset` results when paginating.\nNeeds to be an integer greater or equal to zero.\nTo be used in conjunction with `limit`.", "key": "offset", "value": "0" } ] } }, "status": "Unauthorized", "code": 401, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-451c60ff-7e93-4655-b693-dc7a6a3690bd" }, { "id": "fd4828aa-6543-4560-8d40-69219af0ae58", "name": "Authorization invalid", "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}}/organization_roles?query=&order_by=-created_at&limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ], "query": [ { "description": "Returns organization roles with ID, name, or key that match the given query.\nUses exact match for organization role ID and partial match for name and key.", "key": "query", "value": "" }, { "description": "Allows to return organization roles in a particular order.\nAt the moment, you can order the returned organization roles by their `created_at`, `name`, or `key`.\nIn order to specify the direction, you can use the `+/-` symbols prepended in the property to order by.\nFor example, if you want organization roles to be returned in descending order according to their `created_at` property, you can use `-created_at`.\nIf you don't use `+` or `-`, then `+` is implied.\nDefaults to `-created_at`.", "key": "order_by", "value": "-created_at" }, { "description": "Applies a limit to the number of results returned.\nCan be used for paginating the results together with `offset`.", "key": "limit", "value": "10" }, { "description": "Skip the first `offset` results when paginating.\nNeeds to be an integer greater or equal to zero.\nTo be used in conjunction with `limit`.", "key": "offset", "value": "0" } ] } }, "status": "Forbidden", "code": 403, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-fd4828aa-6543-4560-8d40-69219af0ae58" }, { "id": "c0cf7a00-3165-49b0-bf22-0a2e1d0ae1a5", "name": "Invalid request parameters", "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}}/organization_roles?query=&order_by=-created_at&limit=10&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ], "query": [ { "description": "Returns organization roles with ID, name, or key that match the given query.\nUses exact match for organization role ID and partial match for name and key.", "key": "query", "value": "" }, { "description": "Allows to return organization roles in a particular order.\nAt the moment, you can order the returned organization roles by their `created_at`, `name`, or `key`.\nIn order to specify the direction, you can use the `+/-` symbols prepended in the property to order by.\nFor example, if you want organization roles to be returned in descending order according to their `created_at` property, you can use `-created_at`.\nIf you don't use `+` or `-`, then `+` is implied.\nDefaults to `-created_at`.", "key": "order_by", "value": "-created_at" }, { "description": "Applies a limit to the number of results returned.\nCan be used for paginating the results together with `offset`.", "key": "limit", "value": "10" }, { "description": "Skip the first `offset` results when paginating.\nNeeds to be an integer greater or equal to zero.\nTo be used in conjunction with `limit`.", "key": "offset", "value": "0" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-c0cf7a00-3165-49b0-bf22-0a2e1d0ae1a5" } ], "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-875042e3-0b1e-4d20-9faa-2ac633aa3339" }, { "name": "Create an Organization Role", "id": "ee428f40-868e-43d2-a817-40b9b382917c", "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 \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"include_in_initial_role_set\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ] }, "description": "Creates a new organization role with the given name and permissions for an instance.\nThe key must be unique for the instance and start with the 'org:' prefix, followed by lowercase alphanumeric characters and underscores only.\nYou can optionally provide a description for the role and specify whether it should be included in the initial role set.\nOrganization roles support permissions that can be assigned to control access within the organization." }, "response": [ { "id": "71d36625-8680-48e5-be5c-15c390859f9e", "name": "Success", "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 \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"include_in_initial_role_set\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"role\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"is_creator_eligible\": \"\",\n \"permissions\": [\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"object\": \"permission\",\n \"id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-71d36625-8680-48e5-be5c-15c390859f9e" }, { "id": "8e02436c-abf0-49d4-8e2d-1d8bf26bc369", "name": "Request was not successful", "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 \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"include_in_initial_role_set\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ] } }, "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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-8e02436c-abf0-49d4-8e2d-1d8bf26bc369" }, { "id": "40675a8e-8571-4bcd-a2cd-2982aa7e1885", "name": "Authentication invalid", "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 \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"include_in_initial_role_set\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ] } }, "status": "Unauthorized", "code": 401, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-40675a8e-8571-4bcd-a2cd-2982aa7e1885" }, { "id": "7ff2f149-ad5d-45fb-9c0a-051d041ea47c", "name": "Payment required", "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 \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"include_in_initial_role_set\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ] } }, "status": "Payment Required", "code": 402, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-7ff2f149-ad5d-45fb-9c0a-051d041ea47c" }, { "id": "1b306008-52bb-47eb-8e08-e6ebf9bd0532", "name": "Authorization invalid", "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 \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"include_in_initial_role_set\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ] } }, "status": "Forbidden", "code": 403, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-1b306008-52bb-47eb-8e08-e6ebf9bd0532" }, { "id": "5646ce6b-dde3-4c99-8c0f-27f10e0adac2", "name": "Resource 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 \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"include_in_initial_role_set\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ] } }, "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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-5646ce6b-dde3-4c99-8c0f-27f10e0adac2" }, { "id": "d4b6c9eb-9a7b-49a7-a88b-07e3c4be4f38", "name": "Invalid request parameters", "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 \"key\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\",\n \"\"\n ],\n \"include_in_initial_role_set\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organization_roles", "host": [ "{{baseUrl}}" ], "path": [ "organization_roles" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_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 \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-d4b6c9eb-9a7b-49a7-a88b-07e3c4be4f38" } ], "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-ee428f40-868e-43d2-a817-40b9b382917c" } ], "id": "0a4e2d38-e7f1-4ca6-808e-ad6fae0c2523", "createdAt": "2026-07-28T01:24:34.000Z", "updatedAt": "2026-07-28T01:24:34.000Z", "uid": "35240-0a4e2d38-e7f1-4ca6-808e-ad6fae0c2523" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.clerk.com/v1" } ] }