{ "info": { "_postman_id": "931622d4-495d-4956-9da2-9610d1f51c13", "name": "Amigo Account External Roles API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:00:53.000Z", "updatedAt": "2026-07-28T01:00:53.000Z", "lastUpdatedBy": "35240", "uid": "35240-931622d4-495d-4956-9da2-9610d1f51c13" }, "item": [ { "name": "v1", "item": [ { "name": "{workspace_id}", "item": [ { "name": "external-roles", "item": [ { "name": "{role_id}", "item": [ { "name": "Get External Role", "id": "3fdf08ea-5cfe-4403-b2a6-275424254901", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles", ":role_id" ], "variable": [ { "id": "b8151853-0fbe-4b56-9b17-595441933a27", "key": "workspace_id", "value": "", "description": "(Required) " }, { "id": "65398c5f-e103-4fe7-8437-f2f4f8a7842a", "key": "role_id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "332e3c7c-e430-401e-ad18-8a65bd3e461a", "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles", ":role_id" ], "variable": [ { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"external_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n}", "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-332e3c7c-e430-401e-ad18-8a65bd3e461a" }, { "id": "c3a1ff6e-3213-44be-88c4-d64df4c8a99b", "name": "External role not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles", ":role_id" ], "variable": [ { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-c3a1ff6e-3213-44be-88c4-d64df4c8a99b" }, { "id": "aecfa572-62a0-4f8c-979c-ee74ae02e54d", "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles", ":role_id" ], "variable": [ { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-aecfa572-62a0-4f8c-979c-ee74ae02e54d" } ], "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-3fdf08ea-5cfe-4403-b2a6-275424254901" }, { "name": "Delete External Role", "id": "2307a63c-717c-453f-8ea0-c7edebbf081a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles", ":role_id" ], "variable": [ { "id": "c9b51250-4a06-4c27-aa02-b77884d05eb5", "key": "workspace_id", "value": "", "description": "(Required) " }, { "id": "229a6f45-62a6-48f9-b8ef-24bb516288c3", "key": "role_id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "8bdded4d-6732-499f-9ba0-0f8df7d0239c", "name": "Successful Response", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles", ":role_id" ], "variable": [ { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-8bdded4d-6732-499f-9ba0-0f8df7d0239c" }, { "id": "2c4acda3-c8ee-4b2e-af5d-410ecbbedc9c", "name": "External role not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles", ":role_id" ], "variable": [ { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-2c4acda3-c8ee-4b2e-af5d-410ecbbedc9c" }, { "id": "b5626c37-d39c-4a53-a056-966e4b670b75", "name": "Validation Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles/:role_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles", ":role_id" ], "variable": [ { "key": "workspace_id" }, { "key": "role_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-b5626c37-d39c-4a53-a056-966e4b670b75" } ], "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-2307a63c-717c-453f-8ea0-c7edebbf081a" } ], "id": "8c89f630-5a4c-4e7b-9924-8d911dd9a859", "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-8c89f630-5a4c-4e7b-9924-8d911dd9a859" }, { "name": "List External Roles", "id": "be513c96-d62b-4ab5-8872-c68c8a8c1ee9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles?limit=50&title=Continuation Token", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles" ], "query": [ { "key": "limit", "value": "50" }, { "key": "title", "value": "Continuation Token" } ], "variable": [ { "id": "55591843-013f-4726-8b8f-941f4e981561", "key": "workspace_id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "cf894b94-d05c-4d19-8d86-be0c713622e4", "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles?limit=50&title=Continuation Token", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles" ], "query": [ { "key": "limit", "value": "50" }, { "key": "title", "value": "Continuation Token" } ], "variable": [ { "key": "workspace_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"external_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"external_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"continuation_token\": {\n \"title\": \"Continuation Token\"\n }\n}", "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-cf894b94-d05c-4d19-8d86-be0c713622e4" }, { "id": "f5cccf3c-ab1b-48f6-abff-1629e1c9f1ef", "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles?limit=50&title=Continuation Token", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles" ], "query": [ { "key": "limit", "value": "50" }, { "key": "title", "value": "Continuation Token" } ], "variable": [ { "key": "workspace_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-f5cccf3c-ab1b-48f6-abff-1629e1c9f1ef" } ], "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-be513c96-d62b-4ab5-8872-c68c8a8c1ee9" }, { "name": "Create External Role", "id": "115a7cb0-d413-4967-9073-702826bab4be", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"sw_6v34yiv0d8wfkbw6xlms0\",\n \"external_name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles" ], "variable": [ { "id": "094d5e3a-7514-4c51-aa5a-ed48ec7172ee", "key": "workspace_id", "value": "", "description": "(Required) " } ] } }, "response": [ { "id": "915827f6-574e-4140-a266-2339f72c812e", "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"sw_6v34yiv0d8wfkbw6xlms0\",\n \"external_name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles" ], "variable": [ { "key": "workspace_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"external_name\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\"\n}", "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-915827f6-574e-4140-a266-2339f72c812e" }, { "id": "9acb6d4b-1aee-4e8b-8095-cd3e21757032", "name": "An external role with the given name already exists", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"sw_6v34yiv0d8wfkbw6xlms0\",\n \"external_name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles" ], "variable": [ { "key": "workspace_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-9acb6d4b-1aee-4e8b-8095-cd3e21757032" }, { "id": "568af437-87f9-4eb9-8e91-9f872b050f0f", "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"sw_6v34yiv0d8wfkbw6xlms0\",\n \"external_name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/external-roles", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "external-roles" ], "variable": [ { "key": "workspace_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-568af437-87f9-4eb9-8e91-9f872b050f0f" } ], "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-115a7cb0-d413-4967-9073-702826bab4be" } ], "id": "5d07592c-1d0a-4d2c-a60e-9ab41458d0d2", "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-5d07592c-1d0a-4d2c-a60e-9ab41458d0d2" } ], "id": "2b53db18-2511-4d40-ac9b-a97e1cdffc13", "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-2b53db18-2511-4d40-ac9b-a97e1cdffc13" } ], "id": "c80f3ed1-d4cd-45b7-b49c-d2064525f37b", "createdAt": "2026-07-28T01:00:54.000Z", "updatedAt": "2026-07-28T01:00:54.000Z", "uid": "35240-c80f3ed1-d4cd-45b7-b49c-d2064525f37b" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.amigo.ai" } ] }