{ "info" : { "name" : "apibuilder api", "schema" : "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description" : { "content" : "Host API documentation for applications providing REST APIs, facilitating the design of good resource first APIs." }, "version" : "0.12.8" }, "item" : [ { "name" : "applications", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ { "key" : "name", "disabled" : true, "description" : { "content" : "The name of an application. Case in-sensitive. Exact match" } }, { "key" : "guid", "disabled" : true, "description" : { "content" : "The guid of an application. Exact match" } }, { "key" : "key", "disabled" : true, "description" : { "content" : "The key of an application. Case in-sensitive. Exact match" } }, { "key" : "has_version", "disabled" : true, "description" : { "content" : "If true, we return applications that have at least one version. If false, we return applications that have no versions in the system" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to search applications" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Search all applications. Results are always paginated." }, "header" : [ ] }, "name" : "GET /:orgKey", "description" : { "content" : "Search all applications. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [application]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ { "key" : "name", "disabled" : true, "description" : { "content" : "The name of an application. Case in-sensitive. Exact match" } }, { "key" : "guid", "disabled" : true, "description" : { "content" : "The guid of an application. Exact match" } }, { "key" : "key", "disabled" : true, "description" : { "content" : "The key of an application. Case in-sensitive. Exact match" } }, { "key" : "has_version", "disabled" : true, "description" : { "content" : "If true, we return applications that have at least one version. If false, we return applications that have no versions in the system" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to search applications" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Search all applications. Results are always paginated." }, "header" : [ ] }, "body" : "[ {\n \"organization\" : {\n \"guid\" : \"ab2fd413-f2a7-4c35-9081-8cca197ce3fb\",\n \"key\" : \"355db113ee8b\"\n },\n \"name\" : \"668956a07a15\",\n \"guid\" : \"a1e85132-4ec6-4739-8fe2-0dd87742a7b3\",\n \"description\" : \"fb9431b173b4\",\n \"key\" : \"bc383ed5aca9\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.708Z\",\n \"created_by\" : {\n \"guid\" : \"11d84abe-983d-401f-a6f3-1ad72ca2ae4b\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.708Z\",\n \"updated_by\" : {\n \"guid\" : \"06ace5c8-f697-4335-9555-eb1ca224fbc5\"\n }\n },\n \"visibility\" : \"public\"\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"5e31b99e8264\",\n \"key\" : \"ce5d4f3d427a\",\n \"description\" : \"d596a4921130\",\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "name" : "POST /:orgKey", "description" : { "content" : "Create an application." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - application", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"5e31b99e8264\",\n \"key\" : \"ce5d4f3d427a\",\n \"description\" : \"d596a4921130\",\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"522b6c21-3bf6-4e11-b825-a7cf22ffc430\",\n \"key\" : \"9611337e1392\"\n },\n \"name\" : \"52442f9f4193\",\n \"guid\" : \"ed77a301-d4e3-4ff6-929b-30c4cff67cd8\",\n \"description\" : \"5b41896b4ca0\",\n \"key\" : \"393c151d814a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.708Z\",\n \"created_by\" : {\n \"guid\" : \"cbd59077-40b3-487c-9f17-ca2b1f29e77b\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.708Z\",\n \"updated_by\" : {\n \"guid\" : \"bed90fa1-9d61-42bf-ad96-591c16f5e70c\"\n }\n },\n \"visibility\" : \"user\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"5e31b99e8264\",\n \"key\" : \"ce5d4f3d427a\",\n \"description\" : \"d596a4921130\",\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"2e29be775d55\",\n \"message\" : \"f842d7cc8721\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"910ccaec6935\",\n \"key\" : \"626bb782625b\",\n \"description\" : \"ce85b5938991\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "name" : "PUT /:orgKey/:applicationKey", "description" : { "content" : "Updates an application." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - application", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"910ccaec6935\",\n \"key\" : \"626bb782625b\",\n \"description\" : \"ce85b5938991\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"b585922e-3055-4446-bf58-883973b66690\",\n \"key\" : \"7b225ce8195a\"\n },\n \"name\" : \"0960399425a0\",\n \"guid\" : \"f6c6f966-ad09-4d0c-b307-b58fca43c6cb\",\n \"description\" : \"0f4ed91db824\",\n \"key\" : \"d5697a26683c\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"cfe8b00e-0831-46c0-891d-eb27ec9deecf\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"fc51814c-8dad-43e8-a211-cd28b98ec301\"\n }\n },\n \"visibility\" : \"public\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"910ccaec6935\",\n \"key\" : \"626bb782625b\",\n \"description\" : \"ce85b5938991\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"7b33e63ef30d\",\n \"message\" : \"97d25888b2dc\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific application and its associated versions." }, "header" : [ ] }, "name" : "DELETE /:orgKey/:applicationKey", "description" : { "content" : "Deletes a specific application and its associated versions." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific application and its associated versions." }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/move", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", "move" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Moves application to a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"org_key\" : \"5fafa3ca5224\"\n}", "mode" : "raw" } }, "name" : "POST /:orgKey/:applicationKey/move", "description" : { "content" : "Moves application to a new organization." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - application", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/move", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", "move" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Moves application to a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"org_key\" : \"5fafa3ca5224\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"51f4db46-0593-4291-9441-3aeb18deaa3b\",\n \"key\" : \"1f22bc59f9c5\"\n },\n \"name\" : \"c68900eefdfd\",\n \"guid\" : \"0bbabb61-8765-44e2-98e0-7c71feca1c0b\",\n \"description\" : \"8065265a141c\",\n \"key\" : \"6f9d691dbd4b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"75f5d18e-02ec-4b58-8fce-37f91f0b39c0\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"3fad8a9e-e59c-45bc-8d8a-c7ea98943ae7\"\n }\n },\n \"visibility\" : \"public\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/move", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", "move" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Moves application to a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"org_key\" : \"5fafa3ca5224\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"06e5ecbfda3f\",\n \"message\" : \"82223f5107c7\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "attributes", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the watch with this guid." } }, { "key" : "name", "disabled" : true, "description" : { "content" : "Find attributes with this name. Case in-sensitive. Exact match" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all attributes. Results are always paginated." }, "header" : [ ] }, "name" : "GET /attributes", "description" : { "content" : "Search all attributes. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [attribute]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the watch with this guid." } }, { "key" : "name", "disabled" : true, "description" : { "content" : "Find attributes with this name. Case in-sensitive. Exact match" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all attributes. Results are always paginated." }, "header" : [ ] }, "body" : "[ {\n \"guid\" : \"82ba3290-cdcf-4af6-8e5f-9d402423cd1f\",\n \"name\" : \"812b326d2fc2\",\n \"description\" : \"155e2215a681\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"be1a31a2-ea2f-4d67-8c2c-0c57a2b71e6d\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"9cf3fbab-6bc1-4988-8155-461efa4e9601\"\n }\n }\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the attribute with this name." }, "header" : [ ] }, "name" : "GET /attributes/:name", "description" : { "content" : "Returns the attribute with this name." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - attribute", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the attribute with this name." }, "header" : [ ] }, "body" : "{\n \"guid\" : \"1ea4c80b-6cd0-431d-9b62-4f100627c69e\",\n \"name\" : \"56746a47794f\",\n \"description\" : \"6e30628438b1\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"f8bbe0ca-e89d-41b0-ac3c-8ce250efd73c\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"6baabe0e-abe3-492d-bd51-d54f1974c255\"\n }\n }\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the attribute with this name." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new attribute." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"dc12a6333083\",\n \"description\" : \"614aafd6fad3\"\n}", "mode" : "raw" } }, "name" : "POST /attributes", "description" : { "content" : "Create a new attribute." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 201 - attribute", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new attribute." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"dc12a6333083\",\n \"description\" : \"614aafd6fad3\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"2086be26-688e-4e9b-8c5a-290eb3d471f7\",\n \"name\" : \"850241ea8860\",\n \"description\" : \"3c24b57bec26\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"5cb81fa2-2942-4e00-a50a-b22635e207cb\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"d1ff912c-f05e-4fea-8dc7-dc00626ac94f\"\n }\n }\n}", "code" : 201 }, { "name" : "Example 401 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new attribute." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"dc12a6333083\",\n \"description\" : \"614aafd6fad3\"\n}", "mode" : "raw" } }, "code" : 401 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new attribute." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"dc12a6333083\",\n \"description\" : \"614aafd6fad3\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"ad1b8ef9c0ea\",\n \"message\" : \"c208be87b354\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute with this name. Only the user who created an attribute can delete it." }, "header" : [ ] }, "name" : "DELETE /attributes/:name", "description" : { "content" : "Deletes the attribute with this name. Only the user who created an attribute can delete it." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute with this name. Only the user who created an attribute can delete it." }, "header" : [ ] }, "code" : 204 }, { "name" : "Example 401 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute with this name. Only the user who created an attribute can delete it." }, "header" : [ ] }, "code" : 401 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute with this name. Only the user who created an attribute can delete it." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "authentications", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/authentications/session/:id", "host" : [ "{{BASE_URL}}" ], "path" : [ "authentications", "session", ":id" ], "query" : [ ], "variable" : [ { "key" : "id", "value" : "{{id}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /authentications/session/:id", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - authentication", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/authentications/session/:id", "host" : [ "{{BASE_URL}}" ], "path" : [ "authentications", "session", ":id" ], "query" : [ ], "variable" : [ { "key" : "id", "value" : "{{id}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "body" : "{\n \"user\" : {\n \"name\" : \"6b78e1d6656b\",\n \"email\" : \"a221d54ce850\",\n \"guid\" : \"5034d6eb-dbbb-4231-80ae-55fa6b320e70\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"12c7b08c-fe5f-4f6e-a273-672ef401b87c\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"daf0b1d1-c814-4ea7-932c-d317c32708f7\"\n }\n },\n \"nickname\" : \"19de9086aebd\"\n },\n \"session\" : {\n \"id\" : \"1c7e3426b8ae\",\n \"expires_at\" : \"2026-10-17T18:41:24.709Z\"\n }\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/authentications/session/:id", "host" : [ "{{BASE_URL}}" ], "path" : [ "authentications", "session", ":id" ], "query" : [ ], "variable" : [ { "key" : "id", "value" : "{{id}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 404 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "changes", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/changes", "host" : [ "{{BASE_URL}}" ], "path" : [ "changes" ], "query" : [ { "key" : "org_key", "disabled" : true, "description" : { "content" : "Filter changes to those made for the organization with this key." } }, { "key" : "application_key", "disabled" : true, "description" : { "content" : "Filter changes to those made for the application with this key." } }, { "key" : "from", "value" : "0.1.3", "disabled" : true, "description" : { "content" : "Filter changes to those made from this version." } }, { "key" : "to", "value" : "0.1.4", "disabled" : true, "description" : { "content" : "Filter changes to those made to this version." } }, { "key" : "type", "value" : "breaking or non_breaking", "disabled" : true, "description" : { "content" : "The type of diff to return." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /changes", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [change]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/changes", "host" : [ "{{BASE_URL}}" ], "path" : [ "changes" ], "query" : [ { "key" : "org_key", "disabled" : true, "description" : { "content" : "Filter changes to those made for the organization with this key." } }, { "key" : "application_key", "disabled" : true, "description" : { "content" : "Filter changes to those made for the application with this key." } }, { "key" : "from", "value" : "0.1.3", "disabled" : true, "description" : { "content" : "Filter changes to those made from this version." } }, { "key" : "to", "value" : "0.1.4", "disabled" : true, "description" : { "content" : "Filter changes to those made to this version." } }, { "key" : "type", "value" : "breaking or non_breaking", "disabled" : true, "description" : { "content" : "The type of diff to return." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "body" : "[ {\n \"changed_at\" : \"2026-10-17T18:41:24.709Z\",\n \"changed_by\" : {\n \"guid\" : \"88802926-457a-4592-8f79-70c2964d1f82\",\n \"nickname\" : \"81f501941e70\"\n },\n \"diff\" : {\n \"type\" : \"diff_breaking\",\n \"description\" : \"model removed: user\"\n },\n \"from_version\" : {\n \"guid\" : \"eae91471-22dc-4735-b70b-f30a219c36ce\",\n \"version\" : \"12e461253627\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"408cd061-c14f-468e-b6d3-f317faa2a21d\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"cf63e23f-68d1-4482-bc32-60c410bf4a7b\"\n }\n },\n \"application\" : {\n \"guid\" : \"3a640a91-0fa9-4b84-ba80-a962b8565a74\",\n \"key\" : \"be62b3841841\"\n },\n \"organization\" : {\n \"guid\" : \"db2fe108-9a0b-4412-b1be-c59b31ab441a\",\n \"key\" : \"01a6eb885094\"\n },\n \"guid\" : \"ae296ef6-89fb-4630-94f2-f5eba73cb021\",\n \"to_version\" : {\n \"guid\" : \"7a531c6e-40d7-49aa-b8b9-2ff0cd4ca43c\",\n \"version\" : \"e9384b6975a6\"\n }\n} ]", "code" : 200 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "code", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/:generatorKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", ":generatorKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to generate code" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to generate code" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "The version of this application. Can be 'latest'" }, "disabled" : false }, { "key" : "generatorKey", "value" : "{{generatorKey}}", "description" : { "content" : "The key of the generator to invoke" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ ] }, "name" : "GET /:orgKey/:applicationKey/:version/:generatorKey", "description" : { "content" : "Generate code for a specific version of an application." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - code", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/:generatorKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", ":generatorKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to generate code" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to generate code" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "The version of this application. Can be 'latest'" }, "disabled" : false }, { "key" : "generatorKey", "value" : "{{generatorKey}}", "description" : { "content" : "The key of the generator to invoke" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ ] }, "body" : "{\n \"generator\" : {\n \"service\" : {\n \"guid\" : \"bcfd3a65-6508-4994-943a-84a4440dd4c3\",\n \"uri\" : \"6cfebeb26d72\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"dad07934-31c5-4e6f-b36c-cc2a67b898cf\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"30e1ba59-78a4-4b0e-b399-62282951f7c4\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"9735a6c93df5\",\n \"description\" : \"39df78e8de7e\",\n \"attributes\" : [ ],\n \"key\" : \"c77a2b570174\",\n \"language\" : \"scala\"\n }\n },\n \"source\" : \"00e3651a7fd6\",\n \"files\" : [ ]\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/:generatorKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", ":generatorKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to generate code" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to generate code" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "The version of this application. Can be 'latest'" }, "disabled" : false }, { "key" : "generatorKey", "value" : "{{generatorKey}}", "description" : { "content" : "The key of the generator to invoke" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ ] }, "code" : 404 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/:generatorKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", ":generatorKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to generate code" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to generate code" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "The version of this application. Can be 'latest'" }, "disabled" : false }, { "key" : "generatorKey", "value" : "{{generatorKey}}", "description" : { "content" : "The key of the generator to invoke" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ ] }, "body" : "[ {\n \"code\" : \"5a1d731f077a\",\n \"message\" : \"22ab4ef474f9\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "domains", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/domains/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ "domains", ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Add a domain to this organization" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"www.apibuilder.io\"\n}", "mode" : "raw" } }, "name" : "POST /domains/:orgKey", "description" : { "content" : "Add a domain to this organization" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - domain", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/domains/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ "domains", ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Add a domain to this organization" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"www.apibuilder.io\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"www.apibuilder.io\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/domains/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ "domains", ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Add a domain to this organization" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"www.apibuilder.io\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"140c33a00a3b\",\n \"message\" : \"35c90c97b497\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/domains/:orgKey/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "domains", ":orgKey", ":name" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Remove this domain from this organization" }, "header" : [ ] }, "name" : "DELETE /domains/:orgKey/:name", "description" : { "content" : "Remove this domain from this organization" }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/domains/:orgKey/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "domains", ":orgKey", ":name" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Remove this domain from this organization" }, "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "email_verification_confirmation_forms", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/email_verification_confirmations", "host" : [ "{{BASE_URL}}" ], "path" : [ "email_verification_confirmations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Validate an email address using a token." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"e65810644a8d\"\n}", "mode" : "raw" } }, "name" : "POST /email_verification_confirmations", "description" : { "content" : "Validate an email address using a token." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/email_verification_confirmations", "host" : [ "{{BASE_URL}}" ], "path" : [ "email_verification_confirmations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Validate an email address using a token." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"e65810644a8d\"\n}", "mode" : "raw" } }, "code" : 204 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/email_verification_confirmations", "host" : [ "{{BASE_URL}}" ], "path" : [ "email_verification_confirmations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Validate an email address using a token." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"e65810644a8d\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"22b5ae6db635\",\n \"message\" : \"abf8dcec1fd1\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "generator_services", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/generator_services", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "uri", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "generator_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "100", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "List all generator services" }, "header" : [ ] }, "name" : "GET /generator_services", "description" : { "content" : "List all generator services" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [generator_service]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "uri", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "generator_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "100", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "List all generator services" }, "header" : [ ] }, "body" : "[ {\n \"guid\" : \"bd057c6a-71d6-45c1-b5e7-2f0b85aa7564\",\n \"uri\" : \"8053aa42895e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"188beabf-a550-418d-b264-e40109f376a1\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"2e718110-ff42-4289-93d3-f134069e5725\"\n }\n }\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /generator_services/:guid", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - generator_service", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "body" : "{\n \"guid\" : \"9edf0785-9c60-479a-b5bf-4ea3497bd1fe\",\n \"uri\" : \"3c6815ded12f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"957ff08b-f000-4878-9b60-984bb63fc629\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"f74a170a-e776-4f63-84c8-3bed450f7899\"\n }\n }\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/generator_services", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"uri\" : \"bfb89ff2cfa3\"\n}", "mode" : "raw" } }, "name" : "POST /generator_services", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - generator_service", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"uri\" : \"bfb89ff2cfa3\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"2d9d7e03-fb42-4ed4-8cd1-a554c4d3c4dd\",\n \"uri\" : \"3680537caa7f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"9e5b2c2e-011b-4e45-885b-e8b830270963\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"a73f7769-2380-4574-bc2b-80709cffcd53\"\n }\n }\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"uri\" : \"bfb89ff2cfa3\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"404b81b92138\",\n \"message\" : \"4522f323b981\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a generator service." }, "header" : [ ] }, "name" : "DELETE /generator_services/:guid", "description" : { "content" : "Deletes a generator service." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a generator service." }, "header" : [ ] }, "code" : 204 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a generator service." }, "header" : [ ] }, "code" : 404 }, { "name" : "Example 403 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a generator service." }, "header" : [ ] }, "code" : 403 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "generator_with_services", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/generators", "host" : [ "{{BASE_URL}}" ], "path" : [ "generators" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Filter to generator with this guid" } }, { "key" : "service_guid", "disabled" : true, "description" : { "content" : "Filter to generator from this service" } }, { "key" : "service_uri", "disabled" : true, "description" : { "content" : "Filter to generator from this service URI" } }, { "key" : "attribute_name", "disabled" : true, "description" : { "content" : "Filter to generators that use this attribute" } }, { "key" : "key", "disabled" : true, "description" : { "content" : "Filter to generator with this key" } }, { "key" : "limit", "value" : "100", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "List all available generators" }, "header" : [ ] }, "name" : "GET /generators", "description" : { "content" : "List all available generators" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [generator_with_service]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generators", "host" : [ "{{BASE_URL}}" ], "path" : [ "generators" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Filter to generator with this guid" } }, { "key" : "service_guid", "disabled" : true, "description" : { "content" : "Filter to generator from this service" } }, { "key" : "service_uri", "disabled" : true, "description" : { "content" : "Filter to generator from this service URI" } }, { "key" : "attribute_name", "disabled" : true, "description" : { "content" : "Filter to generators that use this attribute" } }, { "key" : "key", "disabled" : true, "description" : { "content" : "Filter to generator with this key" } }, { "key" : "limit", "value" : "100", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "List all available generators" }, "header" : [ ] }, "body" : "[ {\n \"service\" : {\n \"guid\" : \"58e18b57-a0c3-4d61-9894-37c84192f0c6\",\n \"uri\" : \"1e83028e3c31\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"94ff9c11-8e31-4c70-8183-c86608f09ba1\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"7ade2635-8d2b-4bed-95ce-b52c6333dcae\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"b61008543206\",\n \"description\" : \"ed13e57f408f\",\n \"attributes\" : [ ],\n \"key\" : \"4da3c743badf\",\n \"language\" : \"scala\"\n }\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/generators/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "generators", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /generators/:key", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - generator_with_service", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generators/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "generators", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "body" : "{\n \"service\" : {\n \"guid\" : \"4bec3eff-9a89-455d-b929-2b854489eecc\",\n \"uri\" : \"ccfa96f44e78\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.709Z\",\n \"created_by\" : {\n \"guid\" : \"5e4bc3be-e033-429c-a7ed-b9ff5f133c73\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.709Z\",\n \"updated_by\" : {\n \"guid\" : \"3d68c0b1-ba91-47e7-9423-db16c1eb981d\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"430a0ccf1fd8\",\n \"description\" : \"0aac65e04159\",\n \"attributes\" : [ ],\n \"key\" : \"43f750f9c06d\",\n \"language\" : \"scala\"\n }\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generators/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "generators", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 404 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "healthchecks", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/_internal_/healthcheck", "host" : [ "{{BASE_URL}}" ], "path" : [ "_internal_", "healthcheck" ], "query" : [ ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /_internal_/healthcheck", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - healthcheck", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/_internal_/healthcheck", "host" : [ "{{BASE_URL}}" ], "path" : [ "_internal_", "healthcheck" ], "query" : [ ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "body" : "{\n \"status\" : \"healthy\"\n}", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/_internal_/migrate", "host" : [ "{{BASE_URL}}" ], "path" : [ "_internal_", "migrate" ], "query" : [ ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /_internal_/migrate", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - map[string]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/_internal_/migrate", "host" : [ "{{BASE_URL}}" ], "path" : [ "_internal_", "migrate" ], "query" : [ ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "body" : "{\n \"foo\" : \"9b95b18ecd6e\"\n}", "code" : 200 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "items", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/items", "host" : [ "{{BASE_URL}}" ], "path" : [ "items" ], "query" : [ { "key" : "q", "disabled" : true, "description" : { "content" : "The search query. At the moment, we do case insensitive exact match search." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /items", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [item]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/items", "host" : [ "{{BASE_URL}}" ], "path" : [ "items" ], "query" : [ { "key" : "q", "disabled" : true, "description" : { "content" : "The search query. At the moment, we do case insensitive exact match search." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "body" : "[ {\n \"guid\" : \"a32d2da2-68d2-4ecb-a3e9-deb99a4f1e57\",\n \"detail\" : {\n \"type\" : \"application_summary\",\n \"guid\" : \"6e46736b-9dd3-4583-a1cb-fb6dd3b7a19a\",\n \"organization\" : {\n \"guid\" : \"f080477c-08bb-4866-aa32-8bd837906dd4\",\n \"key\" : \"ea93c038ccdb\"\n },\n \"key\" : \"e4316168cb42\"\n },\n \"label\" : \"f03c74543003\",\n \"description\" : \"a526b156acce\"\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/items/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "items", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /items/:guid", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - item", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/items/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "items", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "body" : "{\n \"guid\" : \"84f9d1de-0361-445d-82d4-a95fb4bce262\",\n \"detail\" : {\n \"type\" : \"application_summary\",\n \"guid\" : \"1012dabe-1ff3-4950-897a-57e5377e9601\",\n \"organization\" : {\n \"guid\" : \"4c696b64-c651-4a18-a5de-4b2b4dc000c0\",\n \"key\" : \"a7f5894dd587\"\n },\n \"key\" : \"e21aaf07f17f\"\n },\n \"label\" : \"516bed8feae2\",\n \"description\" : \"e3321824ab86\"\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/items/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "items", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 404 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "memberships", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/memberships", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships" ], "query" : [ { "key" : "org_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "org_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "role", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all memberships. Results are always paginated." }, "header" : [ ] }, "name" : "GET /memberships", "description" : { "content" : "Search all memberships. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [membership]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/memberships", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships" ], "query" : [ { "key" : "org_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "org_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "role", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all memberships. Results are always paginated." }, "header" : [ ] }, "body" : "[ {\n \"organization\" : {\n \"name\" : \"17519754b65f\",\n \"guid\" : \"4b27fecd-a5a1-4a3d-999a-871d281db6f4\",\n \"domains\" : [ ],\n \"key\" : \"110468b009e2\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"5fdb3215-6753-4481-9ad1-6b9272265dfd\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"ad54a1d0-2d38-414e-90f8-150abc22fa34\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"91978f6a-fe71-4157-8542-8fc72f869f43\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"ad02ed72-1a79-4a4d-9a14-45d253a9b9eb\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"ba979fe6-75e8-4bb9-ab7e-2109c86a5fdd\"\n }\n },\n \"user\" : {\n \"name\" : \"d493977c85b2\",\n \"email\" : \"a053a67d3f82\",\n \"guid\" : \"997b4ce5-9ba4-4ff4-b040-1ec1125737e1\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"d80ad6fa-e7e3-4631-a80a-4f49764705aa\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"0d54d4ca-83f2-4556-a830-ea7ea9f390c3\"\n }\n },\n \"nickname\" : \"0976625da487\"\n }\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /memberships/:guid", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - membership", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "body" : "{\n \"organization\" : {\n \"name\" : \"ce53076ffa6a\",\n \"guid\" : \"5ccd1703-bbc7-47a0-9f4e-bf26f3fc551d\",\n \"domains\" : [ ],\n \"key\" : \"9365598aac35\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"ddebbeeb-9d45-4948-83e4-a3cc56988951\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"416dc6ba-3f16-47ee-954b-733ff788e826\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"b8cec44b-7cbf-476e-b34d-2b5979fd5574\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"1154e721-7dfa-440e-8083-ea87c386fe85\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"dd13c02a-a74f-469d-ad6e-71dc6cbc9863\"\n }\n },\n \"user\" : {\n \"name\" : \"1dada7314fea\",\n \"email\" : \"038c66d8a0b0\",\n \"guid\" : \"f2837f5a-d0c4-49ee-8af4-f8f494be842d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"e77f1a72-03e7-4ae0-9338-d45a7967c803\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"535f5817-a7cd-4b90-8ed4-069758263d2a\"\n }\n },\n \"nickname\" : \"0cab812e89e7\"\n }\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "name" : "DELETE /memberships/:guid", "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "membership_requests", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests" ], "query" : [ { "key" : "org_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "org_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "role", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all membership requests. Results are always paginated." }, "header" : [ ] }, "name" : "GET /membership_requests", "description" : { "content" : "Search all membership requests. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [membership_request]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests" ], "query" : [ { "key" : "org_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "org_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "role", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all membership requests. Results are always paginated." }, "header" : [ ] }, "body" : "[ {\n \"organization\" : {\n \"name\" : \"4e21ebdeafa9\",\n \"guid\" : \"5a6f3094-0f69-4f42-80e9-5537d2c4d63d\",\n \"domains\" : [ ],\n \"key\" : \"8ba40f24e708\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"03c2b1ea-e97a-49aa-baa4-bb9a9f1fa911\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"ce613aab-b5dc-4250-8167-402d5851367d\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"08a91027-8dfe-41e7-ae65-bc66387ff441\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"27aa2228-90c9-4cff-a2c8-688ee910a977\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"483b382e-6480-4a1d-b2f6-689e50ef64f8\"\n }\n },\n \"user\" : {\n \"name\" : \"4d2c37d2a77c\",\n \"email\" : \"0f6921200a8d\",\n \"guid\" : \"9c84f1b3-1489-42c9-b470-8ff3a3f4da22\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"8d783bfc-8ed2-4e17-b641-2dd941b62aa7\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"743589bf-5e58-421f-8fc0-1a6d40597e88\"\n }\n },\n \"nickname\" : \"289426a13f32\"\n }\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a membership request" }, "header" : [ ] }, "name" : "POST /membership_requests", "description" : { "content" : "Create a membership request" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - membership_request", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a membership request" }, "header" : [ ] }, "body" : "{\n \"organization\" : {\n \"name\" : \"6676abeddda0\",\n \"guid\" : \"d8ff274b-c1c3-4a65-8002-9160a85fadf8\",\n \"domains\" : [ ],\n \"key\" : \"6676d209fcca\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"f99e770e-27ab-4bf9-afa1-e47d61e6a084\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"a0101554-341e-4807-bcc1-92dfcab66dc7\"\n }\n },\n \"visibility\" : \"user\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"d58bbf67-9d56-4535-b6f5-61f2cd57c3e3\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"86f5d8b7-44f3-46af-acc7-e41f25d6c99c\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"ac921985-be06-4289-be98-c8f31b886195\"\n }\n },\n \"user\" : {\n \"name\" : \"3bfa0870ad61\",\n \"email\" : \"3546e190b908\",\n \"guid\" : \"05884cda-01f3-4a76-b91f-76a173c93b0c\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"8739887a-bcbd-4756-bac0-14caddc4b19e\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"97700b76-8bf1-46e7-bb6a-f96e31dbd934\"\n }\n },\n \"nickname\" : \"b07632e25d3d\"\n }\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a membership request" }, "header" : [ ] }, "body" : "[ {\n \"code\" : \"c5edfc4ca3a2\",\n \"message\" : \"462be472be18\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests/:guid/accept", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests", ":guid", "accept" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Accepts this membership request. User will become a member of the specified organization." }, "header" : [ ] }, "name" : "POST /membership_requests/:guid/accept", "description" : { "content" : "Accepts this membership request. User will become a member of the specified organization." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests/:guid/accept", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests", ":guid", "accept" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Accepts this membership request. User will become a member of the specified organization." }, "header" : [ ] }, "code" : 204 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests/:guid/accept", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests", ":guid", "accept" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Accepts this membership request. User will become a member of the specified organization." }, "header" : [ ] }, "body" : "[ {\n \"code\" : \"a9a1c5ccb1c4\",\n \"message\" : \"1dc64cece1e0\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests/:guid/decline", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests", ":guid", "decline" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Declines this membership request. User will NOT become a member of the specified organization." }, "header" : [ ] }, "name" : "POST /membership_requests/:guid/decline", "description" : { "content" : "Declines this membership request. User will NOT become a member of the specified organization." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests/:guid/decline", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests", ":guid", "decline" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Declines this membership request. User will NOT become a member of the specified organization." }, "header" : [ ] }, "code" : 204 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests/:guid/decline", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests", ":guid", "decline" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Declines this membership request. User will NOT become a member of the specified organization." }, "header" : [ ] }, "body" : "[ {\n \"code\" : \"f30cb8769d3e\",\n \"message\" : \"7360d75c6d12\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "organizations", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Finds the organization with this guid, if any" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "If specified, restricts to organizations that this user is specifically a member of (e.g. will exclude public organizations with which the user does not have a direct membership)." } }, { "key" : "key", "disabled" : true, "description" : { "content" : "Find organizations with this key. Case in-sensitive. Exact match" } }, { "key" : "name", "disabled" : true, "description" : { "content" : "Find organizations with this name. Case in-sensitive. Exact match" } }, { "key" : "namespace", "disabled" : true, "description" : { "content" : "Find organizations with this namespace. Case in-sensitive. Exact match" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all organizations. Results are always paginated." }, "header" : [ ] }, "name" : "GET /organizations", "description" : { "content" : "Search all organizations. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [organization]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Finds the organization with this guid, if any" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "If specified, restricts to organizations that this user is specifically a member of (e.g. will exclude public organizations with which the user does not have a direct membership)." } }, { "key" : "key", "disabled" : true, "description" : { "content" : "Find organizations with this key. Case in-sensitive. Exact match" } }, { "key" : "name", "disabled" : true, "description" : { "content" : "Find organizations with this name. Case in-sensitive. Exact match" } }, { "key" : "namespace", "disabled" : true, "description" : { "content" : "Find organizations with this namespace. Case in-sensitive. Exact match" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all organizations. Results are always paginated." }, "header" : [ ] }, "body" : "[ {\n \"name\" : \"b4c5d0591c0f\",\n \"guid\" : \"7b17d292-27c2-472a-8148-5fe57f859953\",\n \"domains\" : [ ],\n \"key\" : \"ddff0a6e1550\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"dc824ea4-4234-4ed3-aca4-73402700c039\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"578d94c7-7374-4f4b-8e43-36c117c012f3\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the organization with this key." }, "header" : [ ] }, "name" : "GET /organizations/:key", "description" : { "content" : "Returns the organization with this key." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - organization", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the organization with this key." }, "header" : [ ] }, "body" : "{\n \"name\" : \"2117651c731f\",\n \"guid\" : \"e0e51df4-f366-4eb4-b378-d1291f009ed1\",\n \"domains\" : [ ],\n \"key\" : \"3c3cdf66d505\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"3fc6f8c1-44b4-4f92-9180-44b84d47cd87\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"382a0a07-96af-4e09-b003-81004f45cb35\"\n }\n },\n \"visibility\" : \"user\",\n \"namespace\" : \"io.apicollective\"\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the organization with this key." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"1f8f8afc6d4b\",\n \"domains\" : [ \"4de855ef2166\" ],\n \"key\" : \"5a549df591b8\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "name" : "POST /organizations", "description" : { "content" : "Create a new organization." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - organization", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"1f8f8afc6d4b\",\n \"domains\" : [ \"4de855ef2166\" ],\n \"key\" : \"5a549df591b8\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"4602aa69b09c\",\n \"guid\" : \"bf37b6c2-5bf7-45a8-a9f5-846b3d9067b6\",\n \"domains\" : [ ],\n \"key\" : \"6bb41d7bdd48\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"c8c21113-8510-4d99-ad51-6234fb330faa\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"2b8c5682-1633-4204-9e38-8a76c5a4ba65\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"1f8f8afc6d4b\",\n \"domains\" : [ \"4de855ef2166\" ],\n \"key\" : \"5a549df591b8\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"772e08e73d90\",\n \"message\" : \"77960afa63e0\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Update an organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"ef2597659108\",\n \"domains\" : [ \"de4e99dabae8\" ],\n \"key\" : \"3e9115e28a74\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "name" : "PUT /organizations/:key", "description" : { "content" : "Update an organization." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - organization", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Update an organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"ef2597659108\",\n \"domains\" : [ \"de4e99dabae8\" ],\n \"key\" : \"3e9115e28a74\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"a75be53973b8\",\n \"guid\" : \"91aea052-eeed-41bd-a242-b4df9cff0528\",\n \"domains\" : [ ],\n \"key\" : \"fc48410d4a78\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"88265f11-2ff4-4406-8b54-3ace72e096c5\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"0f14c36d-a548-486e-a028-35c00117be8e\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Update an organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"ef2597659108\",\n \"domains\" : [ \"de4e99dabae8\" ],\n \"key\" : \"3e9115e28a74\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"8e92961c75b6\",\n \"message\" : \"7e464534f82c\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes an organization and all of its associated applications." }, "header" : [ ] }, "name" : "DELETE /organizations/:key", "description" : { "content" : "Deletes an organization and all of its associated applications." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes an organization and all of its associated applications." }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes" ], "query" : [ { "key" : "name", "disabled" : true, "description" : { "content" : "Find the values for the attribute with this name." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns all attribute values for this organization. Results are always paginated." }, "header" : [ ] }, "name" : "GET /organizations/:key/attributes", "description" : { "content" : "Returns all attribute values for this organization. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [attribute_value]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes" ], "query" : [ { "key" : "name", "disabled" : true, "description" : { "content" : "Find the values for the attribute with this name." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns all attribute values for this organization. Results are always paginated." }, "header" : [ ] }, "body" : "[ {\n \"guid\" : \"d1c2648b-d72e-46e0-b948-38756ba283c5\",\n \"attribute\" : {\n \"guid\" : \"05528b8c-e8b8-4fa1-b4eb-9dfb36fc6534\",\n \"name\" : \"1f3ffe31e19e\"\n },\n \"value\" : \"589321119d17\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"78d3a733-01b5-4a63-bd86-e29cf03279db\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.710Z\",\n \"updated_by\" : {\n \"guid\" : \"4795a688-de81-4a76-913c-6b74eb81e806\"\n }\n }\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the attribute value with this name." }, "header" : [ ] }, "name" : "GET /organizations/:key/attributes/:name", "description" : { "content" : "Returns the attribute value with this name." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - attribute_value", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the attribute value with this name." }, "header" : [ ] }, "body" : "{\n \"guid\" : \"e820d872-4e3d-41dc-9899-cf04fdb30c0f\",\n \"attribute\" : {\n \"guid\" : \"d75c5e8c-665f-44f3-812c-0e9a10cc9e01\",\n \"name\" : \"1bd8fae3c5c2\"\n },\n \"value\" : \"94861d350c0e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.710Z\",\n \"created_by\" : {\n \"guid\" : \"64e2e2d4-1c27-4a97-b8eb-161f557e122c\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"b0f557f8-a53c-4708-8577-4ce5f3d5540b\"\n }\n }\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the attribute value with this name." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Create or update a new attribute value." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"value\" : \"098f3b8ad200\"\n}", "mode" : "raw" } }, "name" : "PUT /organizations/:key/attributes/:name", "description" : { "content" : "Create or update a new attribute value." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - attribute_value", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Create or update a new attribute value." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"value\" : \"098f3b8ad200\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"ecdf4b99-b19d-4ca9-8d23-66ad6a1190c1\",\n \"attribute\" : {\n \"guid\" : \"782362a8-795b-46b0-a2b0-79b47c30694f\",\n \"name\" : \"8bc9a67b7c46\"\n },\n \"value\" : \"3043e90f27ad\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"73972645-fe15-417c-8e5b-3b38710d7ac7\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"823882b1-57e4-42a3-8259-cdafbd006920\"\n }\n }\n}", "code" : 200 }, { "name" : "Example 201 - attribute_value", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Create or update a new attribute value." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"value\" : \"098f3b8ad200\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"d71be614-b621-4292-81f6-a9508c247c13\",\n \"attribute\" : {\n \"guid\" : \"7af65d4b-f15b-4b73-a76e-cb9f9a08448b\",\n \"name\" : \"3505d672089b\"\n },\n \"value\" : \"7d919c3746ae\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"1770b110-3809-4ebf-97a1-e4b942097e7d\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"9e0204dd-cd4a-4c27-aa2f-e2c8db71dbfa\"\n }\n }\n}", "code" : 201 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Create or update a new attribute value." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"value\" : \"098f3b8ad200\"\n}", "mode" : "raw" } }, "code" : 404 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Create or update a new attribute value." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"value\" : \"098f3b8ad200\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"e41568a2d0f1\",\n \"message\" : \"58dc160aac2b\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute value with the specified name. Only the user who created an attribute value can delete it." }, "header" : [ ] }, "name" : "DELETE /organizations/:key/attributes/:name", "description" : { "content" : "Deletes the attribute value with the specified name. Only the user who created an attribute value can delete it." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute value with the specified name. Only the user who created an attribute value can delete it." }, "header" : [ ] }, "code" : 204 }, { "name" : "Example 401 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute value with the specified name. Only the user who created an attribute value can delete it." }, "header" : [ ] }, "code" : 401 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes", ":name" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes the attribute value with the specified name. Only the user who created an attribute value can delete it." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "password_resets", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/password_resets", "host" : [ "{{BASE_URL}}" ], "path" : [ "password_resets" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Change the password for this token. If the token is invalid, has been used, or otherwise no longer can be applied, errors will be returned as 409s. A 204 represents that the user has successfully changed their password." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"aeb8c1c0b3f8\",\n \"password\" : \"198e04de66e8\"\n}", "mode" : "raw" } }, "name" : "POST /password_resets", "description" : { "content" : "Change the password for this token. If the token is invalid, has been used, or otherwise no longer can be applied, errors will be returned as 409s. A 204 represents that the user has successfully changed their password." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - authentication", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/password_resets", "host" : [ "{{BASE_URL}}" ], "path" : [ "password_resets" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Change the password for this token. If the token is invalid, has been used, or otherwise no longer can be applied, errors will be returned as 409s. A 204 represents that the user has successfully changed their password." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"aeb8c1c0b3f8\",\n \"password\" : \"198e04de66e8\"\n}", "mode" : "raw" } }, "body" : "{\n \"user\" : {\n \"name\" : \"242e1a3fa76a\",\n \"email\" : \"ca29c3c1dd38\",\n \"guid\" : \"b30e7d99-a45c-43f9-8f6a-1fa9bd3b26cb\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"596afc89-3c60-4026-b84c-1b39c8c9f62b\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"5a8eaf04-51ce-457a-8213-11ca778e5a91\"\n }\n },\n \"nickname\" : \"046eb7adced4\"\n },\n \"session\" : {\n \"id\" : \"fbd385cbe965\",\n \"expires_at\" : \"2026-10-17T18:41:24.711Z\"\n }\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/password_resets", "host" : [ "{{BASE_URL}}" ], "path" : [ "password_resets" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Change the password for this token. If the token is invalid, has been used, or otherwise no longer can be applied, errors will be returned as 409s. A 204 represents that the user has successfully changed their password." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"aeb8c1c0b3f8\",\n \"password\" : \"198e04de66e8\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"c29882e0699f\",\n \"message\" : \"eb8f7b9205bf\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "password_reset_requests", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/password_reset_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "password_reset_requests" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new password reset. This will send the user an email with a link to reset their password." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"77d9c8a930fd\"\n}", "mode" : "raw" } }, "name" : "POST /password_reset_requests", "description" : { "content" : "Create a new password reset. This will send the user an email with a link to reset their password." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/password_reset_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "password_reset_requests" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new password reset. This will send the user an email with a link to reset their password." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"77d9c8a930fd\"\n}", "mode" : "raw" } }, "code" : 204 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/password_reset_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "password_reset_requests" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new password reset. This will send the user an email with a link to reset their password." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"77d9c8a930fd\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"401992c920f3\",\n \"message\" : \"22c2fa63aa66\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "subscriptions", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the subscription with this guid." } }, { "key" : "organization_key", "disabled" : true, "description" : { "content" : "Find subscriptions for this organization." } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Find subscriptions for this user." } }, { "key" : "publication", "disabled" : true, "description" : { "content" : "Find subscriptions for this publication." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search subscriptions. Always paginated." }, "header" : [ ] }, "name" : "GET /subscriptions", "description" : { "content" : "Search subscriptions. Always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [subscription]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the subscription with this guid." } }, { "key" : "organization_key", "disabled" : true, "description" : { "content" : "Find subscriptions for this organization." } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Find subscriptions for this user." } }, { "key" : "publication", "disabled" : true, "description" : { "content" : "Find subscriptions for this publication." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search subscriptions. Always paginated." }, "header" : [ ] }, "body" : "[ {\n \"organization\" : {\n \"name\" : \"2421c2886a37\",\n \"guid\" : \"1ad8c849-10b7-40e2-92f2-2a7203b363b7\",\n \"domains\" : [ ],\n \"key\" : \"70bdc3416d6b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"1d5e6205-cf1c-402a-9892-4177db442cd3\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"c18f703f-230f-49ac-a1e8-249c229bcd80\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"996f26da-3062-4a2d-a040-7a9835fd87a4\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"6b3c69dd-6847-46c0-95e3-b065a607b8bb\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"27c42d91-7d9f-431c-aade-cf65a32f0bb3\"\n }\n },\n \"publication\" : \"versions.create\",\n \"user\" : {\n \"name\" : \"5a7edf4606f4\",\n \"email\" : \"57086202362b\",\n \"guid\" : \"5141b732-661f-4a33-b609-286f92e484b3\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"8df0f00c-866a-47a4-a224-717dabec1dcb\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"f3d133e4-9263-44a0-9ffd-a20014305e1b\"\n }\n },\n \"nickname\" : \"ec95c8e4a37b\"\n }\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific subscription." }, "header" : [ ] }, "name" : "GET /subscriptions/:guid", "description" : { "content" : "Returns information about a specific subscription." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - subscription", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific subscription." }, "header" : [ ] }, "body" : "{\n \"organization\" : {\n \"name\" : \"919776462b83\",\n \"guid\" : \"82f799ab-7aaa-4f3b-9e43-e3d41e425662\",\n \"domains\" : [ ],\n \"key\" : \"d256d52e763f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"8fe553bf-3e34-4681-807b-abff4d939a94\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"5a8c633e-aede-4030-8cb4-0d9976ccc73a\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"611149de-e272-443a-bea0-a2cc087a37fd\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"8c82a2d8-326c-42b8-a8bb-87e7e3adfd58\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"28edcfd8-86bb-4d44-b9af-1d50e88aa81a\"\n }\n },\n \"publication\" : \"memberships.create\",\n \"user\" : {\n \"name\" : \"88a990df139e\",\n \"email\" : \"7573d42afa43\",\n \"guid\" : \"b97120c7-112d-45a0-ae97-0bae14f786b5\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"81ed3c6a-266d-4178-a3c8-a9e572690280\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"033574e1-b315-4ba8-9551-c5ef3cf4fcb3\"\n }\n },\n \"nickname\" : \"195fb19e131f\"\n }\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific subscription." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new subscription." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"organization_key\" : \"349477c17985\",\n \"user_guid\" : \"52c6c090-1b42-4ff2-9fd4-c6a7942cefd6\",\n \"publication\" : \"versions.create\"\n}", "mode" : "raw" } }, "name" : "POST /subscriptions", "description" : { "content" : "Create a new subscription." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 201 - subscription", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new subscription." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"organization_key\" : \"349477c17985\",\n \"user_guid\" : \"52c6c090-1b42-4ff2-9fd4-c6a7942cefd6\",\n \"publication\" : \"versions.create\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"name\" : \"613246d2c34d\",\n \"guid\" : \"fe539f66-3db9-463b-9081-3e1fb664f1b5\",\n \"domains\" : [ ],\n \"key\" : \"17c30f99d716\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"1b24cb10-a38a-42f8-baa3-f9db1c45b85a\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"00131311-a996-42c5-9caf-56d2c034d579\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"d80d84f0-572b-4052-9f74-1928e475765e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"32f5aa51-f01a-4510-b6a4-adb918fa90b3\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"060b2a34-dfec-487d-ab14-bd91f959e646\"\n }\n },\n \"publication\" : \"applications.create\",\n \"user\" : {\n \"name\" : \"e353e3a004ba\",\n \"email\" : \"60c79e6d8a99\",\n \"guid\" : \"0f3aa4f1-c208-4898-b6e4-80be2a17cf0d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"288b935b-7ad2-4a58-9552-7c5ec00b4fa2\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"804d8cb8-b9ad-4d4d-8ee0-1f9a3fe486fc\"\n }\n },\n \"nickname\" : \"8c0cfd533109\"\n }\n}", "code" : 201 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new subscription." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"organization_key\" : \"349477c17985\",\n \"user_guid\" : \"52c6c090-1b42-4ff2-9fd4-c6a7942cefd6\",\n \"publication\" : \"versions.create\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"d0379a97f5f1\",\n \"message\" : \"98cf80e79225\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "name" : "DELETE /subscriptions/:guid", "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "tokens", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/tokens/users/:user_guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", "users", ":user_guid" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "user_guid", "value" : "{{user_guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /tokens/users/:user_guid", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [token]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens/users/:user_guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", "users", ":user_guid" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "user_guid", "value" : "{{user_guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "body" : "[ {\n \"guid\" : \"9a8e4743-84a3-4e45-a7ee-fa1391fdbee4\",\n \"description\" : \"9a76096590b6\",\n \"masked_token\" : \"7448fe5c544d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"5ac01811-92df-4d15-9e89-52f2eda2d3d9\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"5a0575f3-3d2d-4482-8707-c8014f623a9a\"\n }\n },\n \"user\" : {\n \"name\" : \"f0e49174fc8d\",\n \"email\" : \"22a77f6944ef\",\n \"guid\" : \"03c385f6-a93c-4b34-ae56-06007e2039d3\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"03ef5c3a-76d9-4c3e-8085-9551a8141dfb\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"0e617201-fac1-4c41-8933-af303208fd2a\"\n }\n },\n \"nickname\" : \"92079991fcc6\"\n }\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/tokens/:guid/cleartext", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", ":guid", "cleartext" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Used to fetch the clear text token." }, "header" : [ ] }, "name" : "GET /tokens/:guid/cleartext", "description" : { "content" : "Used to fetch the clear text token." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - cleartext_token", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens/:guid/cleartext", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", ":guid", "cleartext" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Used to fetch the clear text token." }, "header" : [ ] }, "body" : "{\n \"token\" : \"9f3bd95228d5\"\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens/:guid/cleartext", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", ":guid", "cleartext" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Used to fetch the clear text token." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/tokens", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new API token for this user" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"b07b3cc6-6b0d-4df3-b964-3df1dd285464\",\n \"description\" : \"88dd71401f2b\"\n}", "mode" : "raw" } }, "name" : "POST /tokens", "description" : { "content" : "Create a new API token for this user" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 201 - token", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new API token for this user" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"b07b3cc6-6b0d-4df3-b964-3df1dd285464\",\n \"description\" : \"88dd71401f2b\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"473a8487-8a4c-4e21-b4f7-a7c3f0b75969\",\n \"description\" : \"3dfebd4f7b4d\",\n \"masked_token\" : \"bf1243c47f38\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"cd180db0-948c-4be1-86e6-b35ceac51702\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"72fa4bbf-d6fe-4791-b00a-77bad8db5c37\"\n }\n },\n \"user\" : {\n \"name\" : \"4a9e5b955981\",\n \"email\" : \"c61ba868173d\",\n \"guid\" : \"b92cd5e7-375f-43f1-b614-3bfa32e4a946\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"d4b8f05b-342c-4830-960e-f1dafe78550d\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"49890074-778c-4ed1-bafa-af26fc120339\"\n }\n },\n \"nickname\" : \"d48818c87377\"\n }\n}", "code" : 201 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new API token for this user" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"b07b3cc6-6b0d-4df3-b964-3df1dd285464\",\n \"description\" : \"88dd71401f2b\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"e5fee083f986\",\n \"message\" : \"c8d8e12fb98d\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/tokens/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "name" : "DELETE /tokens/:guid", "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "users", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/users", "host" : [ "{{BASE_URL}}" ], "path" : [ "users" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find user with this guid. Exact match" } }, { "key" : "email", "disabled" : true, "description" : { "content" : "Find user with this email address. Case in-sensitive. Exact match" } }, { "key" : "token", "disabled" : true, "description" : { "content" : "Find the user with this API token. Exact match" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search for a specific user. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users." }, "header" : [ ] }, "name" : "GET /users", "description" : { "content" : "Search for a specific user. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [user]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users", "host" : [ "{{BASE_URL}}" ], "path" : [ "users" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find user with this guid. Exact match" } }, { "key" : "email", "disabled" : true, "description" : { "content" : "Find user with this email address. Case in-sensitive. Exact match" } }, { "key" : "token", "disabled" : true, "description" : { "content" : "Find the user with this API token. Exact match" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search for a specific user. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users." }, "header" : [ ] }, "body" : "[ {\n \"name\" : \"cbda8062b8f5\",\n \"email\" : \"124618076b47\",\n \"guid\" : \"b2129238-64c3-4bdd-932c-723be638c733\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"c517ad6d-9192-4894-9627-3df1b36f3b2b\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"c0290c11-4ab5-41ed-ac2b-a5c864cb7513\"\n }\n },\n \"nickname\" : \"63da21b17cde\"\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/users/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about the user with this guid." }, "header" : [ ] }, "name" : "GET /users/:guid", "description" : { "content" : "Returns information about the user with this guid." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - user", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about the user with this guid." }, "header" : [ ] }, "body" : "{\n \"name\" : \"454e1a28fbd9\",\n \"email\" : \"d0426489a8e2\",\n \"guid\" : \"24de2181-7751-44d1-b512-3cb204c1910f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"0b967170-bb66-4cac-a9c7-41bc184499df\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"b258e990-7dc6-4fd0-902c-3f1bcfc68e47\"\n }\n },\n \"nickname\" : \"253a94cf8bab\"\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about the user with this guid." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/users/authenticate", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", "authenticate" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Used to authenticate a user with an email address and password. Successful authentication returns an instance of the user model. Failed authorizations of any kind are returned as a generic error with code user_authorization_failed." }, "header" : [ ] }, "name" : "POST /users/authenticate", "description" : { "content" : "Used to authenticate a user with an email address and password. Successful authentication returns an instance of the user model. Failed authorizations of any kind are returned as a generic error with code user_authorization_failed." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - authentication", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/authenticate", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", "authenticate" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Used to authenticate a user with an email address and password. Successful authentication returns an instance of the user model. Failed authorizations of any kind are returned as a generic error with code user_authorization_failed." }, "header" : [ ] }, "body" : "{\n \"user\" : {\n \"name\" : \"ce216645680c\",\n \"email\" : \"6f4a9cc45ce3\",\n \"guid\" : \"c1035da2-a026-4981-8292-b19a22b726aa\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.711Z\",\n \"created_by\" : {\n \"guid\" : \"44e2cd43-118c-4dd8-ac06-d389742de12c\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.711Z\",\n \"updated_by\" : {\n \"guid\" : \"25b4bb1b-8c40-4017-ac85-3415f8675671\"\n }\n },\n \"nickname\" : \"9be76760ee68\"\n },\n \"session\" : {\n \"id\" : \"9fc507377819\",\n \"expires_at\" : \"2026-10-17T18:41:24.711Z\"\n }\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/authenticate", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", "authenticate" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Used to authenticate a user with an email address and password. Successful authentication returns an instance of the user model. Failed authorizations of any kind are returned as a generic error with code user_authorization_failed." }, "header" : [ ] }, "body" : "[ {\n \"code\" : \"4ca3ffff3fca\",\n \"message\" : \"d2a8bbde7000\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/users/authenticate_github", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", "authenticate_github" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Used to authenticate a user using a github access token. This is equivalent to running the following command to get the user info: curl -H 'Authorization: Bearer code' https://api.github.com/user" }, "header" : [ ] }, "name" : "POST /users/authenticate_github", "description" : { "content" : "Used to authenticate a user using a github access token. This is equivalent to running the following command to get the user info: curl -H 'Authorization: Bearer code' https://api.github.com/user" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - authentication", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/authenticate_github", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", "authenticate_github" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Used to authenticate a user using a github access token. This is equivalent to running the following command to get the user info: curl -H 'Authorization: Bearer code' https://api.github.com/user" }, "header" : [ ] }, "body" : "{\n \"user\" : {\n \"name\" : \"692435ccf7de\",\n \"email\" : \"3ce5f6596ed1\",\n \"guid\" : \"fdb0dca0-e895-4cba-b1ba-beb66be1019a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.712Z\",\n \"created_by\" : {\n \"guid\" : \"9cabe508-f4ac-470d-ade4-10aca6d4712d\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.712Z\",\n \"updated_by\" : {\n \"guid\" : \"6b6a6edb-ed0b-49fd-b6b5-3f1e999ef3df\"\n }\n },\n \"nickname\" : \"34319add917a\"\n },\n \"session\" : {\n \"id\" : \"76fef595596d\",\n \"expires_at\" : \"2026-10-17T18:41:24.712Z\"\n }\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/authenticate_github", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", "authenticate_github" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Used to authenticate a user using a github access token. This is equivalent to running the following command to get the user info: curl -H 'Authorization: Bearer code' https://api.github.com/user" }, "header" : [ ] }, "body" : "[ {\n \"code\" : \"cace341a753a\",\n \"message\" : \"f30be2b381e5\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/users", "host" : [ "{{BASE_URL}}" ], "path" : [ "users" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new user." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"92febee88a06\",\n \"password\" : \"06bf8dd5a75d\",\n \"nickname\" : \"38ad2e427937\",\n \"name\" : \"faff4e211035\"\n}", "mode" : "raw" } }, "name" : "POST /users", "description" : { "content" : "Create a new user." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - user", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users", "host" : [ "{{BASE_URL}}" ], "path" : [ "users" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new user." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"92febee88a06\",\n \"password\" : \"06bf8dd5a75d\",\n \"nickname\" : \"38ad2e427937\",\n \"name\" : \"faff4e211035\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"0c7a304a932b\",\n \"email\" : \"4bf196670c42\",\n \"guid\" : \"f428f369-15f9-44a0-948e-3e0bfff41742\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.712Z\",\n \"created_by\" : {\n \"guid\" : \"b00c2b1e-884b-4c88-8c07-d4cb67dc978f\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.712Z\",\n \"updated_by\" : {\n \"guid\" : \"9ce0357c-2818-47a6-9df7-12b14d74dcba\"\n }\n },\n \"nickname\" : \"b5a170a2d8c4\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users", "host" : [ "{{BASE_URL}}" ], "path" : [ "users" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new user." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"92febee88a06\",\n \"password\" : \"06bf8dd5a75d\",\n \"nickname\" : \"38ad2e427937\",\n \"name\" : \"faff4e211035\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"5765f9da624b\",\n \"message\" : \"2c41cec0a6a2\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/users/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates information about the user with the specified guid." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"4be25f0c5771\",\n \"nickname\" : \"68430991bc0b\",\n \"name\" : \"3b45d91107d7\"\n}", "mode" : "raw" } }, "name" : "PUT /users/:guid", "description" : { "content" : "Updates information about the user with the specified guid." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - user", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates information about the user with the specified guid." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"4be25f0c5771\",\n \"nickname\" : \"68430991bc0b\",\n \"name\" : \"3b45d91107d7\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"b5b388d709b9\",\n \"email\" : \"7f6925300fed\",\n \"guid\" : \"b1eeb98e-06f2-4e5f-96bc-0946e36851dd\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.712Z\",\n \"created_by\" : {\n \"guid\" : \"d4a31289-ef4b-4d73-a26a-35817f75743c\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.712Z\",\n \"updated_by\" : {\n \"guid\" : \"48f731b0-72d3-4338-bcad-c57a845390e6\"\n }\n },\n \"nickname\" : \"847b3d9aed00\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "users", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates information about the user with the specified guid." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"email\" : \"4be25f0c5771\",\n \"nickname\" : \"68430991bc0b\",\n \"name\" : \"3b45d91107d7\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"6019866cb7f3\",\n \"message\" : \"eb685d3e842a\"\n} ]", "code" : 409 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "validations", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/validations", "host" : [ "{{BASE_URL}}" ], "path" : [ "validations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "\"a56c87f070bf\"", "mode" : "raw" } }, "name" : "POST /validations", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - validation", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/validations", "host" : [ "{{BASE_URL}}" ], "path" : [ "validations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "\"a56c87f070bf\"", "mode" : "raw" } }, "body" : "{\n \"valid\" : true,\n \"errors\" : [ ]\n}", "code" : 200 } ], "type" : "item" } ], "description" : { "content" : "Public resource that can accept JSON input and returns a validation object describing any validation errors." }, "type" : "folder" }, { "name" : "versions", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to search versions" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to search versions" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Search all versions of this application. Results are always paginated." }, "header" : [ ] }, "name" : "GET /:orgKey/:applicationKey", "description" : { "content" : "Search all versions of this application. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [version]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to search versions" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to search versions" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Search all versions of this application. Results are always paginated." }, "header" : [ ] }, "body" : "[ {\n \"guid\" : \"93ad585a-e678-4313-87a7-a28d106dd1b4\",\n \"service\" : {\n \"name\" : \"22a12fea3456\",\n \"description\" : \"9ebf1578e1cf\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"1427b8efc307\"\n },\n \"organization\" : {\n \"key\" : \"911f708e8e7e\"\n },\n \"info\" : {\n \"license\" : {\n \"name\" : \"MIT\",\n \"url\" : \"http://opensource.org/licenses/MIT\"\n },\n \"contact\" : {\n \"name\" : \"Michael Bryzek\",\n \"url\" : \"https://www.apibuilder.io\",\n \"email\" : \"michael@test.apibuilder.io\"\n }\n },\n \"attributes\" : [ ],\n \"base_url\" : \"c47922fdf310\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"9d2094f2-d5aa-4f3c-b5c5-012c64a91075\",\n \"key\" : \"1f974af44970\"\n },\n \"organization\" : {\n \"guid\" : \"3532725f-7652-4eb7-ad82-53ceb5e76673\",\n \"key\" : \"48d9e8a48998\"\n },\n \"original\" : {\n \"type\" : \"swagger\",\n \"data\" : \"8e324345f2da\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.712Z\",\n \"created_by\" : {\n \"guid\" : \"df022000-a7df-4f01-bf2a-a77f54c43354\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.712Z\",\n \"updated_by\" : {\n \"guid\" : \"250fbcc8-0ec9-4a99-8e3d-a77dd37f8606\"\n }\n }\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "latest", "description" : { "content" : "The version of tthis application to download, or the keyword latest to get the latest version" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Retrieve a specific version of an application." }, "header" : [ ] }, "name" : "GET /:orgKey/:applicationKey/:version", "description" : { "content" : "Retrieve a specific version of an application." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - version", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "latest", "description" : { "content" : "The version of tthis application to download, or the keyword latest to get the latest version" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Retrieve a specific version of an application." }, "header" : [ ] }, "body" : "{\n \"guid\" : \"5396ea14-ea03-4930-b636-15511a7f6319\",\n \"service\" : {\n \"name\" : \"f351ce0f7abe\",\n \"description\" : \"13f849402a5a\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"ac897cae2888\"\n },\n \"organization\" : {\n \"key\" : \"2dca37ae24fb\"\n },\n \"info\" : {\n \"license\" : {\n \"name\" : \"MIT\",\n \"url\" : \"http://opensource.org/licenses/MIT\"\n },\n \"contact\" : {\n \"name\" : \"Michael Bryzek\",\n \"url\" : \"https://www.apibuilder.io\",\n \"email\" : \"michael@test.apibuilder.io\"\n }\n },\n \"attributes\" : [ ],\n \"base_url\" : \"f8ec4d2c8e47\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"845e0065-1dd0-4306-ad89-5c3f945ecfe4\",\n \"key\" : \"93436e9d3ce5\"\n },\n \"organization\" : {\n \"guid\" : \"e130ffeb-92b5-4d19-8c8e-517104192890\",\n \"key\" : \"98b237de6bdc\"\n },\n \"original\" : {\n \"type\" : \"avro_idl\",\n \"data\" : \"d1d0fd86df25\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.712Z\",\n \"created_by\" : {\n \"guid\" : \"eabc81ff-70c6-4c38-a41b-68f5a3a9ae47\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.712Z\",\n \"updated_by\" : {\n \"guid\" : \"df2f26f7-19ca-4c06-a44e-a94aa9df5f68\"\n }\n }\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "latest", "description" : { "content" : "The version of tthis application to download, or the keyword latest to get the latest version" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Retrieve a specific version of an application." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create a new version for an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"service_json\",\n \"data\" : \"beffc1cf79d1\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "name" : "POST /:orgKey/:version", "description" : { "content" : "Create a new version for an application" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - version", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create a new version for an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"service_json\",\n \"data\" : \"beffc1cf79d1\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"61f20ef1-bde2-4d08-9a31-ef358a8429d3\",\n \"service\" : {\n \"name\" : \"5f895248b60c\",\n \"description\" : \"db49bd34ad0c\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"a4a65f8ef6d8\"\n },\n \"organization\" : {\n \"key\" : \"c48057678014\"\n },\n \"info\" : {\n \"license\" : {\n \"name\" : \"MIT\",\n \"url\" : \"http://opensource.org/licenses/MIT\"\n },\n \"contact\" : {\n \"name\" : \"Michael Bryzek\",\n \"url\" : \"https://www.apibuilder.io\",\n \"email\" : \"michael@test.apibuilder.io\"\n }\n },\n \"attributes\" : [ ],\n \"base_url\" : \"0aeb8d7a9865\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"7aa7b49b-4c0b-4a0b-8c00-046372c2bca5\",\n \"key\" : \"3b5f24efb396\"\n },\n \"organization\" : {\n \"guid\" : \"fb7749ca-c301-4490-b8b7-464c358d0b74\",\n \"key\" : \"1220918518ce\"\n },\n \"original\" : {\n \"type\" : \"api_json\",\n \"data\" : \"aada5882c3a2\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.712Z\",\n \"created_by\" : {\n \"guid\" : \"4301ec37-18bd-4b0a-97d5-056d74d94893\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.712Z\",\n \"updated_by\" : {\n \"guid\" : \"3f7ea15f-c424-48aa-832b-77361a29749c\"\n }\n }\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create a new version for an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"service_json\",\n \"data\" : \"beffc1cf79d1\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"c1b81dec479f\",\n \"message\" : \"20faa3515ff0\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Upsert a version of an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"api_json\",\n \"data\" : \"126dfa010ea5\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "name" : "PUT /:orgKey/:applicationKey/:version", "description" : { "content" : "Upsert a version of an application" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - version", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Upsert a version of an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"api_json\",\n \"data\" : \"126dfa010ea5\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"7afca1ce-4649-46d0-8e3a-750b9b33a036\",\n \"service\" : {\n \"name\" : \"46a7d045b3b6\",\n \"description\" : \"e3240a8e0da2\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"30a7e254b5da\"\n },\n \"organization\" : {\n \"key\" : \"30207faf1cfa\"\n },\n \"info\" : {\n \"license\" : {\n \"name\" : \"MIT\",\n \"url\" : \"http://opensource.org/licenses/MIT\"\n },\n \"contact\" : {\n \"name\" : \"Michael Bryzek\",\n \"url\" : \"https://www.apibuilder.io\",\n \"email\" : \"michael@test.apibuilder.io\"\n }\n },\n \"attributes\" : [ ],\n \"base_url\" : \"e61d4703926a\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"e2717b0a-d10b-4244-83a8-844d1a0f7e72\",\n \"key\" : \"36076efeef77\"\n },\n \"organization\" : {\n \"guid\" : \"e38fcf00-343f-4365-bf0c-8fc7f0546a42\",\n \"key\" : \"c5d040a0b883\"\n },\n \"original\" : {\n \"type\" : \"api_json\",\n \"data\" : \"caaf93531573\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.712Z\",\n \"created_by\" : {\n \"guid\" : \"4dba9073-b33e-42d9-ba7a-6e2dcef43240\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.712Z\",\n \"updated_by\" : {\n \"guid\" : \"6acee42e-927c-4752-9671-b20adf1a8332\"\n }\n }\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Upsert a version of an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"api_json\",\n \"data\" : \"126dfa010ea5\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"c4449e5f188c\",\n \"message\" : \"0f805e357074\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific version." }, "header" : [ ] }, "name" : "DELETE /:orgKey/:applicationKey/:version", "description" : { "content" : "Deletes a specific version." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific version." }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/example/:type_name", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", "example", ":type_name" ], "query" : [ { "key" : "optional_fields", "disabled" : true, "description" : { "content" : "If true, we generate sample data for all optional fields. Otherwise the generated sample will contain only required fields, where applicable" } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "latest", "description" : { "content" : "The version of tthis application to download, or the keyword latest to get the latest version" }, "disabled" : false }, { "key" : "type_name", "value" : "{{type_name}}", "description" : { "content" : "The name of the type (e.g. model name) for which you would like to generate a sample json document" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generates an example JSON document of the type with the specified name." }, "header" : [ ] }, "name" : "GET /:orgKey/:applicationKey/:version/example/:type_name", "description" : { "content" : "Generates an example JSON document of the type with the specified name." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - object", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/example/:type_name", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", "example", ":type_name" ], "query" : [ { "key" : "optional_fields", "disabled" : true, "description" : { "content" : "If true, we generate sample data for all optional fields. Otherwise the generated sample will contain only required fields, where applicable" } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "latest", "description" : { "content" : "The version of tthis application to download, or the keyword latest to get the latest version" }, "disabled" : false }, { "key" : "type_name", "value" : "{{type_name}}", "description" : { "content" : "The name of the type (e.g. model name) for which you would like to generate a sample json document" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generates an example JSON document of the type with the specified name." }, "header" : [ ] }, "body" : "{\n \"foo\" : \"bar\"\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/example/:type_name", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", "example", ":type_name" ], "query" : [ { "key" : "optional_fields", "disabled" : true, "description" : { "content" : "If true, we generate sample data for all optional fields. Otherwise the generated sample will contain only required fields, where applicable" } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "latest", "description" : { "content" : "The version of tthis application to download, or the keyword latest to get the latest version" }, "disabled" : false }, { "key" : "type_name", "value" : "{{type_name}}", "description" : { "content" : "The name of the type (e.g. model name) for which you would like to generate a sample json document" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generates an example JSON document of the type with the specified name." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "watches", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the watch with this guid." } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Find attributes for this user." } }, { "key" : "organization_key", "disabled" : true, "description" : { "content" : "Find attributes for this organization." } }, { "key" : "application_key", "disabled" : true, "description" : { "content" : "Find attributes for this application." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search attributes. Always paginated." }, "header" : [ ] }, "name" : "GET /watches", "description" : { "content" : "Search attributes. Always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [watch]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the watch with this guid." } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Find attributes for this user." } }, { "key" : "organization_key", "disabled" : true, "description" : { "content" : "Find attributes for this organization." } }, { "key" : "application_key", "disabled" : true, "description" : { "content" : "Find attributes for this application." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search attributes. Always paginated." }, "header" : [ ] }, "body" : "[ {\n \"guid\" : \"3830c4a0-a65a-4a39-9dd7-995672f93a71\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.712Z\",\n \"created_by\" : {\n \"guid\" : \"5e159314-639c-46ef-883a-9d68c2a6b02f\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.712Z\",\n \"updated_by\" : {\n \"guid\" : \"eaf970e0-8d99-4836-a2c9-4a9d14605863\"\n }\n },\n \"user\" : {\n \"name\" : \"9292b8c4b7c0\",\n \"email\" : \"92ea0c467845\",\n \"guid\" : \"a60c53a3-5a10-4402-9ebc-e374072a346d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.712Z\",\n \"created_by\" : {\n \"guid\" : \"68bf2fbf-5684-4fd7-b31f-66d788d5db13\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.712Z\",\n \"updated_by\" : {\n \"guid\" : \"75a9c7c8-e527-4bfc-a00b-1582d1b01578\"\n }\n },\n \"nickname\" : \"45aaa2128953\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"071e0725-2cbc-4218-8e27-83265629b2c5\",\n \"key\" : \"b63bb4813907\"\n },\n \"name\" : \"b26fa2e0eee9\",\n \"guid\" : \"fe9aebc4-95e9-40c5-b695-6fb0b11a666d\",\n \"description\" : \"dd9d53c2a0d2\",\n \"key\" : \"4b37941b6a2d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.712Z\",\n \"created_by\" : {\n \"guid\" : \"6b7de2d5-aba9-45cc-b7a4-31428f697735\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.712Z\",\n \"updated_by\" : {\n \"guid\" : \"4f202625-3380-4e31-873b-a483a6055191\"\n }\n },\n \"visibility\" : \"user\"\n },\n \"organization\" : {\n \"name\" : \"881ae1dc9933\",\n \"guid\" : \"6e86b427-f936-4ea6-8b8b-c69ef38db1bc\",\n \"domains\" : [ ],\n \"key\" : \"973bf4b9bc2d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.712Z\",\n \"created_by\" : {\n \"guid\" : \"7cb39cf2-1ece-4710-babf-231ef39b8c6c\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.712Z\",\n \"updated_by\" : {\n \"guid\" : \"ad780103-ee41-4f52-9c10-d2ab06285d4c\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n }\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific watch." }, "header" : [ ] }, "name" : "GET /watches/:guid", "description" : { "content" : "Returns information about a specific watch." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - watch", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific watch." }, "header" : [ ] }, "body" : "{\n \"guid\" : \"20b6fb90-bdc5-46ee-b5ea-0b045df1c068\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.713Z\",\n \"created_by\" : {\n \"guid\" : \"5e8f4616-42d1-4b4b-9f67-99a40d688d1e\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.713Z\",\n \"updated_by\" : {\n \"guid\" : \"6de9540a-2c00-4a29-873c-2bad3ff8fdd5\"\n }\n },\n \"user\" : {\n \"name\" : \"a060de34aeca\",\n \"email\" : \"165aad5ab799\",\n \"guid\" : \"7f1479b1-81c6-4a27-9c70-90035de8436d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.712Z\",\n \"created_by\" : {\n \"guid\" : \"26edfd03-a70b-4ce3-81f9-c6867cf95605\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.712Z\",\n \"updated_by\" : {\n \"guid\" : \"aa4246b3-1c3c-4ce6-ba23-98bb654f1877\"\n }\n },\n \"nickname\" : \"97589d01311f\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"9436e709-ca81-4406-809a-02b1ffc05988\",\n \"key\" : \"188cc59c8699\"\n },\n \"name\" : \"468e30e48319\",\n \"guid\" : \"c8f3df5a-2931-4891-827d-0b91300c98e4\",\n \"description\" : \"c1759fce3e8e\",\n \"key\" : \"f62015c1d4a1\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.713Z\",\n \"created_by\" : {\n \"guid\" : \"124f7929-e1a4-4f28-98b4-7ac2ca9e452b\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.713Z\",\n \"updated_by\" : {\n \"guid\" : \"c44f0051-8dd9-4613-a91c-38beed088881\"\n }\n },\n \"visibility\" : \"public\"\n },\n \"organization\" : {\n \"name\" : \"40217be3b232\",\n \"guid\" : \"38464dbd-82ee-4b95-a5da-0026967901e4\",\n \"domains\" : [ ],\n \"key\" : \"b957fa3d8fc7\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.713Z\",\n \"created_by\" : {\n \"guid\" : \"d7127318-5cb4-4123-9adb-53c4da494b52\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.713Z\",\n \"updated_by\" : {\n \"guid\" : \"ab0f1923-b4ac-4684-9dc2-7b7e88b7f67e\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n }\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific watch." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches/check", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", "check" ], "query" : [ { "key" : "user_guid", "disabled" : true, "description" : { "content" : "The user for which we are checking. API returns false if the user guid is not provided" } }, { "key" : "organization_key", "disabled" : false, "description" : { "content" : "Type: string | Required: true" } }, { "key" : "application_key", "disabled" : false, "description" : { "content" : "Type: string | Required: true" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Quick check if a user is watching a specific application." }, "header" : [ ] }, "name" : "GET /watches/check", "description" : { "content" : "Quick check if a user is watching a specific application." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - boolean", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches/check", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", "check" ], "query" : [ { "key" : "user_guid", "disabled" : true, "description" : { "content" : "The user for which we are checking. API returns false if the user guid is not provided" } }, { "key" : "organization_key", "disabled" : false, "description" : { "content" : "Type: string | Required: true" } }, { "key" : "application_key", "disabled" : false, "description" : { "content" : "Type: string | Required: true" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Quick check if a user is watching a specific application." }, "header" : [ ] }, "body" : "true", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new watch." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"b23848c0-835a-4126-b825-43be2673fe78\",\n \"organization_key\" : \"d946690b4c80\",\n \"application_key\" : \"fa71039a3fde\"\n}", "mode" : "raw" } }, "name" : "POST /watches", "description" : { "content" : "Create a new watch." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 201 - watch", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new watch." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"b23848c0-835a-4126-b825-43be2673fe78\",\n \"organization_key\" : \"d946690b4c80\",\n \"application_key\" : \"fa71039a3fde\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"53adc34c-58ea-4b77-a4e2-124b6ca7956e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.713Z\",\n \"created_by\" : {\n \"guid\" : \"f61cf5b4-b284-473e-94b2-b4d50b7be9ab\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.713Z\",\n \"updated_by\" : {\n \"guid\" : \"26cd74ce-e9ab-4151-bc1d-91f6ca4f854d\"\n }\n },\n \"user\" : {\n \"name\" : \"9d457cc73e45\",\n \"email\" : \"819d19b94f35\",\n \"guid\" : \"1d8bf7e3-e192-4e9e-91a7-acedd1e33d4f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.713Z\",\n \"created_by\" : {\n \"guid\" : \"cba05d97-0fa5-443e-b4e6-b6cc86a8c054\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.713Z\",\n \"updated_by\" : {\n \"guid\" : \"d54c2705-9263-450a-94bc-7857de1fc0f0\"\n }\n },\n \"nickname\" : \"28f805b2ffad\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"26817462-1504-4571-bd07-02bcd7896f2d\",\n \"key\" : \"96df9dc08f95\"\n },\n \"name\" : \"04bb9d504561\",\n \"guid\" : \"05668361-7251-4b8d-b837-d17eab584cc4\",\n \"description\" : \"86952374984d\",\n \"key\" : \"ddce5696ecb3\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.713Z\",\n \"created_by\" : {\n \"guid\" : \"819fb994-cfa7-437d-b8cc-8058ffa94075\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.713Z\",\n \"updated_by\" : {\n \"guid\" : \"c70536f6-361f-48db-9592-1b2a00a5013f\"\n }\n },\n \"visibility\" : \"organization\"\n },\n \"organization\" : {\n \"name\" : \"6b8af36791a0\",\n \"guid\" : \"282467ef-29cc-4122-b5a0-c27800c4b3d8\",\n \"domains\" : [ ],\n \"key\" : \"d47e1aa494b1\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T18:41:24.713Z\",\n \"created_by\" : {\n \"guid\" : \"bacd666e-1944-448b-856d-4dd9c903b8b1\"\n },\n \"updated_at\" : \"2026-10-17T18:41:24.713Z\",\n \"updated_by\" : {\n \"guid\" : \"09ede9f8-e6b9-493a-9944-a374a850ead2\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n }\n}", "code" : 201 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new watch." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"b23848c0-835a-4126-b825-43be2673fe78\",\n \"organization_key\" : \"d946690b4c80\",\n \"application_key\" : \"fa71039a3fde\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"42c0883e95d8\",\n \"message\" : \"a12b5097fd0e\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "name" : "DELETE /watches/:guid", "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" } ], "event" : [ ], "variable" : [ { "key" : "BASE_URL", "value" : "https://api.apibuilder.io", "type" : "string" } ] }