{ "info": { "_postman_id": "2ab3feb5-cd8c-4d63-8fd6-779af9321854", "name": "Commerce Layer Provisioning API", "description": "Headless Commerce for Global Brands.\n\nContact Support:\n Name: API Support\n Email: support@commercelayer.io", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:07:30.000Z", "updatedAt": "2026-06-05T15:07:30.000Z", "lastUpdatedBy": "35240", "uid": "35240-2ab3feb5-cd8c-4d63-8fd6-779af9321854" }, "item": [ { "name": "api_credentials", "item": [ { "name": "{apiCredentialId}", "item": [ { "name": "organization", "item": [ { "name": "Related API credential", "id": "61e3be34-533d-449a-a551-244f5f23258b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api_credentials/:apiCredentialId/organization", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials", ":apiCredentialId", "organization" ], "variable": [ { "id": "6d7b7d2d-df86-4e56-9b14-c6acaa1269cb", "key": "apiCredentialId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related API credential" }, "response": [ { "id": "73bd92b3-0d7f-447a-bb7b-ad702592daa8", "name": "The organization associated to the API credential", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_credentials/:apiCredentialId/organization", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials", ":apiCredentialId", "organization" ], "variable": [ { "key": "apiCredentialId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-73bd92b3-0d7f-447a-bb7b-ad702592daa8" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-61e3be34-533d-449a-a551-244f5f23258b" } ], "id": "4167c542-74c1-4cd7-b68b-5b51563368da", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-4167c542-74c1-4cd7-b68b-5b51563368da" }, { "name": "role", "item": [ { "name": "Related API credential", "id": "915af0a0-1825-4df7-935c-498b6c5e1cea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api_credentials/:apiCredentialId/role", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials", ":apiCredentialId", "role" ], "variable": [ { "id": "5af699ba-aadc-48df-ae7b-f0b4c0bacb9d", "key": "apiCredentialId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related API credential" }, "response": [ { "id": "b0d05546-94c8-4d1d-9d92-ff98c1b03f9d", "name": "The role associated to the API credential", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_credentials/:apiCredentialId/role", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials", ":apiCredentialId", "role" ], "variable": [ { "key": "apiCredentialId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-b0d05546-94c8-4d1d-9d92-ff98c1b03f9d" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-915af0a0-1825-4df7-935c-498b6c5e1cea" } ], "id": "a72b9ea2-1b5e-4c92-be68-882e2e0a5dae", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-a72b9ea2-1b5e-4c92-be68-882e2e0a5dae" }, { "name": "Retrieve an API credential", "id": "26c3ce8a-3abd-4f03-ac31-1c830c8c15ff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api_credentials/:apiCredentialId", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials", ":apiCredentialId" ], "variable": [ { "id": "3a168fc3-8328-4209-a5cd-8189dac18c02", "key": "apiCredentialId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Retrieve an API credential" }, "response": [ { "id": "0f68ff58-867d-438c-9d1e-7d224b5e8e34", "name": "The API credential object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_credentials/:apiCredentialId", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials", ":apiCredentialId" ], "variable": [ { "key": "apiCredentialId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"api_credentials\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"\",\n \"confidential\": \"\",\n \"redirect_uri\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\",\n \"expires_in\": \"\",\n \"mode\": \"\",\n \"custom\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-0f68ff58-867d-438c-9d1e-7d224b5e8e34" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-26c3ce8a-3abd-4f03-ac31-1c830c8c15ff" }, { "name": "Updates an API credential", "id": "5a73e53d-eaed-4221-b95f-c775a98cf26e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uri\": \"\",\n \"expires_in\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_credentials/:apiCredentialId", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials", ":apiCredentialId" ], "variable": [ { "id": "6754905e-85b4-4edb-920f-ae264b6fd8b0", "key": "apiCredentialId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Updates an API credential" }, "response": [ { "id": "c8749f6c-998f-4c76-b112-f336a36bf460", "name": "The updated API credential object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uri\": \"\",\n \"expires_in\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_credentials/:apiCredentialId", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials", ":apiCredentialId" ], "variable": [ { "key": "apiCredentialId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"api_credentials\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"\",\n \"confidential\": \"\",\n \"redirect_uri\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\",\n \"expires_in\": \"\",\n \"mode\": \"\",\n \"custom\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-c8749f6c-998f-4c76-b112-f336a36bf460" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-5a73e53d-eaed-4221-b95f-c775a98cf26e" }, { "name": "Delete an API credential", "id": "6566cb11-aabe-4615-8833-ebd6536e0c47", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api_credentials/:apiCredentialId", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials", ":apiCredentialId" ], "variable": [ { "id": "d5520058-036b-43b3-95e8-25526de9da67", "key": "apiCredentialId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Delete an API credential" }, "response": [ { "id": "11879594-c300-4287-974b-6c7238104092", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_credentials/:apiCredentialId", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials", ":apiCredentialId" ], "variable": [ { "key": "apiCredentialId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-11879594-c300-4287-974b-6c7238104092" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-6566cb11-aabe-4615-8833-ebd6536e0c47" } ], "id": "45079847-17a1-47b6-94ca-68a6ae454a44", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-45079847-17a1-47b6-94ca-68a6ae454a44" }, { "name": "Creates an API credential", "id": "5c2283d8-4bd0-444d-809d-d4412dc842f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"api_credentials\",\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"\",\n \"redirect_uri\": \"\",\n \"expires_in\": \"\",\n \"mode\": \"\",\n \"custom\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_credentials", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials" ] }, "description": "Creates an API credential" }, "response": [ { "id": "5d469cc1-d4aa-473d-ad4c-b6323eba3af0", "name": "The created API credential object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"api_credentials\",\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"\",\n \"redirect_uri\": \"\",\n \"expires_in\": \"\",\n \"mode\": \"\",\n \"custom\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api_credentials", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"api_credentials\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"\",\n \"confidential\": \"\",\n \"redirect_uri\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\",\n \"expires_in\": \"\",\n \"mode\": \"\",\n \"custom\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-5d469cc1-d4aa-473d-ad4c-b6323eba3af0" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-5c2283d8-4bd0-444d-809d-d4412dc842f5" }, { "name": "List all API credentials", "id": "6dd0c36c-02b6-4cd7-b0cc-db195c64361f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/api_credentials", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials" ] }, "description": "List all API credentials" }, "response": [ { "id": "12711f23-2132-409f-93d9-c85cb5250637", "name": "A list of API credential objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api_credentials", "host": [ "{{baseUrl}}" ], "path": [ "api_credentials" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"api_credentials\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"\",\n \"confidential\": \"\",\n \"redirect_uri\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\",\n \"expires_in\": \"\",\n \"mode\": \"\",\n \"custom\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"api_credentials\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"\",\n \"confidential\": \"\",\n \"redirect_uri\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\",\n \"expires_in\": \"\",\n \"mode\": \"\",\n \"custom\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-12711f23-2132-409f-93d9-c85cb5250637" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-6dd0c36c-02b6-4cd7-b0cc-db195c64361f" } ], "id": "24d59e53-ceeb-4678-a8c3-5d37916c6435", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-24d59e53-ceeb-4678-a8c3-5d37916c6435" }, { "name": "application_memberships", "item": [ { "name": "{applicationMembershipId}", "item": [ { "name": "api_credential", "item": [ { "name": "Related application membership", "id": "e1524b8d-5af0-4c2f-85e4-87d8e9a430ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId/api_credential", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId", "api_credential" ], "variable": [ { "id": "8b0a25c8-ca41-470c-b65a-6ec4ae2efb08", "key": "applicationMembershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related application membership" }, "response": [ { "id": "f1df6649-410a-4b19-93e3-f6054372d045", "name": "The api_credential associated to the application membership", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId/api_credential", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId", "api_credential" ], "variable": [ { "key": "applicationMembershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-f1df6649-410a-4b19-93e3-f6054372d045" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-e1524b8d-5af0-4c2f-85e4-87d8e9a430ce" } ], "id": "965a8213-1739-4749-912e-b9b51192967a", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-965a8213-1739-4749-912e-b9b51192967a" }, { "name": "membership", "item": [ { "name": "Related application membership", "id": "e8950ee2-18b6-4eeb-a41f-50ce3385bb6e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId/membership", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId", "membership" ], "variable": [ { "id": "34759c9b-b548-488d-84c2-a8fdb2de8de7", "key": "applicationMembershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related application membership" }, "response": [ { "id": "498b2dd1-12bd-41a2-bf9d-2304a6f39032", "name": "The membership associated to the application membership", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId/membership", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId", "membership" ], "variable": [ { "key": "applicationMembershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-498b2dd1-12bd-41a2-bf9d-2304a6f39032" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-e8950ee2-18b6-4eeb-a41f-50ce3385bb6e" } ], "id": "1a56f608-bba2-4da8-9079-0d7fcbe57852", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-1a56f608-bba2-4da8-9079-0d7fcbe57852" }, { "name": "membership_profile", "item": [ { "name": "Related application membership", "id": "f998b83e-c92a-408e-a2d8-6d9c6bdd92b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId/membership_profile", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId", "membership_profile" ], "variable": [ { "id": "622567af-a219-486d-8356-ed74a0ab25ad", "key": "applicationMembershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related application membership" }, "response": [ { "id": "d7a5244c-4def-4e3f-8e80-c4f50d018f6b", "name": "The membership_profile associated to the application membership", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId/membership_profile", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId", "membership_profile" ], "variable": [ { "key": "applicationMembershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-d7a5244c-4def-4e3f-8e80-c4f50d018f6b" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-f998b83e-c92a-408e-a2d8-6d9c6bdd92b8" } ], "id": "4dc782ed-b87e-48b4-9e13-2e34b4b51d01", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-4dc782ed-b87e-48b4-9e13-2e34b4b51d01" }, { "name": "organization", "item": [ { "name": "Related application membership", "id": "3ba93528-bbde-48b1-9ba2-3afa48420b3b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId/organization", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId", "organization" ], "variable": [ { "id": "0fa55eb4-bd3f-4c36-8c6a-2d98fc995218", "key": "applicationMembershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related application membership" }, "response": [ { "id": "25b507e7-7f2a-47f8-9d53-4921b63db2dc", "name": "The organization associated to the application membership", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId/organization", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId", "organization" ], "variable": [ { "key": "applicationMembershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-25b507e7-7f2a-47f8-9d53-4921b63db2dc" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-3ba93528-bbde-48b1-9ba2-3afa48420b3b" } ], "id": "fec0975c-3af3-49d3-ab29-c0211e7624a9", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-fec0975c-3af3-49d3-ab29-c0211e7624a9" }, { "name": "role", "item": [ { "name": "Related application membership", "id": "8a3d73a3-4878-4b6a-9fa7-9b041d4a714d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId/role", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId", "role" ], "variable": [ { "id": "e9f5a0b3-f6d5-4088-bd0e-9726ac4e5194", "key": "applicationMembershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related application membership" }, "response": [ { "id": "d73e278b-40ad-442d-a444-75086defa651", "name": "The role associated to the application membership", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId/role", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId", "role" ], "variable": [ { "key": "applicationMembershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-d73e278b-40ad-442d-a444-75086defa651" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-8a3d73a3-4878-4b6a-9fa7-9b041d4a714d" } ], "id": "76e9e5a3-ee0c-4b2c-8a83-4968ad98dc7f", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-76e9e5a3-ee0c-4b2c-8a83-4968ad98dc7f" }, { "name": "Retrieve an application membership", "id": "de198703-ffed-4b6c-bd9c-838e3ad07ecc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId" ], "variable": [ { "id": "801ed711-6b65-4b51-a7ec-a7a2e8b3be6a", "key": "applicationMembershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Retrieve an application membership" }, "response": [ { "id": "d3842b06-863a-4a7d-93c2-ff4acd2aa41e", "name": "The application membership object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId" ], "variable": [ { "key": "applicationMembershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"application_memberships\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"filters\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"api_credential\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credential\",\n \"id\": \"\"\n }\n },\n \"membership\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership_profile\",\n \"id\": \"\"\n }\n },\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-d3842b06-863a-4a7d-93c2-ff4acd2aa41e" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-de198703-ffed-4b6c-bd9c-838e3ad07ecc" }, { "name": "Updates an application membership", "id": "a4bae8e0-cb7d-4fdd-92b3-fe07a9db0460", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\",\n \"attributes\": {\n \"filters\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"membership_profile\": {\n \"data\": {\n \"type\": \"membership_profiles\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId" ], "variable": [ { "id": "53b16b08-4cf8-4f56-9ee8-a1423083abb5", "key": "applicationMembershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Updates an application membership" }, "response": [ { "id": "e1d093da-cf9f-4135-b269-d2cc69375815", "name": "The updated application membership object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\",\n \"attributes\": {\n \"filters\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"membership_profile\": {\n \"data\": {\n \"type\": \"membership_profiles\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId" ], "variable": [ { "key": "applicationMembershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"application_memberships\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"filters\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"api_credential\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credential\",\n \"id\": \"\"\n }\n },\n \"membership\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership_profile\",\n \"id\": \"\"\n }\n },\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-e1d093da-cf9f-4135-b269-d2cc69375815" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-a4bae8e0-cb7d-4fdd-92b3-fe07a9db0460" }, { "name": "Delete an application membership", "id": "86205f18-2ae5-46e2-98c2-315e10d6f862", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId" ], "variable": [ { "id": "3f9fd2ab-02b9-4231-aea9-61cd30a3bb13", "key": "applicationMembershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Delete an application membership" }, "response": [ { "id": "5a696fc5-011a-4488-8f43-1b63140205dc", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/application_memberships/:applicationMembershipId", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships", ":applicationMembershipId" ], "variable": [ { "key": "applicationMembershipId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-5a696fc5-011a-4488-8f43-1b63140205dc" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-86205f18-2ae5-46e2-98c2-315e10d6f862" } ], "id": "211782ac-6e09-486a-a1bd-04257e436261", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-211782ac-6e09-486a-a1bd-04257e436261" }, { "name": "Creates an application membership", "id": "033c2a48-a8fc-42b4-b6b2-67525b9a211d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"application_memberships\",\n \"attributes\": {\n \"filters\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"api_credential\": {\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\"\n }\n },\n \"organization\": {\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n },\n \"membership\": {\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"data\": {\n \"type\": \"membership_profiles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/application_memberships", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships" ] }, "description": "Creates an application membership" }, "response": [ { "id": "bf691f37-edea-45cd-8af7-26172bac14d3", "name": "The created application membership object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"application_memberships\",\n \"attributes\": {\n \"filters\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"api_credential\": {\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\"\n }\n },\n \"organization\": {\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n },\n \"membership\": {\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"data\": {\n \"type\": \"membership_profiles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/application_memberships", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"application_memberships\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"filters\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"api_credential\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credential\",\n \"id\": \"\"\n }\n },\n \"membership\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership_profile\",\n \"id\": \"\"\n }\n },\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-bf691f37-edea-45cd-8af7-26172bac14d3" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-033c2a48-a8fc-42b4-b6b2-67525b9a211d" }, { "name": "List all application memberships", "id": "b2e5cae4-b4c9-4de7-a3fa-a0f19d8c4dd0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/application_memberships", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships" ] }, "description": "List all application memberships" }, "response": [ { "id": "8b98e538-6936-401e-9f0e-5e7951bd1b65", "name": "A list of application membership objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/application_memberships", "host": [ "{{baseUrl}}" ], "path": [ "application_memberships" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"application_memberships\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"filters\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"api_credential\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credential\",\n \"id\": \"\"\n }\n },\n \"membership\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership_profile\",\n \"id\": \"\"\n }\n },\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"application_memberships\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"filters\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"api_credential\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credential\",\n \"id\": \"\"\n }\n },\n \"membership\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership_profile\",\n \"id\": \"\"\n }\n },\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-8b98e538-6936-401e-9f0e-5e7951bd1b65" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-b2e5cae4-b4c9-4de7-a3fa-a0f19d8c4dd0" } ], "id": "6167f1e3-cd24-4c55-9fc3-9bbfdb8675c6", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-6167f1e3-cd24-4c55-9fc3-9bbfdb8675c6" }, { "name": "identity_providers", "item": [ { "name": "{identityProviderId}", "item": [ { "name": "user", "item": [ { "name": "Related identity provider", "id": "ca6ff067-d883-42c0-89ad-0865c2175f91", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/identity_providers/:identityProviderId/user", "host": [ "{{baseUrl}}" ], "path": [ "identity_providers", ":identityProviderId", "user" ], "variable": [ { "id": "ab3f10d9-a56d-4dbd-96f3-291dc3f5bc59", "key": "identityProviderId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related identity provider" }, "response": [ { "id": "5c1bc39b-4685-4b5f-b5a7-7da32aae4a80", "name": "The user associated to the identity provider", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/identity_providers/:identityProviderId/user", "host": [ "{{baseUrl}}" ], "path": [ "identity_providers", ":identityProviderId", "user" ], "variable": [ { "key": "identityProviderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-5c1bc39b-4685-4b5f-b5a7-7da32aae4a80" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-ca6ff067-d883-42c0-89ad-0865c2175f91" } ], "id": "56e503cf-fb32-42ee-8769-82e4fe0baf51", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-56e503cf-fb32-42ee-8769-82e4fe0baf51" }, { "name": "Retrieve an identity provider", "id": "c4e5f1ee-02b8-4602-b0ae-c973671e7677", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/identity_providers/:identityProviderId", "host": [ "{{baseUrl}}" ], "path": [ "identity_providers", ":identityProviderId" ], "variable": [ { "id": "c1fefb71-3824-4ed6-bb04-97b1dac5d9ca", "key": "identityProviderId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Retrieve an identity provider" }, "response": [ { "id": "5bad859d-e52e-425e-bdfc-9860313211bb", "name": "The identity provider object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/identity_providers/:identityProviderId", "host": [ "{{baseUrl}}" ], "path": [ "identity_providers", ":identityProviderId" ], "variable": [ { "key": "identityProviderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"identity_providers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"issuer\": \"\",\n \"status\": \"error\",\n \"domains\": \"\",\n \"token_url\": \"\",\n \"authorize_url\": \"\",\n \"jwks_url\": \"\",\n \"txt_record\": \"\",\n \"organization\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"disabled_at\": \"\"\n },\n \"relationships\": {\n \"user\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-5bad859d-e52e-425e-bdfc-9860313211bb" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-c4e5f1ee-02b8-4602-b0ae-c973671e7677" }, { "name": "Updates an identity provider", "id": "da053a52-12b2-40c4-91a9-cb37c9d40cb4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"identity_providers\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"issuer\": \"\",\n \"domains\": \"\",\n \"token_url\": \"\",\n \"authorize_url\": \"\",\n \"jwks_url\": \"\",\n \"organization\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_disable\": \"\",\n \"_enable\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/identity_providers/:identityProviderId", "host": [ "{{baseUrl}}" ], "path": [ "identity_providers", ":identityProviderId" ], "variable": [ { "id": "50aafa61-0088-4e0f-82a8-e557dbd87aa4", "key": "identityProviderId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Updates an identity provider" }, "response": [ { "id": "1ae62553-ce71-4793-8a3e-9301bb755b28", "name": "The updated identity provider object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"identity_providers\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"issuer\": \"\",\n \"domains\": \"\",\n \"token_url\": \"\",\n \"authorize_url\": \"\",\n \"jwks_url\": \"\",\n \"organization\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_disable\": \"\",\n \"_enable\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/identity_providers/:identityProviderId", "host": [ "{{baseUrl}}" ], "path": [ "identity_providers", ":identityProviderId" ], "variable": [ { "key": "identityProviderId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"identity_providers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"issuer\": \"\",\n \"status\": \"error\",\n \"domains\": \"\",\n \"token_url\": \"\",\n \"authorize_url\": \"\",\n \"jwks_url\": \"\",\n \"txt_record\": \"\",\n \"organization\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"disabled_at\": \"\"\n },\n \"relationships\": {\n \"user\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-1ae62553-ce71-4793-8a3e-9301bb755b28" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-da053a52-12b2-40c4-91a9-cb37c9d40cb4" }, { "name": "Delete an identity provider", "id": "89068945-d225-4b8f-ae6a-14397bfbe2cb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/identity_providers/:identityProviderId", "host": [ "{{baseUrl}}" ], "path": [ "identity_providers", ":identityProviderId" ], "variable": [ { "id": "541729d3-cd3f-4bd0-b207-6d8e889f62db", "key": "identityProviderId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Delete an identity provider" }, "response": [ { "id": "7c33e988-eb96-47f1-8039-515c81b40b02", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/identity_providers/:identityProviderId", "host": [ "{{baseUrl}}" ], "path": [ "identity_providers", ":identityProviderId" ], "variable": [ { "key": "identityProviderId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-7c33e988-eb96-47f1-8039-515c81b40b02" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-89068945-d225-4b8f-ae6a-14397bfbe2cb" } ], "id": "dd8cc8dd-1e00-4797-bcc5-90975d68c995", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-dd8cc8dd-1e00-4797-bcc5-90975d68c995" }, { "name": "Creates an identity provider", "id": "a6d01b93-9f49-497c-8dcb-a8468c3b5c29", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"identity_providers\",\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"issuer\": \"\",\n \"domains\": \"\",\n \"token_url\": \"\",\n \"authorize_url\": \"\",\n \"jwks_url\": \"\",\n \"organization\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_disable\": \"\",\n \"_enable\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/identity_providers", "host": [ "{{baseUrl}}" ], "path": [ "identity_providers" ] }, "description": "Creates an identity provider" }, "response": [ { "id": "e7875311-5dc0-4347-9a52-7043bf04c446", "name": "The created identity provider object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"identity_providers\",\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"issuer\": \"\",\n \"domains\": \"\",\n \"token_url\": \"\",\n \"authorize_url\": \"\",\n \"jwks_url\": \"\",\n \"organization\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"_disable\": \"\",\n \"_enable\": \"\"\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/identity_providers", "host": [ "{{baseUrl}}" ], "path": [ "identity_providers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"identity_providers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"issuer\": \"\",\n \"status\": \"error\",\n \"domains\": \"\",\n \"token_url\": \"\",\n \"authorize_url\": \"\",\n \"jwks_url\": \"\",\n \"txt_record\": \"\",\n \"organization\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"disabled_at\": \"\"\n },\n \"relationships\": {\n \"user\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-e7875311-5dc0-4347-9a52-7043bf04c446" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-a6d01b93-9f49-497c-8dcb-a8468c3b5c29" }, { "name": "List all identity providers", "id": "f03c7144-44c1-45d7-9fe9-7f350e6f074b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/identity_providers", "host": [ "{{baseUrl}}" ], "path": [ "identity_providers" ] }, "description": "List all identity providers" }, "response": [ { "id": "c7b015d1-5c89-4ba0-b8cb-2313fd92f7ac", "name": "A list of identity provider objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/identity_providers", "host": [ "{{baseUrl}}" ], "path": [ "identity_providers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"identity_providers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"issuer\": \"\",\n \"status\": \"error\",\n \"domains\": \"\",\n \"token_url\": \"\",\n \"authorize_url\": \"\",\n \"jwks_url\": \"\",\n \"txt_record\": \"\",\n \"organization\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"disabled_at\": \"\"\n },\n \"relationships\": {\n \"user\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"identity_providers\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"issuer\": \"\",\n \"status\": \"verified\",\n \"domains\": \"\",\n \"token_url\": \"\",\n \"authorize_url\": \"\",\n \"jwks_url\": \"\",\n \"txt_record\": \"\",\n \"organization\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {},\n \"disabled_at\": \"\"\n },\n \"relationships\": {\n \"user\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"user\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-c7b015d1-5c89-4ba0-b8cb-2313fd92f7ac" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-f03c7144-44c1-45d7-9fe9-7f350e6f074b" } ], "id": "408f4ba9-b2ee-4bcc-9b12-dd5ae2bf3aa7", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-408f4ba9-b2ee-4bcc-9b12-dd5ae2bf3aa7" }, { "name": "memberships", "item": [ { "name": "{membershipId}", "item": [ { "name": "resend", "item": [ { "name": "Resend invitation", "id": "5e6ef343-a605-4086-a050-4bb61c0c73fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/memberships/:membershipId/resend", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId", "resend" ], "variable": [ { "id": "5ffeb1da-3fb8-421f-bcb5-5be8d19a1514", "key": "membershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Resend invitation for the given membership" }, "response": [ { "id": "06e334bf-fcd0-428f-b08f-2101012c7e50", "name": "Confirmation that the invitation has been sent", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/memberships/:membershipId/resend", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId", "resend" ], "variable": [ { "key": "membershipId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-06e334bf-fcd0-428f-b08f-2101012c7e50" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-5e6ef343-a605-4086-a050-4bb61c0c73fe" } ], "id": "5e8b9421-f286-438b-a6e5-7322865fd6eb", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-5e8b9421-f286-438b-a6e5-7322865fd6eb" }, { "name": "organization", "item": [ { "name": "Related membership", "id": "cfa2a156-fb72-4cdd-a927-5793cdc97a3c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/memberships/:membershipId/organization", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId", "organization" ], "variable": [ { "id": "83154fe9-76f3-4612-8d83-9f9605b65a7d", "key": "membershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related membership" }, "response": [ { "id": "9ea2596a-25cd-4f2b-b60f-4fbf1103bf53", "name": "The organization associated to the membership", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/memberships/:membershipId/organization", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId", "organization" ], "variable": [ { "key": "membershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-9ea2596a-25cd-4f2b-b60f-4fbf1103bf53" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-cfa2a156-fb72-4cdd-a927-5793cdc97a3c" } ], "id": "2ccbe914-9edf-45f7-a9f1-c538c95508c9", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-2ccbe914-9edf-45f7-a9f1-c538c95508c9" }, { "name": "role", "item": [ { "name": "Related membership", "id": "7f980a68-21b0-4c2a-8284-ceb896faf1c7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/memberships/:membershipId/role", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId", "role" ], "variable": [ { "id": "9d8a3606-28a7-4a1d-b5c5-c55d18e783ee", "key": "membershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related membership" }, "response": [ { "id": "e7fa8b3d-ea69-4c9c-969a-bde6defe1409", "name": "The role associated to the membership", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/memberships/:membershipId/role", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId", "role" ], "variable": [ { "key": "membershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-e7fa8b3d-ea69-4c9c-969a-bde6defe1409" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-7f980a68-21b0-4c2a-8284-ceb896faf1c7" } ], "id": "a23814e8-432b-4c73-8359-45a720374b7c", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-a23814e8-432b-4c73-8359-45a720374b7c" }, { "name": "application_memberships", "item": [ { "name": "Related membership", "id": "48b553e0-8e60-48cf-b0e1-68c3f0d159f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/memberships/:membershipId/application_memberships", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId", "application_memberships" ], "variable": [ { "id": "1ec5cd48-3337-417a-a82f-d83df6a8bc7e", "key": "membershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related membership" }, "response": [ { "id": "090fbe38-0a0f-486a-9291-f7991e09cefd", "name": "The application_memberships associated to the membership", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/memberships/:membershipId/application_memberships", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId", "application_memberships" ], "variable": [ { "key": "membershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-090fbe38-0a0f-486a-9291-f7991e09cefd" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-48b553e0-8e60-48cf-b0e1-68c3f0d159f5" } ], "id": "7c0aebfd-6ec7-4640-b5bc-d44378f46ed9", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-7c0aebfd-6ec7-4640-b5bc-d44378f46ed9" }, { "name": "membership_profile", "item": [ { "name": "Related membership", "id": "69a1df5f-384d-494e-8b2d-80f7c2c96818", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/memberships/:membershipId/membership_profile", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId", "membership_profile" ], "variable": [ { "id": "84d9fb6f-8bcc-4204-9f2c-5e7fb21a5ecc", "key": "membershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related membership" }, "response": [ { "id": "d617acf6-bd1c-4fe3-8cfc-a4e59eceac0d", "name": "The membership_profile associated to the membership", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/memberships/:membershipId/membership_profile", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId", "membership_profile" ], "variable": [ { "key": "membershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-d617acf6-bd1c-4fe3-8cfc-a4e59eceac0d" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-69a1df5f-384d-494e-8b2d-80f7c2c96818" } ], "id": "a0502495-208e-4bcc-bc5f-00535c07c5a6", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-a0502495-208e-4bcc-bc5f-00535c07c5a6" }, { "name": "versions", "item": [ { "name": "Related membership", "id": "62e58a1e-02d4-4253-beeb-fe15d68dcd9b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/memberships/:membershipId/versions", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId", "versions" ], "variable": [ { "id": "30dc6239-bbd7-4c3d-ac8d-a5d2461b3ed1", "key": "membershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related membership" }, "response": [ { "id": "490dd06d-fcda-4924-a2d3-c58b58297e77", "name": "The versions associated to the membership", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/memberships/:membershipId/versions", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId", "versions" ], "variable": [ { "key": "membershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-490dd06d-fcda-4924-a2d3-c58b58297e77" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-62e58a1e-02d4-4253-beeb-fe15d68dcd9b" } ], "id": "26943903-f23e-4661-b419-35074dec305a", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-26943903-f23e-4661-b419-35074dec305a" }, { "name": "Retrieve an membership", "id": "ffe4e64a-42b4-4865-9118-106efc98caeb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/memberships/:membershipId", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId" ], "variable": [ { "id": "fa43f895-4830-4d0a-9c6e-0e10cde7f3de", "key": "membershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Retrieve an membership" }, "response": [ { "id": "fd0aa8ee-c905-4306-97d6-7407eefe9f7b", "name": "The membership object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/memberships/:membershipId", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId" ], "variable": [ { "key": "membershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"memberships\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"user_email\": \"\",\n \"user_first_name\": \"\",\n \"user_last_name\": \"\",\n \"status\": \"active\",\n \"owner\": \"\",\n \"test_enabled\": \"\",\n \"access_scope\": \"all_access\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership_profile\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-fd0aa8ee-c905-4306-97d6-7407eefe9f7b" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-ffe4e64a-42b4-4865-9118-106efc98caeb" }, { "name": "Updates an membership", "id": "b89dc46b-8f3d-469f-97ee-98c5d2c2c0dc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\",\n \"attributes\": {\n \"access_scope\": \"test_access\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"data\": {\n \"type\": \"membership_profiles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/memberships/:membershipId", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId" ], "variable": [ { "id": "ec720066-8995-4139-8a00-5a273c8d4858", "key": "membershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Updates an membership" }, "response": [ { "id": "e52afebc-09c5-418d-bf37-d25d73501053", "name": "The updated membership object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\",\n \"attributes\": {\n \"access_scope\": \"test_access\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"data\": {\n \"type\": \"membership_profiles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/memberships/:membershipId", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId" ], "variable": [ { "key": "membershipId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"memberships\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"user_email\": \"\",\n \"user_first_name\": \"\",\n \"user_last_name\": \"\",\n \"status\": \"active\",\n \"owner\": \"\",\n \"test_enabled\": \"\",\n \"access_scope\": \"all_access\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership_profile\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-e52afebc-09c5-418d-bf37-d25d73501053" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-b89dc46b-8f3d-469f-97ee-98c5d2c2c0dc" }, { "name": "Delete an membership", "id": "c63d76da-9792-4d74-b49d-ccf4dfb4df36", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/memberships/:membershipId", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId" ], "variable": [ { "id": "b9771b62-343f-4c9a-8e67-a8aa4c3cd7c5", "key": "membershipId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Delete an membership" }, "response": [ { "id": "2db59dad-cc45-4784-9fe0-63002d2f8588", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/memberships/:membershipId", "host": [ "{{baseUrl}}" ], "path": [ "memberships", ":membershipId" ], "variable": [ { "key": "membershipId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-2db59dad-cc45-4784-9fe0-63002d2f8588" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-c63d76da-9792-4d74-b49d-ccf4dfb4df36" } ], "id": "272f992c-46a4-4548-a65c-ee888015b65e", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-272f992c-46a4-4548-a65c-ee888015b65e" }, { "name": "Creates an membership", "id": "f627ac75-218f-43ce-94f0-c475a9415e1a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"memberships\",\n \"attributes\": {\n \"user_email\": \"\",\n \"access_scope\": \"live_access\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"data\": {\n \"type\": \"membership_profiles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/memberships", "host": [ "{{baseUrl}}" ], "path": [ "memberships" ] }, "description": "Creates an membership" }, "response": [ { "id": "fba8d7a3-1071-48d0-b291-4544dff5e5c6", "name": "The created membership object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"memberships\",\n \"attributes\": {\n \"user_email\": \"\",\n \"access_scope\": \"live_access\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"data\": {\n \"type\": \"membership_profiles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/memberships", "host": [ "{{baseUrl}}" ], "path": [ "memberships" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"memberships\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"user_email\": \"\",\n \"user_first_name\": \"\",\n \"user_last_name\": \"\",\n \"status\": \"active\",\n \"owner\": \"\",\n \"test_enabled\": \"\",\n \"access_scope\": \"all_access\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership_profile\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-fba8d7a3-1071-48d0-b291-4544dff5e5c6" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-f627ac75-218f-43ce-94f0-c475a9415e1a" }, { "name": "List all memberships", "id": "91326549-4b11-41df-87a7-0dd7ca52f422", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/memberships", "host": [ "{{baseUrl}}" ], "path": [ "memberships" ] }, "description": "List all memberships" }, "response": [ { "id": "fca9ab99-191f-44be-bb1b-2f6e106b23db", "name": "A list of membership objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/memberships", "host": [ "{{baseUrl}}" ], "path": [ "memberships" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"memberships\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"user_email\": \"\",\n \"user_first_name\": \"\",\n \"user_last_name\": \"\",\n \"status\": \"pending\",\n \"owner\": \"\",\n \"test_enabled\": \"\",\n \"access_scope\": \"test_access\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership_profile\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"memberships\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"user_email\": \"\",\n \"user_first_name\": \"\",\n \"user_last_name\": \"\",\n \"status\": \"pending\",\n \"owner\": \"\",\n \"test_enabled\": \"\",\n \"access_scope\": \"all_access\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n },\n \"membership_profile\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"membership_profile\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-fca9ab99-191f-44be-bb1b-2f6e106b23db" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-91326549-4b11-41df-87a7-0dd7ca52f422" } ], "id": "933d57c4-8e1f-4f31-97ad-be8bd100ed76", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-933d57c4-8e1f-4f31-97ad-be8bd100ed76" }, { "name": "membership_profiles", "item": [ { "name": "{membershipProfileId}", "item": [ { "name": "organization", "item": [ { "name": "Related membership profile", "id": "a142f111-5761-408f-a62f-e8c6e82e3cc9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/membership_profiles/:membershipProfileId/organization", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles", ":membershipProfileId", "organization" ], "variable": [ { "id": "f6a73ef3-ef73-411b-aaf5-3a3becbb4536", "key": "membershipProfileId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related membership profile" }, "response": [ { "id": "64ff6df3-67fc-4434-8368-f292f57921a9", "name": "The organization associated to the membership profile", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/membership_profiles/:membershipProfileId/organization", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles", ":membershipProfileId", "organization" ], "variable": [ { "key": "membershipProfileId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-64ff6df3-67fc-4434-8368-f292f57921a9" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-a142f111-5761-408f-a62f-e8c6e82e3cc9" } ], "id": "7fdf95a9-efb7-434f-91ba-508eb786dffa", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-7fdf95a9-efb7-434f-91ba-508eb786dffa" }, { "name": "application_memberships", "item": [ { "name": "Related membership profile", "id": "c6668cd3-94ef-44e9-a0d3-983cb5cfea93", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/membership_profiles/:membershipProfileId/application_memberships", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles", ":membershipProfileId", "application_memberships" ], "variable": [ { "id": "aa075e27-5ee4-43e9-a095-15a6ae4ae333", "key": "membershipProfileId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related membership profile" }, "response": [ { "id": "6f326286-e19a-4504-8ebe-914a4023bff5", "name": "The application_memberships associated to the membership profile", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/membership_profiles/:membershipProfileId/application_memberships", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles", ":membershipProfileId", "application_memberships" ], "variable": [ { "key": "membershipProfileId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-6f326286-e19a-4504-8ebe-914a4023bff5" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-c6668cd3-94ef-44e9-a0d3-983cb5cfea93" } ], "id": "e1600415-2178-49bf-b22a-e6ce8a383b71", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-e1600415-2178-49bf-b22a-e6ce8a383b71" }, { "name": "Retrieve an membership profile", "id": "ec64f909-1ec6-4e80-996a-943461c4253d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/membership_profiles/:membershipProfileId", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles", ":membershipProfileId" ], "variable": [ { "id": "46f8650f-c6af-40a8-b0c7-e05d2660091e", "key": "membershipProfileId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Retrieve an membership profile" }, "response": [ { "id": "2950e641-53d6-416e-8132-dd7f6636a0ac", "name": "The membership profile object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/membership_profiles/:membershipProfileId", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles", ":membershipProfileId" ], "variable": [ { "key": "membershipProfileId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"membership_profiles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"test_enabled\": \"\",\n \"access_scope\": \"test_access\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-2950e641-53d6-416e-8132-dd7f6636a0ac" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-ec64f909-1ec6-4e80-996a-943461c4253d" }, { "name": "Updates an membership profile", "id": "a8da1b10-5d87-49a5-a03a-143781a16781", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"membership_profiles\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"access_scope\": \"test_access\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"application_memberships\": {\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/membership_profiles/:membershipProfileId", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles", ":membershipProfileId" ], "variable": [ { "id": "5834bd8e-69a9-4baf-92c9-9aac597be073", "key": "membershipProfileId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Updates an membership profile" }, "response": [ { "id": "2206bf95-974b-40dd-952a-8227eca76dde", "name": "The updated membership profile object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"membership_profiles\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"access_scope\": \"test_access\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"application_memberships\": {\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/membership_profiles/:membershipProfileId", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles", ":membershipProfileId" ], "variable": [ { "key": "membershipProfileId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"membership_profiles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"test_enabled\": \"\",\n \"access_scope\": \"test_access\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-2206bf95-974b-40dd-952a-8227eca76dde" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-a8da1b10-5d87-49a5-a03a-143781a16781" }, { "name": "Delete an membership profile", "id": "1ee78f6a-091a-4fcb-9959-8e0f7ff78440", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/membership_profiles/:membershipProfileId", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles", ":membershipProfileId" ], "variable": [ { "id": "95f1aeed-d850-4265-809a-a4ecebd92a47", "key": "membershipProfileId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Delete an membership profile" }, "response": [ { "id": "bd4c19e6-d9ef-4323-b2df-b2b03392ffe1", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/membership_profiles/:membershipProfileId", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles", ":membershipProfileId" ], "variable": [ { "key": "membershipProfileId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-bd4c19e6-d9ef-4323-b2df-b2b03392ffe1" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-1ee78f6a-091a-4fcb-9959-8e0f7ff78440" } ], "id": "b90cc643-00fb-42f9-bbe0-dd79d8f6c809", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-b90cc643-00fb-42f9-bbe0-dd79d8f6c809" }, { "name": "Creates an membership profile", "id": "2dc716ed-d5fa-4129-ad1c-c813dac2186c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"membership_profiles\",\n \"attributes\": {\n \"name\": \"\",\n \"access_scope\": \"test_access\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/membership_profiles", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles" ] }, "description": "Creates an membership profile" }, "response": [ { "id": "d6c07cf5-e250-4d5c-85b5-e089bdc416a6", "name": "The created membership profile object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"membership_profiles\",\n \"attributes\": {\n \"name\": \"\",\n \"access_scope\": \"test_access\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/membership_profiles", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"membership_profiles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"test_enabled\": \"\",\n \"access_scope\": \"test_access\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-d6c07cf5-e250-4d5c-85b5-e089bdc416a6" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-2dc716ed-d5fa-4129-ad1c-c813dac2186c" }, { "name": "List all membership profiles", "id": "52d3bf00-15c1-42ce-81b2-776f66362c41", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/membership_profiles", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles" ] }, "description": "List all membership profiles" }, "response": [ { "id": "ccecda7b-0e81-4aaa-88e5-5948cb9d2aa4", "name": "A list of membership profile objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/membership_profiles", "host": [ "{{baseUrl}}" ], "path": [ "membership_profiles" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"membership_profiles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"test_enabled\": \"\",\n \"access_scope\": \"all_access\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"membership_profiles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"test_enabled\": \"\",\n \"access_scope\": \"all_access\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"application_memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"application_memberships\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-ccecda7b-0e81-4aaa-88e5-5948cb9d2aa4" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-52d3bf00-15c1-42ce-81b2-776f66362c41" } ], "id": "638ece0c-a30c-4e69-a660-c1fbfc1c2e84", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-638ece0c-a30c-4e69-a660-c1fbfc1c2e84" }, { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "transfer_ownership", "item": [ { "name": "Transfer ownership of an organization", "id": "847a19d9-753a-451a-9e4e-ed523bd1f0a3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\",\n \"attributes\": {\n \"new_owner_email\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations/:organizationId/transfer_ownership", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "transfer_ownership" ], "variable": [ { "id": "7c021bb4-9818-4bf8-95d8-1f27e633e4da", "key": "organizationId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Transfers the ownership of an organization to a new owner" }, "response": [ { "id": "608223ca-a9fc-47b3-9a5d-59cbb8f2a4f6", "name": "The confirmation of the transfer ownership", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\",\n \"attributes\": {\n \"new_owner_email\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations/:organizationId/transfer_ownership", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "transfer_ownership" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-608223ca-a9fc-47b3-9a5d-59cbb8f2a4f6" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-847a19d9-753a-451a-9e4e-ed523bd1f0a3" } ], "id": "e2ba08bb-f30b-4476-8b1c-f6aebb853ac1", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-e2ba08bb-f30b-4476-8b1c-f6aebb853ac1" }, { "name": "memberships", "item": [ { "name": "Related organization", "id": "c7abfaed-679a-4123-8598-82411c91e0ea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/memberships", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "memberships" ], "variable": [ { "id": "6f94e129-8dc7-49c7-8c61-c316a3087acd", "key": "organizationId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related organization" }, "response": [ { "id": "a83ee883-2fd4-4bc2-8584-6b325dc56c85", "name": "The memberships associated to the organization", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/memberships", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "memberships" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-a83ee883-2fd4-4bc2-8584-6b325dc56c85" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-c7abfaed-679a-4123-8598-82411c91e0ea" } ], "id": "414fd644-4fb6-4953-9fb8-34e24261c100", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-414fd644-4fb6-4953-9fb8-34e24261c100" }, { "name": "roles", "item": [ { "name": "Related organization", "id": "708c37fe-8865-44cb-b749-a454dc330ca9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/roles", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "roles" ], "variable": [ { "id": "b76f4b39-81b2-4ad1-84cc-743293552cef", "key": "organizationId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related organization" }, "response": [ { "id": "eda64b1f-ad21-48ae-9e61-e8cdae7d4b46", "name": "The roles associated to the organization", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/roles", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "roles" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-eda64b1f-ad21-48ae-9e61-e8cdae7d4b46" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-708c37fe-8865-44cb-b749-a454dc330ca9" } ], "id": "afb36c37-6817-4f00-90af-8276a97ba737", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-afb36c37-6817-4f00-90af-8276a97ba737" }, { "name": "permissions", "item": [ { "name": "Related organization", "id": "557b3310-d996-4d35-927a-d88043b2662b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/permissions", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "permissions" ], "variable": [ { "id": "c4bd2d9c-cad3-4058-b0a2-49a10e84ca7a", "key": "organizationId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related organization" }, "response": [ { "id": "27ab3e2a-c840-4e1a-a85e-4be532c96718", "name": "The permissions associated to the organization", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/permissions", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "permissions" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-27ab3e2a-c840-4e1a-a85e-4be532c96718" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-557b3310-d996-4d35-927a-d88043b2662b" } ], "id": "baec2a36-5dd6-4e2a-85a0-f503c8e03bb6", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-baec2a36-5dd6-4e2a-85a0-f503c8e03bb6" }, { "name": "api_credentials", "item": [ { "name": "Related organization", "id": "4c586897-a8b3-4fad-9496-f053ca327993", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/api_credentials", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "api_credentials" ], "variable": [ { "id": "2c0c4726-147c-44e3-acdf-9e0e3c8a3104", "key": "organizationId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related organization" }, "response": [ { "id": "bfb4dd7a-fc08-48ef-a952-a5f9492d1415", "name": "The api_credentials associated to the organization", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId/api_credentials", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId", "api_credentials" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-bfb4dd7a-fc08-48ef-a952-a5f9492d1415" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-4c586897-a8b3-4fad-9496-f053ca327993" } ], "id": "a21a1da3-ee38-46b5-ad96-51b9a49dd8ee", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-a21a1da3-ee38-46b5-ad96-51b9a49dd8ee" }, { "name": "Retrieve an organization", "id": "f22bf007-9b44-4fbc-b31b-6e02b46f9246", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId" ], "variable": [ { "id": "f1c97949-35a2-4d52-aca0-3b1dcdc41aef", "key": "organizationId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Retrieve an organization" }, "response": [ { "id": "f3c9940c-15df-4f92-baca-6ca9a785d0af", "name": "The organization object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"organizations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"domain\": \"\",\n \"support_phone\": \"\",\n \"support_email\": \"\",\n \"logo_url\": \"\",\n \"favicon_url\": \"\",\n \"primary_color\": \"\",\n \"contrast_color\": \"\",\n \"gtm_id\": \"\",\n \"gtm_id_test\": \"\",\n \"region\": \"\",\n \"can_switch_live\": \"\",\n \"subscription_info\": {},\n \"config\": {},\n \"api_auth_redirect\": \"\",\n \"api_rules_engine\": \"\",\n \"api_rules_engine_max_conditions_size\": \"\",\n \"api_rules_engine_max_rules_size\": \"\",\n \"api_new_auth\": \"\",\n \"api_purge_single_resource\": \"\",\n \"api_max_regex_length\": \"\",\n \"addresses_avs_check\": \"\",\n \"addresses_phone_required\": \"\",\n \"orders_sales_channel_guest_only\": \"\",\n \"orders_min_rebuild_shipments_lapse\": \"\",\n \"orders_min_refresh_lapse\": \"\",\n \"orders_autorefresh_cutoff_test\": \"\",\n \"orders_autorefresh_cutoff_live\": \"\",\n \"orders_number_editable_test\": \"\",\n \"orders_number_editable_live\": \"\",\n \"orders_number_as_reference\": \"\",\n \"orders_invalid_coupon_errors\": \"\",\n \"orders_invalid_gift_card_errors\": \"\",\n \"orders_validate_shipping_stock\": \"\",\n \"bundles_max_items_count\": \"\",\n \"coupons_min_code_length\": \"\",\n \"coupons_max_code_length\": \"\",\n \"gift_cards_exact_code_matching\": \"\",\n \"gift_cards_min_code_length\": \"\",\n \"gift_cards_max_code_length\": \"\",\n \"cleanups_max_concurrent_count\": \"\",\n \"exports_max_concurrent_count\": \"\",\n \"imports_max_concurrent_count\": \"\",\n \"imports_purge_cache\": \"\",\n \"imports_skip_errors\": \"\",\n \"inventory_models_max_stock_locations_cutoff\": \"\",\n \"promotions_max_concurrent_count\": \"\",\n \"promotions_max_conditions_size\": \"\",\n \"promotions_max_rules_size\": \"\",\n \"price_lists_max_conditions_size\": \"\",\n \"price_lists_max_rules_size\": \"\",\n \"imports_trigger_webhooks\": \"\",\n \"discount_engines_enabled\": \"\",\n \"discount_engines_errors\": \"\",\n \"tags_max_name_length\": \"\",\n \"tags_max_allowed_number\": \"\",\n \"tax_calculators_errors\": \"\",\n \"external_promotions_errors\": \"\",\n \"external_prices_errors\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\"\n }\n },\n \"roles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n },\n \"permissions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"permissions\",\n \"id\": \"\"\n }\n },\n \"api_credentials\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-f3c9940c-15df-4f92-baca-6ca9a785d0af" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-f22bf007-9b44-4fbc-b31b-6e02b46f9246" }, { "name": "Updates an organization", "id": "6ec5e3bc-feed-4c82-a502-8a6e1757c5a3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"support_phone\": \"\",\n \"support_email\": \"\",\n \"logo_url\": \"\",\n \"favicon_url\": \"\",\n \"primary_color\": \"\",\n \"contrast_color\": \"\",\n \"gtm_id\": \"\",\n \"gtm_id_test\": \"\",\n \"config\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId" ], "variable": [ { "id": "8aa601e2-5a5c-42e8-b086-bf96fb4a90cc", "key": "organizationId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Updates an organization" }, "response": [ { "id": "7b332cb8-0932-4d87-98d7-585659cc6e65", "name": "The updated organization object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"support_phone\": \"\",\n \"support_email\": \"\",\n \"logo_url\": \"\",\n \"favicon_url\": \"\",\n \"primary_color\": \"\",\n \"contrast_color\": \"\",\n \"gtm_id\": \"\",\n \"gtm_id_test\": \"\",\n \"config\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "organizations", ":organizationId" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"organizations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"domain\": \"\",\n \"support_phone\": \"\",\n \"support_email\": \"\",\n \"logo_url\": \"\",\n \"favicon_url\": \"\",\n \"primary_color\": \"\",\n \"contrast_color\": \"\",\n \"gtm_id\": \"\",\n \"gtm_id_test\": \"\",\n \"region\": \"\",\n \"can_switch_live\": \"\",\n \"subscription_info\": {},\n \"config\": {},\n \"api_auth_redirect\": \"\",\n \"api_rules_engine\": \"\",\n \"api_rules_engine_max_conditions_size\": \"\",\n \"api_rules_engine_max_rules_size\": \"\",\n \"api_new_auth\": \"\",\n \"api_purge_single_resource\": \"\",\n \"api_max_regex_length\": \"\",\n \"addresses_avs_check\": \"\",\n \"addresses_phone_required\": \"\",\n \"orders_sales_channel_guest_only\": \"\",\n \"orders_min_rebuild_shipments_lapse\": \"\",\n \"orders_min_refresh_lapse\": \"\",\n \"orders_autorefresh_cutoff_test\": \"\",\n \"orders_autorefresh_cutoff_live\": \"\",\n \"orders_number_editable_test\": \"\",\n \"orders_number_editable_live\": \"\",\n \"orders_number_as_reference\": \"\",\n \"orders_invalid_coupon_errors\": \"\",\n \"orders_invalid_gift_card_errors\": \"\",\n \"orders_validate_shipping_stock\": \"\",\n \"bundles_max_items_count\": \"\",\n \"coupons_min_code_length\": \"\",\n \"coupons_max_code_length\": \"\",\n \"gift_cards_exact_code_matching\": \"\",\n \"gift_cards_min_code_length\": \"\",\n \"gift_cards_max_code_length\": \"\",\n \"cleanups_max_concurrent_count\": \"\",\n \"exports_max_concurrent_count\": \"\",\n \"imports_max_concurrent_count\": \"\",\n \"imports_purge_cache\": \"\",\n \"imports_skip_errors\": \"\",\n \"inventory_models_max_stock_locations_cutoff\": \"\",\n \"promotions_max_concurrent_count\": \"\",\n \"promotions_max_conditions_size\": \"\",\n \"promotions_max_rules_size\": \"\",\n \"price_lists_max_conditions_size\": \"\",\n \"price_lists_max_rules_size\": \"\",\n \"imports_trigger_webhooks\": \"\",\n \"discount_engines_enabled\": \"\",\n \"discount_engines_errors\": \"\",\n \"tags_max_name_length\": \"\",\n \"tags_max_allowed_number\": \"\",\n \"tax_calculators_errors\": \"\",\n \"external_promotions_errors\": \"\",\n \"external_prices_errors\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\"\n }\n },\n \"roles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n },\n \"permissions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"permissions\",\n \"id\": \"\"\n }\n },\n \"api_credentials\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-7b332cb8-0932-4d87-98d7-585659cc6e65" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-6ec5e3bc-feed-4c82-a502-8a6e1757c5a3" } ], "id": "ee2ee519-1d76-4185-8df2-aa6e68322be2", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-ee2ee519-1d76-4185-8df2-aa6e68322be2" }, { "name": "Creates an organization", "id": "450fa33f-420e-4ce8-8f95-fb5851c2c567", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"organizations\",\n \"attributes\": {\n \"name\": \"\",\n \"support_phone\": \"\",\n \"support_email\": \"\",\n \"logo_url\": \"\",\n \"favicon_url\": \"\",\n \"primary_color\": \"\",\n \"contrast_color\": \"\",\n \"gtm_id\": \"\",\n \"gtm_id_test\": \"\",\n \"region\": \"\",\n \"config\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ] }, "description": "Creates an organization" }, "response": [ { "id": "f62f7bb0-c137-4aa6-916c-8e305f2812dd", "name": "The created organization object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"organizations\",\n \"attributes\": {\n \"name\": \"\",\n \"support_phone\": \"\",\n \"support_email\": \"\",\n \"logo_url\": \"\",\n \"favicon_url\": \"\",\n \"primary_color\": \"\",\n \"contrast_color\": \"\",\n \"gtm_id\": \"\",\n \"gtm_id_test\": \"\",\n \"region\": \"\",\n \"config\": {},\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/organizations", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"organizations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"domain\": \"\",\n \"support_phone\": \"\",\n \"support_email\": \"\",\n \"logo_url\": \"\",\n \"favicon_url\": \"\",\n \"primary_color\": \"\",\n \"contrast_color\": \"\",\n \"gtm_id\": \"\",\n \"gtm_id_test\": \"\",\n \"region\": \"\",\n \"can_switch_live\": \"\",\n \"subscription_info\": {},\n \"config\": {},\n \"api_auth_redirect\": \"\",\n \"api_rules_engine\": \"\",\n \"api_rules_engine_max_conditions_size\": \"\",\n \"api_rules_engine_max_rules_size\": \"\",\n \"api_new_auth\": \"\",\n \"api_purge_single_resource\": \"\",\n \"api_max_regex_length\": \"\",\n \"addresses_avs_check\": \"\",\n \"addresses_phone_required\": \"\",\n \"orders_sales_channel_guest_only\": \"\",\n \"orders_min_rebuild_shipments_lapse\": \"\",\n \"orders_min_refresh_lapse\": \"\",\n \"orders_autorefresh_cutoff_test\": \"\",\n \"orders_autorefresh_cutoff_live\": \"\",\n \"orders_number_editable_test\": \"\",\n \"orders_number_editable_live\": \"\",\n \"orders_number_as_reference\": \"\",\n \"orders_invalid_coupon_errors\": \"\",\n \"orders_invalid_gift_card_errors\": \"\",\n \"orders_validate_shipping_stock\": \"\",\n \"bundles_max_items_count\": \"\",\n \"coupons_min_code_length\": \"\",\n \"coupons_max_code_length\": \"\",\n \"gift_cards_exact_code_matching\": \"\",\n \"gift_cards_min_code_length\": \"\",\n \"gift_cards_max_code_length\": \"\",\n \"cleanups_max_concurrent_count\": \"\",\n \"exports_max_concurrent_count\": \"\",\n \"imports_max_concurrent_count\": \"\",\n \"imports_purge_cache\": \"\",\n \"imports_skip_errors\": \"\",\n \"inventory_models_max_stock_locations_cutoff\": \"\",\n \"promotions_max_concurrent_count\": \"\",\n \"promotions_max_conditions_size\": \"\",\n \"promotions_max_rules_size\": \"\",\n \"price_lists_max_conditions_size\": \"\",\n \"price_lists_max_rules_size\": \"\",\n \"imports_trigger_webhooks\": \"\",\n \"discount_engines_enabled\": \"\",\n \"discount_engines_errors\": \"\",\n \"tags_max_name_length\": \"\",\n \"tags_max_allowed_number\": \"\",\n \"tax_calculators_errors\": \"\",\n \"external_promotions_errors\": \"\",\n \"external_prices_errors\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\"\n }\n },\n \"roles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n },\n \"permissions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"permissions\",\n \"id\": \"\"\n }\n },\n \"api_credentials\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-f62f7bb0-c137-4aa6-916c-8e305f2812dd" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-450fa33f-420e-4ce8-8f95-fb5851c2c567" }, { "name": "List all organizations", "id": "fb5b32a7-66a0-4557-b4c1-775b258395ed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/organizations", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ] }, "description": "List all organizations" }, "response": [ { "id": "81075f32-60dd-49ab-9d25-37a19e06a9bc", "name": "A list of organization objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/organizations", "host": [ "{{baseUrl}}" ], "path": [ "organizations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"organizations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"domain\": \"\",\n \"support_phone\": \"\",\n \"support_email\": \"\",\n \"logo_url\": \"\",\n \"favicon_url\": \"\",\n \"primary_color\": \"\",\n \"contrast_color\": \"\",\n \"gtm_id\": \"\",\n \"gtm_id_test\": \"\",\n \"region\": \"\",\n \"can_switch_live\": \"\",\n \"subscription_info\": {},\n \"config\": {},\n \"api_auth_redirect\": \"\",\n \"api_rules_engine\": \"\",\n \"api_rules_engine_max_conditions_size\": \"\",\n \"api_rules_engine_max_rules_size\": \"\",\n \"api_new_auth\": \"\",\n \"api_purge_single_resource\": \"\",\n \"api_max_regex_length\": \"\",\n \"addresses_avs_check\": \"\",\n \"addresses_phone_required\": \"\",\n \"orders_sales_channel_guest_only\": \"\",\n \"orders_min_rebuild_shipments_lapse\": \"\",\n \"orders_min_refresh_lapse\": \"\",\n \"orders_autorefresh_cutoff_test\": \"\",\n \"orders_autorefresh_cutoff_live\": \"\",\n \"orders_number_editable_test\": \"\",\n \"orders_number_editable_live\": \"\",\n \"orders_number_as_reference\": \"\",\n \"orders_invalid_coupon_errors\": \"\",\n \"orders_invalid_gift_card_errors\": \"\",\n \"orders_validate_shipping_stock\": \"\",\n \"bundles_max_items_count\": \"\",\n \"coupons_min_code_length\": \"\",\n \"coupons_max_code_length\": \"\",\n \"gift_cards_exact_code_matching\": \"\",\n \"gift_cards_min_code_length\": \"\",\n \"gift_cards_max_code_length\": \"\",\n \"cleanups_max_concurrent_count\": \"\",\n \"exports_max_concurrent_count\": \"\",\n \"imports_max_concurrent_count\": \"\",\n \"imports_purge_cache\": \"\",\n \"imports_skip_errors\": \"\",\n \"inventory_models_max_stock_locations_cutoff\": \"\",\n \"promotions_max_concurrent_count\": \"\",\n \"promotions_max_conditions_size\": \"\",\n \"promotions_max_rules_size\": \"\",\n \"price_lists_max_conditions_size\": \"\",\n \"price_lists_max_rules_size\": \"\",\n \"imports_trigger_webhooks\": \"\",\n \"discount_engines_enabled\": \"\",\n \"discount_engines_errors\": \"\",\n \"tags_max_name_length\": \"\",\n \"tags_max_allowed_number\": \"\",\n \"tax_calculators_errors\": \"\",\n \"external_promotions_errors\": \"\",\n \"external_prices_errors\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\"\n }\n },\n \"roles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n },\n \"permissions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"permissions\",\n \"id\": \"\"\n }\n },\n \"api_credentials\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"organizations\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"domain\": \"\",\n \"support_phone\": \"\",\n \"support_email\": \"\",\n \"logo_url\": \"\",\n \"favicon_url\": \"\",\n \"primary_color\": \"\",\n \"contrast_color\": \"\",\n \"gtm_id\": \"\",\n \"gtm_id_test\": \"\",\n \"region\": \"\",\n \"can_switch_live\": \"\",\n \"subscription_info\": {},\n \"config\": {},\n \"api_auth_redirect\": \"\",\n \"api_rules_engine\": \"\",\n \"api_rules_engine_max_conditions_size\": \"\",\n \"api_rules_engine_max_rules_size\": \"\",\n \"api_new_auth\": \"\",\n \"api_purge_single_resource\": \"\",\n \"api_max_regex_length\": \"\",\n \"addresses_avs_check\": \"\",\n \"addresses_phone_required\": \"\",\n \"orders_sales_channel_guest_only\": \"\",\n \"orders_min_rebuild_shipments_lapse\": \"\",\n \"orders_min_refresh_lapse\": \"\",\n \"orders_autorefresh_cutoff_test\": \"\",\n \"orders_autorefresh_cutoff_live\": \"\",\n \"orders_number_editable_test\": \"\",\n \"orders_number_editable_live\": \"\",\n \"orders_number_as_reference\": \"\",\n \"orders_invalid_coupon_errors\": \"\",\n \"orders_invalid_gift_card_errors\": \"\",\n \"orders_validate_shipping_stock\": \"\",\n \"bundles_max_items_count\": \"\",\n \"coupons_min_code_length\": \"\",\n \"coupons_max_code_length\": \"\",\n \"gift_cards_exact_code_matching\": \"\",\n \"gift_cards_min_code_length\": \"\",\n \"gift_cards_max_code_length\": \"\",\n \"cleanups_max_concurrent_count\": \"\",\n \"exports_max_concurrent_count\": \"\",\n \"imports_max_concurrent_count\": \"\",\n \"imports_purge_cache\": \"\",\n \"imports_skip_errors\": \"\",\n \"inventory_models_max_stock_locations_cutoff\": \"\",\n \"promotions_max_concurrent_count\": \"\",\n \"promotions_max_conditions_size\": \"\",\n \"promotions_max_rules_size\": \"\",\n \"price_lists_max_conditions_size\": \"\",\n \"price_lists_max_rules_size\": \"\",\n \"imports_trigger_webhooks\": \"\",\n \"discount_engines_enabled\": \"\",\n \"discount_engines_errors\": \"\",\n \"tags_max_name_length\": \"\",\n \"tags_max_allowed_number\": \"\",\n \"tax_calculators_errors\": \"\",\n \"external_promotions_errors\": \"\",\n \"external_prices_errors\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\"\n }\n },\n \"roles\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n },\n \"permissions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"permissions\",\n \"id\": \"\"\n }\n },\n \"api_credentials\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-81075f32-60dd-49ab-9d25-37a19e06a9bc" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-fb5b32a7-66a0-4557-b4c1-775b258395ed" } ], "id": "6cc2bd70-1558-42e1-ab0a-101db6ef2597", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-6cc2bd70-1558-42e1-ab0a-101db6ef2597" }, { "name": "permissions", "item": [ { "name": "{permissionId}", "item": [ { "name": "organization", "item": [ { "name": "Related permission", "id": "eaf1aab2-4fcb-477d-93f9-8ea168ab34d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/permissions/:permissionId/organization", "host": [ "{{baseUrl}}" ], "path": [ "permissions", ":permissionId", "organization" ], "variable": [ { "id": "315b0008-93c3-4ca2-b3fa-c9cdc1d9d8ea", "key": "permissionId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related permission" }, "response": [ { "id": "38bd7639-93c4-4302-a954-ea72c645314a", "name": "The organization associated to the permission", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/permissions/:permissionId/organization", "host": [ "{{baseUrl}}" ], "path": [ "permissions", ":permissionId", "organization" ], "variable": [ { "key": "permissionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-38bd7639-93c4-4302-a954-ea72c645314a" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-eaf1aab2-4fcb-477d-93f9-8ea168ab34d5" } ], "id": "ef12a079-8a87-451e-b7ac-e799f10658df", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-ef12a079-8a87-451e-b7ac-e799f10658df" }, { "name": "role", "item": [ { "name": "Related permission", "id": "b15a4c3d-843b-4364-9f4d-b23cde89063e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/permissions/:permissionId/role", "host": [ "{{baseUrl}}" ], "path": [ "permissions", ":permissionId", "role" ], "variable": [ { "id": "121e40e2-8826-40e1-a694-875ee1f71444", "key": "permissionId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related permission" }, "response": [ { "id": "17003b96-08d3-421c-9952-438fd72285ed", "name": "The role associated to the permission", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/permissions/:permissionId/role", "host": [ "{{baseUrl}}" ], "path": [ "permissions", ":permissionId", "role" ], "variable": [ { "key": "permissionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-17003b96-08d3-421c-9952-438fd72285ed" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-b15a4c3d-843b-4364-9f4d-b23cde89063e" } ], "id": "c61dd713-893e-4aa1-9d41-24c7172b477b", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-c61dd713-893e-4aa1-9d41-24c7172b477b" }, { "name": "versions", "item": [ { "name": "Related permission", "id": "b1ec0d2e-72fa-4a79-9092-6b158cc57032", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/permissions/:permissionId/versions", "host": [ "{{baseUrl}}" ], "path": [ "permissions", ":permissionId", "versions" ], "variable": [ { "id": "fd2686a8-9195-4c03-8839-0e82b70ced9d", "key": "permissionId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related permission" }, "response": [ { "id": "a89e31a7-1532-4123-bd6e-93977b29b4db", "name": "The versions associated to the permission", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/permissions/:permissionId/versions", "host": [ "{{baseUrl}}" ], "path": [ "permissions", ":permissionId", "versions" ], "variable": [ { "key": "permissionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-a89e31a7-1532-4123-bd6e-93977b29b4db" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-b1ec0d2e-72fa-4a79-9092-6b158cc57032" } ], "id": "4d544697-b34b-48e8-8556-5b2d34a10215", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-4d544697-b34b-48e8-8556-5b2d34a10215" }, { "name": "Retrieve an permission", "id": "8074897e-877c-4005-b1da-cedfc07c110c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/permissions/:permissionId", "host": [ "{{baseUrl}}" ], "path": [ "permissions", ":permissionId" ], "variable": [ { "id": "7f8ae26c-3b88-47d5-aa5f-185f0e44f06c", "key": "permissionId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Retrieve an permission" }, "response": [ { "id": "3b976c4b-1945-4240-ab82-316dcb833b74", "name": "The permission object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/permissions/:permissionId", "host": [ "{{baseUrl}}" ], "path": [ "permissions", ":permissionId" ], "variable": [ { "key": "permissionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"permissions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"can_create\": \"\",\n \"can_read\": \"\",\n \"can_update\": \"\",\n \"can_destroy\": \"\",\n \"subject\": \"\",\n \"restrictions\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-3b976c4b-1945-4240-ab82-316dcb833b74" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-8074897e-877c-4005-b1da-cedfc07c110c" }, { "name": "Updates an permission", "id": "c830b453-31bf-44ac-9e79-d84adb5c4832", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"permissions\",\n \"id\": \"\",\n \"attributes\": {\n \"can_create\": \"\",\n \"can_read\": \"\",\n \"can_update\": \"\",\n \"can_destroy\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/permissions/:permissionId", "host": [ "{{baseUrl}}" ], "path": [ "permissions", ":permissionId" ], "variable": [ { "id": "3c83d5b4-74b6-43dd-b88d-7f4f1d8d8316", "key": "permissionId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Updates an permission" }, "response": [ { "id": "acd964ab-4c70-4c0e-9369-9965e440c452", "name": "The updated permission object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"permissions\",\n \"id\": \"\",\n \"attributes\": {\n \"can_create\": \"\",\n \"can_read\": \"\",\n \"can_update\": \"\",\n \"can_destroy\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/permissions/:permissionId", "host": [ "{{baseUrl}}" ], "path": [ "permissions", ":permissionId" ], "variable": [ { "key": "permissionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"permissions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"can_create\": \"\",\n \"can_read\": \"\",\n \"can_update\": \"\",\n \"can_destroy\": \"\",\n \"subject\": \"\",\n \"restrictions\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-acd964ab-4c70-4c0e-9369-9965e440c452" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-c830b453-31bf-44ac-9e79-d84adb5c4832" } ], "id": "c44c06de-8f53-41ec-9720-ca192e7dd470", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-c44c06de-8f53-41ec-9720-ca192e7dd470" }, { "name": "Creates an permission", "id": "eca995b3-f390-42b5-919b-086c6038208a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"permissions\",\n \"attributes\": {\n \"can_create\": \"\",\n \"can_read\": \"\",\n \"can_update\": \"\",\n \"can_destroy\": \"\",\n \"subject\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/permissions", "host": [ "{{baseUrl}}" ], "path": [ "permissions" ] }, "description": "Creates an permission" }, "response": [ { "id": "383c94e7-25c3-4980-9b2b-449a7af1cda7", "name": "The created permission object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"permissions\",\n \"attributes\": {\n \"can_create\": \"\",\n \"can_read\": \"\",\n \"can_update\": \"\",\n \"can_destroy\": \"\",\n \"subject\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"role\": {\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/permissions", "host": [ "{{baseUrl}}" ], "path": [ "permissions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"permissions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"can_create\": \"\",\n \"can_read\": \"\",\n \"can_update\": \"\",\n \"can_destroy\": \"\",\n \"subject\": \"\",\n \"restrictions\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-383c94e7-25c3-4980-9b2b-449a7af1cda7" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-eca995b3-f390-42b5-919b-086c6038208a" }, { "name": "List all permissions", "id": "dd8a5457-a980-4ef3-aaef-07814d64403d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/permissions", "host": [ "{{baseUrl}}" ], "path": [ "permissions" ] }, "description": "List all permissions" }, "response": [ { "id": "43542959-b9d4-4fb6-bf1b-f52ecd6c0841", "name": "A list of permission objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/permissions", "host": [ "{{baseUrl}}" ], "path": [ "permissions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"permissions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"can_create\": \"\",\n \"can_read\": \"\",\n \"can_update\": \"\",\n \"can_destroy\": \"\",\n \"subject\": \"\",\n \"restrictions\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"permissions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"can_create\": \"\",\n \"can_read\": \"\",\n \"can_update\": \"\",\n \"can_destroy\": \"\",\n \"subject\": \"\",\n \"restrictions\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"role\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"role\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-43542959-b9d4-4fb6-bf1b-f52ecd6c0841" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-dd8a5457-a980-4ef3-aaef-07814d64403d" } ], "id": "18e8e89d-5d96-454c-ade1-6f7ffbc3d714", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-18e8e89d-5d96-454c-ade1-6f7ffbc3d714" }, { "name": "roles", "item": [ { "name": "{roleId}", "item": [ { "name": "organization", "item": [ { "name": "Related role", "id": "ffb263f7-62fd-47c3-b71a-8f590101f80c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/roles/:roleId/organization", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId", "organization" ], "variable": [ { "id": "2b1fc854-f378-4a1a-aa03-5db9888662ca", "key": "roleId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related role" }, "response": [ { "id": "66b248af-eb38-4fc3-b8a5-07abf2565284", "name": "The organization associated to the role", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/roles/:roleId/organization", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId", "organization" ], "variable": [ { "key": "roleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-66b248af-eb38-4fc3-b8a5-07abf2565284" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-ffb263f7-62fd-47c3-b71a-8f590101f80c" } ], "id": "f14a6272-122f-4a93-99df-e323e38802bc", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-f14a6272-122f-4a93-99df-e323e38802bc" }, { "name": "permissions", "item": [ { "name": "Related role", "id": "27a41b59-b0fe-4c2f-937d-3ba54a4651ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/roles/:roleId/permissions", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId", "permissions" ], "variable": [ { "id": "3e95a619-1f71-429c-8252-563bcdf3a87f", "key": "roleId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related role" }, "response": [ { "id": "133eb37d-d026-4ab5-9162-c11f3752af74", "name": "The permissions associated to the role", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/roles/:roleId/permissions", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId", "permissions" ], "variable": [ { "key": "roleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-133eb37d-d026-4ab5-9162-c11f3752af74" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-27a41b59-b0fe-4c2f-937d-3ba54a4651ac" } ], "id": "675c973f-71ee-462e-9db5-31d15dd43bef", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-675c973f-71ee-462e-9db5-31d15dd43bef" }, { "name": "memberships", "item": [ { "name": "Related role", "id": "5585b177-718d-4ba9-934a-98c53fd3b3c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/roles/:roleId/memberships", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId", "memberships" ], "variable": [ { "id": "c9f29f4a-49c6-4cca-9419-0d60a54d41d0", "key": "roleId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related role" }, "response": [ { "id": "7b9c4bcc-f953-469c-bd2d-a58e567b9987", "name": "The memberships associated to the role", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/roles/:roleId/memberships", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId", "memberships" ], "variable": [ { "key": "roleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-7b9c4bcc-f953-469c-bd2d-a58e567b9987" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-5585b177-718d-4ba9-934a-98c53fd3b3c8" } ], "id": "13940740-d7a6-4cab-8211-d0de86fa44d9", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-13940740-d7a6-4cab-8211-d0de86fa44d9" }, { "name": "api_credentials", "item": [ { "name": "Related role", "id": "c89e61c1-24fe-4c80-9681-f3a6295e394a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/roles/:roleId/api_credentials", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId", "api_credentials" ], "variable": [ { "id": "9f31d92d-bc6f-4507-ad80-3c2a6399b93b", "key": "roleId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related role" }, "response": [ { "id": "fb276699-7a0d-4de3-ba76-cc3101f1bf6f", "name": "The api_credentials associated to the role", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/roles/:roleId/api_credentials", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId", "api_credentials" ], "variable": [ { "key": "roleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-fb276699-7a0d-4de3-ba76-cc3101f1bf6f" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-c89e61c1-24fe-4c80-9681-f3a6295e394a" } ], "id": "6bd00e61-1a48-4a45-b7d5-c066343f5078", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-6bd00e61-1a48-4a45-b7d5-c066343f5078" }, { "name": "versions", "item": [ { "name": "Related role", "id": "ca608cf1-a68d-4ef6-813e-f8fbed6b0bc7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/roles/:roleId/versions", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId", "versions" ], "variable": [ { "id": "6fbad785-b8dd-4676-8d1e-2bf9600deee6", "key": "roleId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Related role" }, "response": [ { "id": "e09746a5-fbfb-4558-9bfb-950526d9db1c", "name": "The versions associated to the role", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/roles/:roleId/versions", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId", "versions" ], "variable": [ { "key": "roleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-e09746a5-fbfb-4558-9bfb-950526d9db1c" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-ca608cf1-a68d-4ef6-813e-f8fbed6b0bc7" } ], "id": "8e95fb05-d293-4453-9364-e3cba0b27e67", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-8e95fb05-d293-4453-9364-e3cba0b27e67" }, { "name": "Retrieve an role", "id": "02b4bb4e-168d-4498-995c-313a1a3f1d3e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/roles/:roleId", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId" ], "variable": [ { "id": "b9c1f01a-71b0-447a-96a4-ce14da869a91", "key": "roleId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Retrieve an role" }, "response": [ { "id": "b11d19d5-9cb2-46a4-9ab8-b18391756752", "name": "The role object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/roles/:roleId", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId" ], "variable": [ { "key": "roleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"roles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"permissions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"permissions\",\n \"id\": \"\"\n }\n },\n \"memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\"\n }\n },\n \"api_credentials\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-b11d19d5-9cb2-46a4-9ab8-b18391756752" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-02b4bb4e-168d-4498-995c-313a1a3f1d3e" }, { "name": "Updates an role", "id": "032ab4b8-cdc1-47c3-87be-33f624ca4107", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"_add_missing_base_permissions\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/roles/:roleId", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId" ], "variable": [ { "id": "1dd7fa9e-8037-4259-aef7-c96fbcb7d494", "key": "roleId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Updates an role" }, "response": [ { "id": "1b611156-8bc1-4329-acce-32b1e696c056", "name": "The updated role object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"roles\",\n \"id\": \"\",\n \"attributes\": {\n \"name\": \"\",\n \"_add_missing_base_permissions\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/roles/:roleId", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":roleId" ], "variable": [ { "key": "roleId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"roles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"permissions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"permissions\",\n \"id\": \"\"\n }\n },\n \"memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\"\n }\n },\n \"api_credentials\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-1b611156-8bc1-4329-acce-32b1e696c056" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-032ab4b8-cdc1-47c3-87be-33f624ca4107" } ], "id": "cf130777-d0e2-4824-aaa1-274ed7ecb467", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-cf130777-d0e2-4824-aaa1-274ed7ecb467" }, { "name": "Creates an role", "id": "82b81319-384f-4636-8e5b-bf1d1f01e57f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/roles", "host": [ "{{baseUrl}}" ], "path": [ "roles" ] }, "description": "Creates an role" }, "response": [ { "id": "c4e2cb04-7ae4-4a8e-86e4-02a9178b2835", "name": "The created role object", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"roles\",\n \"attributes\": {\n \"name\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organizations\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/roles", "host": [ "{{baseUrl}}" ], "path": [ "roles" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"roles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"permissions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"permissions\",\n \"id\": \"\"\n }\n },\n \"memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\"\n }\n },\n \"api_credentials\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-c4e2cb04-7ae4-4a8e-86e4-02a9178b2835" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-82b81319-384f-4636-8e5b-bf1d1f01e57f" }, { "name": "List all roles", "id": "c744e156-52ca-477a-9d88-332fd08d67f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/roles", "host": [ "{{baseUrl}}" ], "path": [ "roles" ] }, "description": "List all roles" }, "response": [ { "id": "fd2f2db4-23b0-4c69-ae56-119ef4251b2e", "name": "A list of role objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/roles", "host": [ "{{baseUrl}}" ], "path": [ "roles" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"roles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"permissions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"permissions\",\n \"id\": \"\"\n }\n },\n \"memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\"\n }\n },\n \"api_credentials\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"roles\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"name\": \"\",\n \"kind\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {\n \"organization\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"\"\n }\n },\n \"permissions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"permissions\",\n \"id\": \"\"\n }\n },\n \"memberships\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"memberships\",\n \"id\": \"\"\n }\n },\n \"api_credentials\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"api_credentials\",\n \"id\": \"\"\n }\n },\n \"versions\": {\n \"links\": {\n \"self\": \"\",\n \"related\": \"\"\n },\n \"data\": {\n \"type\": \"versions\",\n \"id\": \"\"\n }\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-fd2f2db4-23b0-4c69-ae56-119ef4251b2e" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-c744e156-52ca-477a-9d88-332fd08d67f7" } ], "id": "d14419ee-91d6-4d48-90a8-786bb908dd48", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-d14419ee-91d6-4d48-90a8-786bb908dd48" }, { "name": "user", "item": [ { "name": "Retrieve an user", "id": "65bafd0f-e065-4bef-956e-e13af91a7814", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/user", "host": [ "{{baseUrl}}" ], "path": [ "user" ] }, "description": "Retrieve an user" }, "response": [ { "id": "d2537704-fb10-4b1b-a477-1b1bf4c22b89", "name": "The user object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/user", "host": [ "{{baseUrl}}" ], "path": [ "user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"users\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"time_zone\": \"\",\n \"otp_required_for_login\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-d2537704-fb10-4b1b-a477-1b1bf4c22b89" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-65bafd0f-e065-4bef-956e-e13af91a7814" }, { "name": "Updates an user", "id": "06ea4695-64fe-4532-a9ab-131684f5e5b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"time_zone\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/user", "host": [ "{{baseUrl}}" ], "path": [ "user" ] }, "description": "Updates an user" }, "response": [ { "id": "a1d237c2-d55d-4d00-a32d-2b68765f00f3", "name": "The updated user object", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"users\",\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"time_zone\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/user", "host": [ "{{baseUrl}}" ], "path": [ "user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"users\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"time_zone\": \"\",\n \"otp_required_for_login\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-a1d237c2-d55d-4d00-a32d-2b68765f00f3" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-06ea4695-64fe-4532-a9ab-131684f5e5b2" } ], "id": "985528ec-c5af-411b-b16d-09171bb87f1e", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-985528ec-c5af-411b-b16d-09171bb87f1e" }, { "name": "versions", "item": [ { "name": "{versionId}", "item": [ { "name": "Retrieve an version", "id": "f90a1546-9357-4a1e-9373-188c20ea6c30", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/versions/:versionId", "host": [ "{{baseUrl}}" ], "path": [ "versions", ":versionId" ], "variable": [ { "id": "0bbf564f-5aef-4ac7-a979-90bf15f0124c", "key": "versionId", "value": "", "description": "(Required) The ID of the resource." } ] }, "description": "Retrieve an version" }, "response": [ { "id": "743dda6a-e06a-4451-ac26-480ef1c5c227", "name": "The version object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/versions/:versionId", "host": [ "{{baseUrl}}" ], "path": [ "versions", ":versionId" ], "variable": [ { "key": "versionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"id\": \"\",\n \"type\": \"versions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"event\": \"\",\n \"changes\": {},\n \"who\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-743dda6a-e06a-4451-ac26-480ef1c5c227" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-f90a1546-9357-4a1e-9373-188c20ea6c30" } ], "id": "b20bba7f-7559-4d8d-b963-68c7da0b2459", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-b20bba7f-7559-4d8d-b963-68c7da0b2459" }, { "name": "List all versions", "id": "65bf1416-f8e3-4b6d-8c96-1a6aecc9ace0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "url": { "raw": "{{baseUrl}}/versions", "host": [ "{{baseUrl}}" ], "path": [ "versions" ] }, "description": "List all versions" }, "response": [ { "id": "a1116dde-1f26-48d3-a3af-dfb8df446137", "name": "A list of version objects", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/vnd.api+json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/versions", "host": [ "{{baseUrl}}" ], "path": [ "versions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"versions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"event\": \"\",\n \"changes\": {},\n \"who\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n },\n {\n \"id\": \"\",\n \"type\": \"versions\",\n \"links\": {\n \"self\": \"\"\n },\n \"attributes\": {\n \"resource_type\": \"\",\n \"resource_id\": \"\",\n \"event\": \"\",\n \"changes\": {},\n \"who\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reference\": \"\",\n \"reference_origin\": \"\",\n \"metadata\": {}\n },\n \"relationships\": {}\n }\n ]\n}", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-a1116dde-1f26-48d3-a3af-dfb8df446137" } ], "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-65bf1416-f8e3-4b6d-8c96-1a6aecc9ace0" } ], "id": "b35b625b-a21e-42bc-93e0-0af3807914a5", "createdAt": "2026-06-05T15:07:31.000Z", "updatedAt": "2026-06-05T15:07:31.000Z", "uid": "35240-b35b625b-a21e-42bc-93e0-0af3807914a5" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://provisioning.commercelayer.io" } ] }