{ "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.14.3-46-g35788525" }, "item" : [ { "name" : "applications", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/metadata/:applicationKey/versions", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", "metadata", ":applicationKey", "versions" ], "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" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the versions assocoated with the specified application. The latest version is the first result returned." }, "header" : [ ] }, "name" : "GET /:orgKey/metadata/:applicationKey/versions", "description" : { "content" : "Returns the versions assocoated with the specified application. The latest version is the first result returned." }, "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_metadata_version]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/metadata/:applicationKey/versions", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", "metadata", ":applicationKey", "versions" ], "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" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the versions assocoated with the specified application. The latest version is the first result returned." }, "header" : [ ] }, "body" : "[ {\n \"version\" : \"0.2.5\"\n} ]", "code" : 200 }, { "name" : "Example 401 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/metadata/:applicationKey/versions", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", "metadata", ":applicationKey", "versions" ], "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" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the versions assocoated with the specified application. The latest version is the first result returned." }, "header" : [ ] }, "code" : 401 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/metadata/:applicationKey/versions", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", "metadata", ":applicationKey", "versions" ], "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" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the versions assocoated with the specified application. The latest version is the first result returned." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/metadata/:applicationKey/versions/latest.txt", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", "metadata", ":applicationKey", "versions", "latest.txt" ], "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" : "GET", "description" : { "content" : "Returns the latest version number as a string" }, "header" : [ ] }, "name" : "GET /:orgKey/metadata/:applicationKey/versions/latest.txt", "description" : { "content" : "Returns the latest version number as a string" }, "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 - string", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/metadata/:applicationKey/versions/latest.txt", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", "metadata", ":applicationKey", "versions", "latest.txt" ], "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" : "GET", "description" : { "content" : "Returns the latest version number as a string" }, "header" : [ ] }, "body" : "\"5bb8a6bc93d5\"", "code" : 200 }, { "name" : "Example 401 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/metadata/:applicationKey/versions/latest.txt", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", "metadata", ":applicationKey", "versions", "latest.txt" ], "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" : "GET", "description" : { "content" : "Returns the latest version number as a string" }, "header" : [ ] }, "code" : 401 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/metadata/:applicationKey/versions/latest.txt", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", "metadata", ":applicationKey", "versions", "latest.txt" ], "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" : "GET", "description" : { "content" : "Returns the latest version number as a string" }, "header" : [ ] }, "code" : 404 } ], "type" : "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." } }, { "key" : "sort_by", "disabled" : true, "description" : { "content" : "Type: app_sort_by | Required: false" } }, { "key" : "order", "disabled" : true, "description" : { "content" : "Type: sort_order | Required: false" } } ], "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." } }, { "key" : "sort_by", "disabled" : true, "description" : { "content" : "Type: app_sort_by | Required: false" } }, { "key" : "order", "disabled" : true, "description" : { "content" : "Type: sort_order | Required: false" } } ], "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\" : \"5da66c56-efd2-4149-a4e2-a8b3e2053281\",\n \"key\" : \"e885e715223d\"\n },\n \"name\" : \"4654af6fcc3c\",\n \"guid\" : \"0beb2ede-3f5c-4352-b2de-84cb825ba390\",\n \"description\" : \"1b4fe51fe9ff\",\n \"last_updated_at\" : \"2026-10-17T13:38:16.609Z\",\n \"key\" : \"580637b544d8\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.609Z\",\n \"created_by\" : {\n \"guid\" : \"af716ae0-8050-4bf9-a496-65eec75981c4\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.609Z\",\n \"updated_by\" : {\n \"guid\" : \"964c1504-5c3f-4927-902c-9f02f4956bab\"\n }\n },\n \"visibility\" : \"user\"\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\" : \"0f7615fb6e39\",\n \"key\" : \"c5045833c7e4\",\n \"description\" : \"2c195a10309e\",\n \"visibility\" : \"user\"\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\" : \"0f7615fb6e39\",\n \"key\" : \"c5045833c7e4\",\n \"description\" : \"2c195a10309e\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"1bf110b4-b1a9-485c-8339-68c1e6d4efc0\",\n \"key\" : \"8f66966ddee0\"\n },\n \"name\" : \"f641049fb785\",\n \"guid\" : \"07512ac7-d590-4cd2-8c35-974e34454d79\",\n \"description\" : \"e632dedd2edf\",\n \"last_updated_at\" : \"2026-10-17T13:38:16.609Z\",\n \"key\" : \"29d62c5665b4\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.609Z\",\n \"created_by\" : {\n \"guid\" : \"eab488c9-96f4-44b8-9ed9-04d372cf5077\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.609Z\",\n \"updated_by\" : {\n \"guid\" : \"9e5ae32c-d6ee-44ab-a3b3-28aaafa57070\"\n }\n },\n \"visibility\" : \"public\"\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\" : \"0f7615fb6e39\",\n \"key\" : \"c5045833c7e4\",\n \"description\" : \"2c195a10309e\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"bd1a9229ae7a\",\n \"message\" : \"eb625588a6db\"\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\" : \"2c4dbf197c97\",\n \"key\" : \"0a49376465b9\",\n \"description\" : \"81d06720b899\",\n \"visibility\" : \"organization\"\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\" : \"2c4dbf197c97\",\n \"key\" : \"0a49376465b9\",\n \"description\" : \"81d06720b899\",\n \"visibility\" : \"organization\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"a48786c3-e1b6-4e37-a91f-f69f2d7736c9\",\n \"key\" : \"b8ecbe7a7b8d\"\n },\n \"name\" : \"11faf94fd6b7\",\n \"guid\" : \"4e96ac08-978e-40a6-9bd0-21841550ad02\",\n \"description\" : \"525f77f38192\",\n \"last_updated_at\" : \"2026-10-17T13:38:16.609Z\",\n \"key\" : \"6836d9c3c029\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.609Z\",\n \"created_by\" : {\n \"guid\" : \"8501e121-35c1-4cf3-a175-26974a31789e\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.609Z\",\n \"updated_by\" : {\n \"guid\" : \"bb90c369-c72b-49df-bcaf-1f30e02f6454\"\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\" : \"2c4dbf197c97\",\n \"key\" : \"0a49376465b9\",\n \"description\" : \"81d06720b899\",\n \"visibility\" : \"organization\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"84636fa4f055\",\n \"message\" : \"88a08cd6efb6\"\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 }, { "name" : "Example 401 - 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" : 401 }, { "name" : "Example 404 - 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" : 404 } ], "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\" : \"95d77a7d918b\"\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\" : \"95d77a7d918b\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"4bede7e5-e79f-4573-a120-4a5b5b616013\",\n \"key\" : \"33fe6d092f72\"\n },\n \"name\" : \"bfd5653fb040\",\n \"guid\" : \"e528246a-1a00-4ae1-8008-9943ca8f7f52\",\n \"description\" : \"bb464f905d35\",\n \"last_updated_at\" : \"2026-10-17T13:38:16.609Z\",\n \"key\" : \"09775e4f9c8e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.609Z\",\n \"created_by\" : {\n \"guid\" : \"527f7446-e9f9-4fe4-ae4b-b90940923d90\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.609Z\",\n \"updated_by\" : {\n \"guid\" : \"48faec4e-bf5d-4ab2-a219-82f7a14112ab\"\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\" : \"95d77a7d918b\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"dbea95fee5cc\",\n \"message\" : \"2733be6fd251\"\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\" : \"82071430-e8f4-4f63-979f-a52ce8e04934\",\n \"name\" : \"de87c22a5bb4\",\n \"description\" : \"87e7ff8e3d2d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"ae36d986-48ca-4ac1-9acb-9516f636e50b\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"b31f817d-6da7-4a3a-8f0f-66580ad7017c\"\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\" : \"2aaf638a-b1d4-4355-88d1-3b0e6d8b72e4\",\n \"name\" : \"b71a361eef3c\",\n \"description\" : \"d9fd07a30882\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"8f61bff5-4b44-4000-acec-cb19a6d42dde\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"2be6c10c-48c1-4025-93b9-d8a20dc94172\"\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\" : \"d30101dc7ef4\",\n \"description\" : \"61a24f15035b\"\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\" : \"d30101dc7ef4\",\n \"description\" : \"61a24f15035b\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"d7667e87-783e-4027-ad28-6ce0e5e46f4f\",\n \"name\" : \"b4d301403ed8\",\n \"description\" : \"f62f585dcdf2\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"f821954f-d021-47b5-afa1-493d23fc9c36\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"12bd7b6a-dacf-49ca-9451-39232334cf72\"\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\" : \"d30101dc7ef4\",\n \"description\" : \"61a24f15035b\"\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\" : \"d30101dc7ef4\",\n \"description\" : \"61a24f15035b\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"c9a01fdda9de\",\n \"message\" : \"a623f7bfccc9\"\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\" : \"31c60f2091ee\",\n \"email\" : \"54f2cf953436\",\n \"guid\" : \"e71c5b09-22f2-4d6d-a994-908aaa5a1831\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"ec988bb6-75d9-4be3-b62e-d51a7bf19120\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"30816464-af93-4b68-8132-02ce4fbf0aec\"\n }\n },\n \"nickname\" : \"92155f4a1ee5\"\n },\n \"session\" : {\n \"id\" : \"52d3a2a7ccaf\",\n \"expires_at\" : \"2026-10-17T13:38:16.610Z\"\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-17T13:38:16.610Z\",\n \"changed_by\" : {\n \"guid\" : \"4399512d-ca0b-4e6e-a486-826e7241465a\",\n \"nickname\" : \"4464d2b4f645\"\n },\n \"diff\" : {\n \"type\" : \"diff_breaking\",\n \"description\" : \"model removed: user\"\n },\n \"from_version\" : {\n \"guid\" : \"e3187f4a-bb99-4d6a-a13f-c9a1c0b5434c\",\n \"version\" : \"a7500b9932f5\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"922b1b85-6911-4c45-bd3b-1fa65a22a7f6\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"33bf3b7b-ca83-4a3d-abdd-2bcfd6df1290\"\n }\n },\n \"application\" : {\n \"guid\" : \"c1d0683f-69f8-47e6-ba64-78e8fd3c1aa7\",\n \"key\" : \"ac28d506ddab\"\n },\n \"organization\" : {\n \"guid\" : \"16800f1b-931f-4b48-a9b1-fee523ab70d2\",\n \"key\" : \"14f346d9d155\"\n },\n \"guid\" : \"a40868e1-7435-4f1a-91b3-1d3aefd01c7b\",\n \"to_version\" : {\n \"guid\" : \"065876ef-cc5e-48e4-bbb4-06bbdd9d50d6\",\n \"version\" : \"48ae5aba6891\"\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\" : \"1f62d91c-6581-44a4-9166-d0b5615409e4\",\n \"uri\" : \"092633dca050\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"dd057ae9-e37f-4dae-ada8-4256dec1929f\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"880498f4-f3ca-48c3-9bf8-1220292dcbcc\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"cc31340e488c\",\n \"description\" : \"d5bbefea0958\",\n \"attributes\" : [ ],\n \"key\" : \"5844fb6c399e\",\n \"language\" : \"scala\"\n }\n },\n \"source\" : \"4cb0c39daec3\",\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\" : \"fb1044b13726\",\n \"message\" : \"ebfce6305ee8\"\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\" : \"005ea68ed801\",\n \"message\" : \"c96be51a5c08\"\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 }, { "name" : "Example 401 - 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" : 401 }, { "name" : "Example 404 - 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" : 404 } ], "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\" : \"d4f8815f997a\"\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\" : \"d4f8815f997a\"\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\" : \"d4f8815f997a\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"46e93337b563\",\n \"message\" : \"6a7c2f56231d\"\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\" : \"a152b547-8c40-4d07-b181-c77a2360fd15\",\n \"uri\" : \"3678e32859c6\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"34618be7-046d-43c2-8dcb-960cc32423c5\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"c5b7de52-ce0d-48b4-af27-1d73aa4cd07c\"\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\" : \"301176f4-25c9-4bbf-b268-efa425632dc3\",\n \"uri\" : \"8078d9f6f436\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"fb027400-42f8-403a-a97b-351f1129f31c\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"43e7b592-7b7d-4969-9a25-10cb987de70d\"\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\" : \"f275cbf250dc\"\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\" : \"f275cbf250dc\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"0dbb527c-5981-419f-84dd-f727a1cc8c28\",\n \"uri\" : \"1b9875531867\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"f2d215f7-c98e-4fa7-a2a2-97512b661d8d\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"6bd6fb57-1abe-47dd-9a38-ca00b9ec5a1b\"\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\" : \"f275cbf250dc\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"4fd4233c85fe\",\n \"message\" : \"848cd39bff01\"\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 401 - 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" : 401 }, { "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 } ], "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\" : \"ad6526c7-c641-47f3-ba90-f419dbac178c\",\n \"uri\" : \"3342f59566fb\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"159a2903-5f18-4207-9640-60eb92aabb5b\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"8491157b-5b62-4ebf-ab4c-f6ea6e35e2ab\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"a4d23ea001a6\",\n \"description\" : \"925cb5ec1987\",\n \"attributes\" : [ ],\n \"key\" : \"d90cb3043cf8\",\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\" : \"fe33b8bf-ac6f-48a3-a8c1-c002abd7c45a\",\n \"uri\" : \"50942150aa1b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"98200973-07a6-4ce2-9d85-43e0211cbd4c\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"f6d5521b-1f60-42d9-8303-429cfd33af9d\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"abd738f838cd\",\n \"description\" : \"23f33b2a5bf7\",\n \"attributes\" : [ ],\n \"key\" : \"f4c9bb42e63f\",\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\" : \"8cdfe0b02cad\"\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\" : \"1b9d1c0e-f05e-4abd-83d0-48099c11a635\",\n \"detail\" : {\n \"type\" : \"application_summary\",\n \"guid\" : \"3a998fca-1632-4c33-b9b5-77434d2fd71a\",\n \"organization\" : {\n \"guid\" : \"7ad57477-fd32-4179-a284-1cdd50b8038d\",\n \"key\" : \"2b12a0233c4b\"\n },\n \"key\" : \"d43cf69436f7\"\n },\n \"label\" : \"4a08db0f3cb6\",\n \"description\" : \"7c3ec9f71c91\"\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\" : \"9126fc57-6164-4e8e-a49c-f526b5944057\",\n \"detail\" : {\n \"type\" : \"application_summary\",\n \"guid\" : \"2b6b22d5-412f-45d7-92ca-ba5965a39130\",\n \"organization\" : {\n \"guid\" : \"a392cc08-98e1-486b-8b63-4e007bf06aa4\",\n \"key\" : \"7dde2ceb014c\"\n },\n \"key\" : \"10c2d5356217\"\n },\n \"label\" : \"fea78de2717c\",\n \"description\" : \"974659f49de2\"\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\" : \"4c91dd42296a\",\n \"guid\" : \"126e59ff-b774-496b-9f3f-2f80bdb86690\",\n \"domains\" : [ ],\n \"key\" : \"cd9a3a8a8a14\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"102f7e77-53dc-40c4-8fbc-71baa9d16fad\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"7cea30a8-99c6-4ab6-bf86-3208bd5e1f1b\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"31730bcb-c8a2-4b25-8464-3f6906cfd088\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"50c88ffa-7894-4f1c-b254-c12d60e05010\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"a53109b6-a7d0-4ef6-8823-9814d130f74f\"\n }\n },\n \"user\" : {\n \"name\" : \"2adc0f393690\",\n \"email\" : \"2130cfdc9e84\",\n \"guid\" : \"5ace9db5-c244-4cbf-aa2e-7686261c84c3\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"1fbf1cfa-d9c9-4062-9aae-b51f8ecc0e75\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"95d2375b-093b-428e-a63e-ccfae640d1af\"\n }\n },\n \"nickname\" : \"e5fe6ba4e1a4\"\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\" : \"27a7808c745d\",\n \"guid\" : \"e9f51e64-6690-45ea-adc1-bdb373c84d22\",\n \"domains\" : [ ],\n \"key\" : \"95f0801c866a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"71b35fc3-edae-4623-a6c1-89d8cafa8aee\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"4f2875d1-d250-4e0d-928d-34bcc417b190\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"471a2f36-b956-44cf-8697-01e8622dbb6a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"01a8b283-de79-475f-958d-5a2db0c3c212\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"8c1974db-759e-4cd6-855b-6cc549cafde1\"\n }\n },\n \"user\" : {\n \"name\" : \"b1cf4dd63670\",\n \"email\" : \"7c723806541e\",\n \"guid\" : \"9ad10a19-69ab-4f3e-905b-ec8e3b05dec7\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"5ec7da38-d5d5-49a4-b3a7-6258458df2bb\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"c1f61324-f69a-4736-846d-d84539f08c4c\"\n }\n },\n \"nickname\" : \"b18e5680fd91\"\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 }, { "name" : "Example 401 - 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" : 401 }, { "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" : "DELETE", "header" : [ ] }, "code" : 404 } ], "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\" : \"c3142123058c\",\n \"guid\" : \"92f7c275-165b-47e6-8ab9-068a5721a70d\",\n \"domains\" : [ ],\n \"key\" : \"416de5b8c192\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"7c53a823-69b5-4491-b3ce-d3c9b3d8ecf6\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"b4e8863d-777d-40f5-990e-6f76fd38dece\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"726e1266-4389-4336-9286-06c913f74b54\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"ac942f70-5bf2-4497-b552-32761742938c\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"5f12926f-1c9f-42d3-99ac-5a8bd300e760\"\n }\n },\n \"user\" : {\n \"name\" : \"d7394dbbdb36\",\n \"email\" : \"b7264589e942\",\n \"guid\" : \"6e23a2aa-4809-4556-ae97-2b8dbab305c7\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.610Z\",\n \"created_by\" : {\n \"guid\" : \"ae079051-93e5-454b-92f3-5f8921efad34\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.610Z\",\n \"updated_by\" : {\n \"guid\" : \"96d0bf0b-d2c8-424b-a4da-42e331da1bac\"\n }\n },\n \"nickname\" : \"d100b9f460f5\"\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\" : \"e7f50c662bc4\",\n \"guid\" : \"1315ddfe-80b1-4305-93d4-a99f47906717\",\n \"domains\" : [ ],\n \"key\" : \"f2a3a6c3599f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"0adeec2e-01a9-42b4-8f47-0d195b58af97\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"30a13b8d-0c4b-4e2d-b0dd-487f2e094f2e\"\n }\n },\n \"visibility\" : \"user\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"a24ff594-b158-4d56-aac1-1c1a1772f6f7\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"ee47c864-20be-48e3-90d6-103e93454e54\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"a1b40dd2-078d-4a80-9329-c9de02104a79\"\n }\n },\n \"user\" : {\n \"name\" : \"cf20b7fcf264\",\n \"email\" : \"d3abdbb01c5a\",\n \"guid\" : \"c1e0f576-807f-4e46-a80d-e89c8ee9d68e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"b57934c4-86d3-437f-9011-82c7476c8044\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"7de140f2-19b4-4d1c-9e98-51edb136b012\"\n }\n },\n \"nickname\" : \"871bff047bd6\"\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\" : \"f49087998c76\",\n \"message\" : \"e1c97695286d\"\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\" : \"bed547aa2ea5\",\n \"message\" : \"ef6b31bbd6d6\"\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\" : \"1e46649ef750\",\n \"message\" : \"93f78bfb1870\"\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\" : \"82eb7e880e45\",\n \"guid\" : \"69b758ca-f783-4344-873e-8b26ed36f810\",\n \"domains\" : [ ],\n \"key\" : \"0c42200b8ee4\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"c9a86839-89f2-4365-8257-39fc554bf666\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"4ca9cb9a-7f7c-481e-a2cc-4d209be85f62\"\n }\n },\n \"visibility\" : \"organization\",\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\" : \"f1cd89b410ff\",\n \"guid\" : \"04a344e5-474b-4da4-9c5c-20a0ca8c9844\",\n \"domains\" : [ ],\n \"key\" : \"18cc148b4e99\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"36337fe4-6c6a-45be-978f-2f79aea27e4f\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"f4fe0bf0-fe4c-4854-bfb5-893002950e35\"\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\" : \"070bf8508180\",\n \"domains\" : [ \"8ed2cf1f1d25\" ],\n \"key\" : \"1bd6f6664c0c\",\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\" : \"070bf8508180\",\n \"domains\" : [ \"8ed2cf1f1d25\" ],\n \"key\" : \"1bd6f6664c0c\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"862a739cb5e4\",\n \"guid\" : \"ca52e1be-f00d-47e0-9f18-a8095be1cb51\",\n \"domains\" : [ ],\n \"key\" : \"b6c982414b6e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"1e9d959a-b701-47d9-b3b5-7f3af0442c89\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"41515c8e-e07f-47ee-b67c-de0116525a06\"\n }\n },\n \"visibility\" : \"public\",\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\" : \"070bf8508180\",\n \"domains\" : [ \"8ed2cf1f1d25\" ],\n \"key\" : \"1bd6f6664c0c\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"a52608be70a4\",\n \"message\" : \"bea72208ff7a\"\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\" : \"75f18bb02c68\",\n \"domains\" : [ \"a8c0b2f3ad6e\" ],\n \"key\" : \"fde843897fb9\",\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\" : \"75f18bb02c68\",\n \"domains\" : [ \"a8c0b2f3ad6e\" ],\n \"key\" : \"fde843897fb9\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"aa8719ea6e7d\",\n \"guid\" : \"3c75159d-19a9-4d14-ac78-4892acd3badc\",\n \"domains\" : [ ],\n \"key\" : \"f1bc4f877ddc\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"45d586ca-2590-437b-aa71-fe391eb8342d\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"2e784b3c-7701-4954-a66f-91149a872b6a\"\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\" : \"75f18bb02c68\",\n \"domains\" : [ \"a8c0b2f3ad6e\" ],\n \"key\" : \"fde843897fb9\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"8bb306232da3\",\n \"message\" : \"0c287be886da\"\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 }, { "name" : "Example 401 - 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" : 401 }, { "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" : "DELETE", "description" : { "content" : "Deletes an organization and all of its associated applications." }, "header" : [ ] }, "code" : 404 } ], "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\" : \"7fea08cf-e302-48fb-97ba-06ac952c80fa\",\n \"attribute\" : {\n \"guid\" : \"dcc76e7e-9497-408a-80be-49acd00fde97\",\n \"name\" : \"eb332d3f6c27\"\n },\n \"value\" : \"7abe3fb05d66\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"aad913b1-c891-40d8-8fcf-cc021c2be552\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"c04d9ef7-dfab-4791-b7cf-5deaf3f381a2\"\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\" : \"6f9e8719-6c27-4325-97d5-0ff587e19f30\",\n \"attribute\" : {\n \"guid\" : \"052eac4a-ee4e-48b1-945f-fc2a1f649927\",\n \"name\" : \"2a14fad25b5a\"\n },\n \"value\" : \"9e07b906a669\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"513685f1-ba26-4e42-be18-f3906848cfa1\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"632a113f-dd7c-4f4f-97a3-174ef27f6345\"\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\" : \"796b6c31d7b5\"\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\" : \"796b6c31d7b5\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"aae835ed-36b5-46e3-8963-48186dd3dd8c\",\n \"attribute\" : {\n \"guid\" : \"e31b9987-8203-4d46-bdf8-05c404556472\",\n \"name\" : \"2b035702c317\"\n },\n \"value\" : \"bdcc22e43dc0\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"11eecb2b-3a0d-440e-9f69-d9324d1f4007\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"f69a012e-7209-4331-b446-dcde1eb9dd83\"\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\" : \"796b6c31d7b5\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"9078c287-a94b-4813-a78c-604fb25b485f\",\n \"attribute\" : {\n \"guid\" : \"7071170e-feff-4ef5-a2af-445162d4a800\",\n \"name\" : \"d305fa560cdf\"\n },\n \"value\" : \"a80fe72ef5d5\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"06c2693f-a9f9-4d94-8cf1-bb0904486c8d\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"6217e934-9ade-47e0-ba7e-f6e486fbd9aa\"\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\" : \"796b6c31d7b5\"\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\" : \"796b6c31d7b5\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"d44a91f50977\",\n \"message\" : \"69b71f594efb\"\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\" : \"c1f617327d63\",\n \"password\" : \"2abe0b648c8a\"\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\" : \"c1f617327d63\",\n \"password\" : \"2abe0b648c8a\"\n}", "mode" : "raw" } }, "body" : "{\n \"user\" : {\n \"name\" : \"23f9c4835c9e\",\n \"email\" : \"0a571e78f24b\",\n \"guid\" : \"33e44ac9-79aa-4803-a461-2759793fe748\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"2ac7f503-3ec0-4525-bba7-7f92a60e86df\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"f5c5e90c-b65a-48e4-b1f7-2c2c7d782edf\"\n }\n },\n \"nickname\" : \"7ec3e4c7f3ba\"\n },\n \"session\" : {\n \"id\" : \"ce20adb86c38\",\n \"expires_at\" : \"2026-10-17T13:38:16.611Z\"\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\" : \"c1f617327d63\",\n \"password\" : \"2abe0b648c8a\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"d1dfcc196c98\",\n \"message\" : \"a893a4c894e1\"\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\" : \"72e12990337f\"\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\" : \"72e12990337f\"\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\" : \"72e12990337f\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"ab7157f165f7\",\n \"message\" : \"07ecb7d4303d\"\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\" : \"9801436ee09e\",\n \"guid\" : \"662ac295-0558-449d-a3e7-ba1dd7a5ce62\",\n \"domains\" : [ ],\n \"key\" : \"4566fc533b88\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"b55580c9-0ff3-485f-850a-005e46940a12\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"383ac452-5e99-45b0-8a00-91a84b186a8e\"\n }\n },\n \"visibility\" : \"user\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"6bc57f14-b1c3-4d9d-a0f5-2b432dbe013b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"d70fc447-3312-4729-9809-0fa3a0be6163\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"2959d2aa-bc23-40cb-a2ff-450bd97a7c20\"\n }\n },\n \"publication\" : \"memberships.create\",\n \"user\" : {\n \"name\" : \"adb9b065bbfa\",\n \"email\" : \"03048c1db7ed\",\n \"guid\" : \"ddca77df-ca07-4562-be3a-bf7321da7111\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"064fc55a-6b0f-49e9-96e8-441bc771e555\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"2710f5b5-b855-4747-83b3-bc0bd6a8362d\"\n }\n },\n \"nickname\" : \"66063f6527ab\"\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\" : \"0a6b697a7991\",\n \"guid\" : \"b716ae32-4f51-42c6-97f3-5000eec12b5c\",\n \"domains\" : [ ],\n \"key\" : \"a741a9fda230\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"5d1d2a8e-6ccb-4619-a3ea-b04731cc432e\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"030611f6-8d2b-4e87-ad8b-df86a59d3ee7\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"6dacc968-a4f5-46ee-807a-582f77a5578c\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"52b39c1f-912a-46d1-b39e-f409d5633644\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"6ed453fc-c6ea-4af0-8301-0ab7c7797488\"\n }\n },\n \"publication\" : \"memberships.create\",\n \"user\" : {\n \"name\" : \"1f79c3ff1e46\",\n \"email\" : \"d9d38e003375\",\n \"guid\" : \"e912d0b9-d6c4-4f66-8bf6-0c04825f76fd\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"acd90adc-0cb2-4e1c-999a-38bd724cfb94\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"8fa4425c-1ef6-41e7-9671-cd2f7f5b906e\"\n }\n },\n \"nickname\" : \"5a04c810ba6a\"\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\" : \"aefb111fc5e9\",\n \"user_guid\" : \"217f1ba5-e0d3-4a1e-a5a6-fbbb22de2792\",\n \"publication\" : \"memberships.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\" : \"aefb111fc5e9\",\n \"user_guid\" : \"217f1ba5-e0d3-4a1e-a5a6-fbbb22de2792\",\n \"publication\" : \"memberships.create\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"name\" : \"6563bde805de\",\n \"guid\" : \"45be0aa5-6bf9-4639-bbbf-b354d667f7ff\",\n \"domains\" : [ ],\n \"key\" : \"e7ee157e063e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.611Z\",\n \"created_by\" : {\n \"guid\" : \"dc1b1652-6dfb-4f73-b2d2-d7b01762a261\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.611Z\",\n \"updated_by\" : {\n \"guid\" : \"ccc81fe2-97ba-4463-a8a3-d900b70ebe0c\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"2127dcfd-1eef-4c84-b2e5-a4302dbeca04\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"a5f5ab3c-e0ce-463a-9912-e5693c956843\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"58a3cbe2-c378-45a4-b264-72997acf547c\"\n }\n },\n \"publication\" : \"membership_requests.create\",\n \"user\" : {\n \"name\" : \"1c36aefd7efe\",\n \"email\" : \"4866a27119ba\",\n \"guid\" : \"c21463b7-bf46-482a-b823-d3e4c0c1b8f2\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"8c465141-34f6-4913-929e-0aa95dd54739\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"ebedd3d2-c0b2-420f-8d1a-cda1fb4ccffd\"\n }\n },\n \"nickname\" : \"cde43864534b\"\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\" : \"aefb111fc5e9\",\n \"user_guid\" : \"217f1ba5-e0d3-4a1e-a5a6-fbbb22de2792\",\n \"publication\" : \"memberships.create\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"d2e88ace6954\",\n \"message\" : \"e4de17287d0b\"\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 }, { "name" : "Example 401 - 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" : 401 }, { "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" : "DELETE", "header" : [ ] }, "code" : 404 } ], "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\" : \"7447449b-bcb9-4a34-885a-b78c5851c21d\",\n \"description\" : \"e9c44013b903\",\n \"masked_token\" : \"8515ab9841ac\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"8ff06171-e7f2-4e64-92c6-22e581c1c0b9\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"ef2b8dc3-c6b3-4a7a-9a55-0ef4bfd04570\"\n }\n },\n \"user\" : {\n \"name\" : \"d191a31684bd\",\n \"email\" : \"58c017cd73b6\",\n \"guid\" : \"61e5a45d-b209-43ba-bde7-eacbb3538245\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"e31eaf00-bcab-48e2-9fda-afa6b28d6024\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"ad3e0220-0e2e-476d-8978-7da24c9b7471\"\n }\n },\n \"nickname\" : \"767707c66824\"\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\" : \"ff02bfde7ad7\"\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\" : \"38924f2b-51cc-4b34-8b59-519bc04f5308\",\n \"description\" : \"bf74806ca92a\"\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\" : \"38924f2b-51cc-4b34-8b59-519bc04f5308\",\n \"description\" : \"bf74806ca92a\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"533ea94b-b09e-415c-a99b-ecfe0f3b9652\",\n \"description\" : \"bb4950b11246\",\n \"masked_token\" : \"7b5441d88cc8\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"d79350ca-db2a-4f95-9610-8667b10bccd4\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"939bb688-97ce-46bc-9b58-19dbf24f730c\"\n }\n },\n \"user\" : {\n \"name\" : \"10affd665762\",\n \"email\" : \"08a80dca2fc1\",\n \"guid\" : \"9f03c9f9-a680-4858-831c-b37979274a0b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"75544011-fb6c-4518-9931-decbdc38bf76\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"e8c30949-bace-4cc3-90c6-37ad13fa731c\"\n }\n },\n \"nickname\" : \"a10000fe119a\"\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\" : \"38924f2b-51cc-4b34-8b59-519bc04f5308\",\n \"description\" : \"bf74806ca92a\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"b9c58faadd76\",\n \"message\" : \"349eac2ca3f5\"\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 }, { "name" : "Example 401 - 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" : 401 }, { "name" : "Example 404 - 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" : 404 } ], "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" : "nickname", "disabled" : true, "description" : { "content" : "Find user with the specified nickname. For users that register via GitHub, this will be their GitHub username. 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" : "nickname", "disabled" : true, "description" : { "content" : "Find user with the specified nickname. For users that register via GitHub, this will be their GitHub username. 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\" : \"a88ab240704c\",\n \"email\" : \"1d7596e07bf3\",\n \"guid\" : \"d203fd65-0e8c-416b-a7c5-7246c02fb70b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"fd3589e1-56b4-43f0-9496-d97f94ebca1d\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"753fc513-6907-4cfa-8408-924e37861fc6\"\n }\n },\n \"nickname\" : \"9fe29fa4dbb2\"\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\" : \"48530e1ce196\",\n \"email\" : \"2a0688b4d7d2\",\n \"guid\" : \"b506ddc8-5c9a-4270-a529-215b619df4b7\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"37260b3f-fd2f-4836-b20e-1235deaa7eae\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"c07864c9-5798-4a82-b6f9-2f42721c6bf7\"\n }\n },\n \"nickname\" : \"4600403880bf\"\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\" : \"0763e20a1489\",\n \"email\" : \"537b0ce92b1e\",\n \"guid\" : \"b8acba9a-853a-4958-831c-c500be6e6cc5\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"3a89b30c-e754-48cc-b346-ea003a064661\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"5ef94019-4f19-4b86-921f-5985ce0ca07b\"\n }\n },\n \"nickname\" : \"3a3734b48816\"\n },\n \"session\" : {\n \"id\" : \"3c01b4aea023\",\n \"expires_at\" : \"2026-10-17T13:38:16.612Z\"\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\" : \"face4d3d4b09\",\n \"message\" : \"0dccb7719e4d\"\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\" : \"64ed6cba7a45\",\n \"email\" : \"41c2eeaf4827\",\n \"guid\" : \"836716c4-f93f-49cc-8bf1-d373e1eb865d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"e974234e-9c4c-44ad-969c-a5748b1fad9c\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"7bd89e56-ad69-47fe-a32d-c0f62332be94\"\n }\n },\n \"nickname\" : \"b2ee19d93092\"\n },\n \"session\" : {\n \"id\" : \"2f4ada65e131\",\n \"expires_at\" : \"2026-10-17T13:38:16.612Z\"\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\" : \"c3db58f0ffa1\",\n \"message\" : \"8376922d15cb\"\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\" : \"61fd9dffabb4\",\n \"password\" : \"24a99d72530f\",\n \"nickname\" : \"83e8e2149648\",\n \"name\" : \"8ba09b57b8cc\"\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\" : \"61fd9dffabb4\",\n \"password\" : \"24a99d72530f\",\n \"nickname\" : \"83e8e2149648\",\n \"name\" : \"8ba09b57b8cc\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"eea0f43b0b26\",\n \"email\" : \"6f1d9b892275\",\n \"guid\" : \"b8556958-038b-48e4-b56f-fb139930a909\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"506f4f74-9caa-487b-96a4-85a1aaf8e835\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"a34b88da-f398-42d5-828e-f76d321587d6\"\n }\n },\n \"nickname\" : \"6b4866a8e833\"\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\" : \"61fd9dffabb4\",\n \"password\" : \"24a99d72530f\",\n \"nickname\" : \"83e8e2149648\",\n \"name\" : \"8ba09b57b8cc\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"4ef2e8d474cf\",\n \"message\" : \"c3baf8bf74b8\"\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\" : \"ab50ae5a767d\",\n \"nickname\" : \"41ee34e2145f\",\n \"name\" : \"25d3de36684f\"\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\" : \"ab50ae5a767d\",\n \"nickname\" : \"41ee34e2145f\",\n \"name\" : \"25d3de36684f\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"2e32c25ddb13\",\n \"email\" : \"8fe17671bc30\",\n \"guid\" : \"15cd3122-382a-47b6-b7ec-4ea7e162186c\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"7ee17a3a-e9f4-49bf-939a-f8703da454ba\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"d955ddfc-afd3-42bc-ab58-ea49ab54a172\"\n }\n },\n \"nickname\" : \"ca68861b23ba\"\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\" : \"ab50ae5a767d\",\n \"nickname\" : \"41ee34e2145f\",\n \"name\" : \"25d3de36684f\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"1259cb0a3dea\",\n \"message\" : \"aedab29f6e66\"\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" : "\"d2f8cac750f9\"", "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" : "\"d2f8cac750f9\"", "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\" : \"6ea9a676-e88f-4cec-942d-5879bf57b45e\",\n \"service\" : {\n \"name\" : \"16cbe2b0cf64\",\n \"description\" : \"3ad82a12ab5f\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"44587245ce32\"\n },\n \"organization\" : {\n \"key\" : \"cd4141dd8d21\"\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\" : \"f4181af49866\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"038cbe66-4eee-4e3c-882a-463f0021e500\",\n \"key\" : \"a2bcea511bb7\"\n },\n \"organization\" : {\n \"guid\" : \"99a21b0c-1283-4046-b3f1-5c45708a0e18\",\n \"key\" : \"b1a0e16684ab\"\n },\n \"original\" : {\n \"type\" : \"api_json\",\n \"data\" : \"4415b1765aa0\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"7b0b1b35-3522-45d9-9b1a-48acddb28169\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"3aa6eaab-d7a5-42ef-9629-52e7135e9180\"\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\" : \"570dcf33-d990-42bf-96b2-beb443d401fd\",\n \"service\" : {\n \"name\" : \"a9b9711556bf\",\n \"description\" : \"9d19ba3cbb9d\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"5473f36e7715\"\n },\n \"organization\" : {\n \"key\" : \"83682037791e\"\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\" : \"48f7f4fee477\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"e5ec4c7e-d883-4a40-9ba3-039a9e6e81d8\",\n \"key\" : \"6a122d209517\"\n },\n \"organization\" : {\n \"guid\" : \"90b4cb62-c310-4ee2-b196-f06056578a6f\",\n \"key\" : \"f3d7d35921ab\"\n },\n \"original\" : {\n \"type\" : \"swagger\",\n \"data\" : \"5223027634d7\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"953f3835-cf1a-423b-8864-d542d3dc227f\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"d0293cf9-904f-4c73-b306-08b4d2671bf3\"\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\" : \"api_json\",\n \"data\" : \"999e742cda35\"\n },\n \"visibility\" : \"user\"\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\" : \"api_json\",\n \"data\" : \"999e742cda35\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"bbc546a9-175d-4dce-9860-a664b46665f4\",\n \"service\" : {\n \"name\" : \"77529eb6b19c\",\n \"description\" : \"069d3b76c147\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"e2079d8730b9\"\n },\n \"organization\" : {\n \"key\" : \"d8bab907b4ca\"\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\" : \"692fe2ebfa95\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"98d106e9-e5af-4637-a64f-7cc4b2c251cc\",\n \"key\" : \"00b694a035e3\"\n },\n \"organization\" : {\n \"guid\" : \"d7163d81-3b2b-44e6-9c3c-f572a34dfe8c\",\n \"key\" : \"16c22df2166f\"\n },\n \"original\" : {\n \"type\" : \"swagger\",\n \"data\" : \"1de8673f47a7\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"01223437-67e7-4aa4-9757-7c6561eca34d\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"78dff575-3569-4f02-8cd7-ee74b4d6cc0e\"\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\" : \"api_json\",\n \"data\" : \"999e742cda35\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"9e40ade3f60f\",\n \"message\" : \"11f6eaa000b8\"\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\" : \"eceef04c0f1c\"\n },\n \"visibility\" : \"organization\"\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\" : \"eceef04c0f1c\"\n },\n \"visibility\" : \"organization\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"fa41f2c6-89ce-4ce4-a680-48d119cb822e\",\n \"service\" : {\n \"name\" : \"4f1bb4ccb3ae\",\n \"description\" : \"05b310573763\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"a8d4cc74c241\"\n },\n \"organization\" : {\n \"key\" : \"3c1ae62f387c\"\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\" : \"eb938cf7be84\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"7efff211-eeb8-4d33-b70c-0566f52581b5\",\n \"key\" : \"7b4ca401bb8d\"\n },\n \"organization\" : {\n \"guid\" : \"8ea8315c-6e70-4a55-89e5-4393583e90dd\",\n \"key\" : \"aea335985330\"\n },\n \"original\" : {\n \"type\" : \"swagger\",\n \"data\" : \"a4028bb68054\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.612Z\",\n \"created_by\" : {\n \"guid\" : \"09693770-e102-4e2a-9454-618dd8232aca\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.612Z\",\n \"updated_by\" : {\n \"guid\" : \"b1117a33-0657-460f-8053-0f027acf1b16\"\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\" : \"eceef04c0f1c\"\n },\n \"visibility\" : \"organization\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"11e33a72ec6e\",\n \"message\" : \"b67965f5d745\"\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 }, { "name" : "Example 401 - 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" : 401 }, { "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" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific version." }, "header" : [ ] }, "code" : 404 } ], "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" : "sub_type_name", "disabled" : true, "description" : { "content" : "The name of the sub-type for which you would like to generate a sample json document, e.g. a specific type of a union" } }, { "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 this 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" : "sub_type_name", "disabled" : true, "description" : { "content" : "The name of the sub-type for which you would like to generate a sample json document, e.g. a specific type of a union" } }, { "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 this 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" : "sub_type_name", "disabled" : true, "description" : { "content" : "The name of the sub-type for which you would like to generate a sample json document, e.g. a specific type of a union" } }, { "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 this 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\" : \"addc7d19-89cb-43ec-a364-6a9a96e96ceb\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.613Z\",\n \"created_by\" : {\n \"guid\" : \"bfbf7666-c6c1-4a1f-a755-a0a907a2d7ba\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"updated_by\" : {\n \"guid\" : \"282d4bd9-ff01-4ad7-902a-4724b35062c1\"\n }\n },\n \"user\" : {\n \"name\" : \"c48ec658c28f\",\n \"email\" : \"52f01ecc70e8\",\n \"guid\" : \"25e8a7d6-4512-425e-b01c-582e58cea435\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.613Z\",\n \"created_by\" : {\n \"guid\" : \"640060f3-5ce9-40db-9f14-104c6b8c4a82\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"updated_by\" : {\n \"guid\" : \"d2df76f6-febc-4972-a3a7-2139738a0db8\"\n }\n },\n \"nickname\" : \"eada14493e3c\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"e4820ac5-d1e7-44f0-8229-11e649bfdc50\",\n \"key\" : \"6db6c5317626\"\n },\n \"name\" : \"15b40524b20d\",\n \"guid\" : \"574697fb-7e8b-442c-9948-35d043a1cec1\",\n \"description\" : \"d7f3ac0c861d\",\n \"last_updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"key\" : \"a18f4216945c\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.613Z\",\n \"created_by\" : {\n \"guid\" : \"0e2b266b-d45a-480b-bce7-005d41869a2e\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"updated_by\" : {\n \"guid\" : \"9d9728b9-b4ca-4055-bb92-c1e77ff098b7\"\n }\n },\n \"visibility\" : \"user\"\n },\n \"organization\" : {\n \"name\" : \"05c72540f651\",\n \"guid\" : \"0494d906-b364-4e66-9d2b-56cbcc292cad\",\n \"domains\" : [ ],\n \"key\" : \"0b65215da3f3\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.613Z\",\n \"created_by\" : {\n \"guid\" : \"9f45dc48-4452-4736-b02b-697ad4f3606d\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"updated_by\" : {\n \"guid\" : \"2d83c75c-c838-4dfb-856b-85a6daba5c4b\"\n }\n },\n \"visibility\" : \"user\",\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\" : \"55aa3ee6-ea60-4713-aa8d-9ae1fb049941\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.613Z\",\n \"created_by\" : {\n \"guid\" : \"4b5cb46f-74dc-4115-98d2-14304f91bb88\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"updated_by\" : {\n \"guid\" : \"5b52f5ff-9f6a-498b-9519-06abe72c2951\"\n }\n },\n \"user\" : {\n \"name\" : \"ef1fc4a2326d\",\n \"email\" : \"4f4b533edebb\",\n \"guid\" : \"31d10b17-22e0-445e-9005-cea0c608fa46\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.613Z\",\n \"created_by\" : {\n \"guid\" : \"2dcf19e3-7479-4b30-a6b8-3fdf4e875663\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"updated_by\" : {\n \"guid\" : \"2293f67c-9d39-4c9e-9d88-c04c0eaf5648\"\n }\n },\n \"nickname\" : \"fec9caa8ff80\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"f3a07125-06a8-416c-bcc5-59da3b4b17cc\",\n \"key\" : \"54563ddfd9f6\"\n },\n \"name\" : \"9256ea23be67\",\n \"guid\" : \"a717550c-e5b5-4576-9042-c2a170e0c9eb\",\n \"description\" : \"b002f6bef3ed\",\n \"last_updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"key\" : \"737a01e66975\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.613Z\",\n \"created_by\" : {\n \"guid\" : \"bae625ec-344b-490c-bc9f-5aa1e8991a83\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"updated_by\" : {\n \"guid\" : \"df080e90-4f1e-4208-92d3-1966208afca7\"\n }\n },\n \"visibility\" : \"user\"\n },\n \"organization\" : {\n \"name\" : \"dcd641e51244\",\n \"guid\" : \"158e16c1-d5a3-45c6-9c94-a4bc71063625\",\n \"domains\" : [ ],\n \"key\" : \"46c05049ede0\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.613Z\",\n \"created_by\" : {\n \"guid\" : \"b2ba89b1-dee8-4773-8976-0bca3c22d76b\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"updated_by\" : {\n \"guid\" : \"982ddf76-f76b-43d3-97b4-2a2ed683133e\"\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\" : \"ac69dc20-c358-41cd-95be-baabc5d57c4b\",\n \"organization_key\" : \"a0a6489d2a27\",\n \"application_key\" : \"1ec6dca27493\"\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\" : \"ac69dc20-c358-41cd-95be-baabc5d57c4b\",\n \"organization_key\" : \"a0a6489d2a27\",\n \"application_key\" : \"1ec6dca27493\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"75bd39d2-8661-4fab-9b93-0da6aaaf8010\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.613Z\",\n \"created_by\" : {\n \"guid\" : \"f362d44c-5bd0-4386-b6f2-058b5374a97a\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"updated_by\" : {\n \"guid\" : \"44b940d6-57d0-4169-bdad-0511ea5459b6\"\n }\n },\n \"user\" : {\n \"name\" : \"5bb64d0d5fe9\",\n \"email\" : \"c75402f14330\",\n \"guid\" : \"5f3b8e67-aa21-4de1-a9fa-570a20e65710\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.613Z\",\n \"created_by\" : {\n \"guid\" : \"ed505993-170c-46ac-b442-04e4631e00ac\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"updated_by\" : {\n \"guid\" : \"d60e0508-bd30-47fb-a1ed-16c19b350f6e\"\n }\n },\n \"nickname\" : \"99b2db1cec03\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"8522c46d-e408-416f-b2ec-f1a2003763a4\",\n \"key\" : \"96e69462d332\"\n },\n \"name\" : \"cbfb83485739\",\n \"guid\" : \"e83a0609-a3d4-4ed5-a92c-6c1e05ef6c8d\",\n \"description\" : \"2e64855b5bbb\",\n \"last_updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"key\" : \"5a2c02bc9eef\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.613Z\",\n \"created_by\" : {\n \"guid\" : \"6bacdde3-1cf7-4ba9-bff3-238d52bac791\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"updated_by\" : {\n \"guid\" : \"f173102d-2957-4979-8c94-454e18624d87\"\n }\n },\n \"visibility\" : \"public\"\n },\n \"organization\" : {\n \"name\" : \"ac7b85305b17\",\n \"guid\" : \"2ff02ad2-2fba-4713-a95b-4b820888f17a\",\n \"domains\" : [ ],\n \"key\" : \"b9a93b39a7bf\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T13:38:16.613Z\",\n \"created_by\" : {\n \"guid\" : \"90bddcfc-56c1-432d-ac6b-a79c95d9fe6d\"\n },\n \"updated_at\" : \"2026-10-17T13:38:16.613Z\",\n \"updated_by\" : {\n \"guid\" : \"6158c4d8-e070-49da-b1a8-91b076f2ef71\"\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\" : \"ac69dc20-c358-41cd-95be-baabc5d57c4b\",\n \"organization_key\" : \"a0a6489d2a27\",\n \"application_key\" : \"1ec6dca27493\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"58a0ae40c87e\",\n \"message\" : \"763723212bc0\"\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 }, { "name" : "Example 401 - 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" : 401 }, { "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" : "DELETE", "header" : [ ] }, "code" : 404 } ], "type" : "item" } ], "type" : "folder" } ], "event" : [ ], "variable" : [ { "key" : "BASE_URL", "value" : "https://api.apibuilder.io", "type" : "string" } ] }