{ "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.0.1-dev" }, "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" : "\"756abd647df9\"", "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\" : \"5acfcc50-a3f7-473b-8ac2-cd492f4ce7ef\",\n \"key\" : \"81d4d9b19da2\"\n },\n \"name\" : \"feb56c0cba8e\",\n \"guid\" : \"f64b0e5f-852d-4f8c-9325-94af9f85cc6b\",\n \"description\" : \"c2e5f3ebad16\",\n \"last_updated_at\" : \"2026-10-17T09:10:25.147Z\",\n \"key\" : \"1ca98bfca370\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.147Z\",\n \"created_by\" : {\n \"guid\" : \"d293396e-c85a-4a54-b21d-6902fbbd4e1b\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.147Z\",\n \"updated_by\" : {\n \"guid\" : \"0347d5fd-e0a1-4902-b719-68d6df43cf76\"\n }\n },\n \"visibility\" : \"organization\"\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\" : \"ff261e2d0a3e\",\n \"key\" : \"16163e168caf\",\n \"description\" : \"5f01066ee9b9\",\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\" : \"ff261e2d0a3e\",\n \"key\" : \"16163e168caf\",\n \"description\" : \"5f01066ee9b9\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"ce01c862-65d7-456f-b86e-17d51cb148c3\",\n \"key\" : \"0e3800e03d1f\"\n },\n \"name\" : \"cff07a989c63\",\n \"guid\" : \"20c92a3f-cee6-4ea5-8616-53ad04f2109b\",\n \"description\" : \"4acdfe5cece7\",\n \"last_updated_at\" : \"2026-10-17T09:10:25.147Z\",\n \"key\" : \"08b572379fb6\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.147Z\",\n \"created_by\" : {\n \"guid\" : \"70e2fa0e-07c6-4ec6-82ac-a3d7a29ed1c7\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.147Z\",\n \"updated_by\" : {\n \"guid\" : \"a45f6eca-89ee-416f-9afb-12bd67e82e32\"\n }\n },\n \"visibility\" : \"user\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"ff261e2d0a3e\",\n \"key\" : \"16163e168caf\",\n \"description\" : \"5f01066ee9b9\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"fa1cdbbaa585\",\n \"message\" : \"3c9ca693f035\"\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\" : \"11ebc234ce4a\",\n \"key\" : \"6512d9c0fb90\",\n \"description\" : \"0adcbc4c7686\",\n \"visibility\" : \"public\"\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\" : \"11ebc234ce4a\",\n \"key\" : \"6512d9c0fb90\",\n \"description\" : \"0adcbc4c7686\",\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"0a45173e-9217-4ab7-b81b-29cb241d1773\",\n \"key\" : \"a1b0771e9565\"\n },\n \"name\" : \"af744c167d57\",\n \"guid\" : \"ad20bbdf-2bfd-4869-a4c5-eeedac0822d1\",\n \"description\" : \"f6e37a042278\",\n \"last_updated_at\" : \"2026-10-17T09:10:25.148Z\",\n \"key\" : \"8493abf0844f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.148Z\",\n \"created_by\" : {\n \"guid\" : \"a41221ef-c846-454e-b1f5-8e8f7765466d\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.148Z\",\n \"updated_by\" : {\n \"guid\" : \"ea4a0adf-c09b-4412-badb-02bafada2607\"\n }\n },\n \"visibility\" : \"organization\"\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\" : \"11ebc234ce4a\",\n \"key\" : \"6512d9c0fb90\",\n \"description\" : \"0adcbc4c7686\",\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"deea1543ef0f\",\n \"message\" : \"fd2747e55023\"\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\" : \"c1bc1e3cc4a7\"\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\" : \"c1bc1e3cc4a7\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"8bfd4b96-1ffe-4375-9b9f-004ef50f8b12\",\n \"key\" : \"935a66811527\"\n },\n \"name\" : \"a38860a9a7b7\",\n \"guid\" : \"6f4d09f2-9105-44e5-a005-e643355e0542\",\n \"description\" : \"067d76fb3fae\",\n \"last_updated_at\" : \"2026-10-17T09:10:25.148Z\",\n \"key\" : \"070769842c94\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.148Z\",\n \"created_by\" : {\n \"guid\" : \"1884a54d-a918-4193-acd7-85910dd578de\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.148Z\",\n \"updated_by\" : {\n \"guid\" : \"34dc0fca-63b4-424f-9c0e-0d34e4aeaf43\"\n }\n },\n \"visibility\" : \"organization\"\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\" : \"c1bc1e3cc4a7\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"5fc295b68972\",\n \"message\" : \"d4a5e2fc02b2\"\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\" : \"bf838c3b-8ee2-4b4d-ba1c-610bd7075817\",\n \"name\" : \"17acab5f4e92\",\n \"description\" : \"9edd3b7f8d3e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.148Z\",\n \"created_by\" : {\n \"guid\" : \"b25a5bd3-3fe0-473a-83e3-54ccb921da8f\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.148Z\",\n \"updated_by\" : {\n \"guid\" : \"65f67469-dc84-4193-bb06-a446ed4e91fb\"\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\" : \"23162aa1-2799-4202-97e8-5de9b66026e6\",\n \"name\" : \"73089f3cb316\",\n \"description\" : \"c08e4cce0b8e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.148Z\",\n \"created_by\" : {\n \"guid\" : \"752151fa-a794-4e46-a433-04a5e0feb8ad\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.148Z\",\n \"updated_by\" : {\n \"guid\" : \"bdb4fde6-4c95-4d50-99a7-0a78305c7fb3\"\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\" : \"86a931a278bb\",\n \"description\" : \"e164c39a6a1f\"\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\" : \"86a931a278bb\",\n \"description\" : \"e164c39a6a1f\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"d52e01f2-e1c4-4461-97d9-12b3d7a86167\",\n \"name\" : \"7951be33d68a\",\n \"description\" : \"1eb49c011b51\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.148Z\",\n \"created_by\" : {\n \"guid\" : \"7956efa4-1393-4e88-b5ef-3ad4cd564b98\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.148Z\",\n \"updated_by\" : {\n \"guid\" : \"99228458-cb37-4142-ab49-89b3d86b7f11\"\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\" : \"86a931a278bb\",\n \"description\" : \"e164c39a6a1f\"\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\" : \"86a931a278bb\",\n \"description\" : \"e164c39a6a1f\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"27817f7a5f4b\",\n \"message\" : \"6d3af45876f0\"\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\" : \"1fd1917c160f\",\n \"email\" : \"4d000ecc7f93\",\n \"guid\" : \"9d99821f-9616-4987-9a54-c8f2d12eba8f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.148Z\",\n \"created_by\" : {\n \"guid\" : \"1c027394-98a9-4eb5-93be-7df62698051c\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.148Z\",\n \"updated_by\" : {\n \"guid\" : \"de77b616-64d9-418a-a2db-4326f70e84c2\"\n }\n },\n \"nickname\" : \"416774a77539\"\n },\n \"session\" : {\n \"id\" : \"9702c11fde0a\",\n \"expires_at\" : \"2026-10-17T09:10:25.148Z\"\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-17T09:10:25.148Z\",\n \"changed_by\" : {\n \"guid\" : \"d6c99683-285b-45ca-b267-3edd855f997c\",\n \"nickname\" : \"8922c69e3c85\"\n },\n \"diff\" : {\n \"type\" : \"diff_breaking\",\n \"description\" : \"model removed: user\"\n },\n \"from_version\" : {\n \"guid\" : \"6ed987ef-9887-4ca1-9f71-032e53fc5d8f\",\n \"version\" : \"74f0bd996c21\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.148Z\",\n \"created_by\" : {\n \"guid\" : \"997eef4a-14c9-408f-a333-5267265ab2c1\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.148Z\",\n \"updated_by\" : {\n \"guid\" : \"5661d026-0424-4b3d-a894-30096b7ebaac\"\n }\n },\n \"application\" : {\n \"guid\" : \"e327cb6a-33cc-4e19-a20b-c9afb3fa9e17\",\n \"key\" : \"8f328a76ce57\"\n },\n \"organization\" : {\n \"guid\" : \"3a88fb45-bdb7-47f3-974d-107767ba8b74\",\n \"key\" : \"97f1789520cb\"\n },\n \"guid\" : \"698bc014-26cf-4b9c-af4e-9f564a384494\",\n \"to_version\" : {\n \"guid\" : \"5e61e38b-2840-44e2-be4c-7cf68d0c6dc4\",\n \"version\" : \"c4ff02fcbc8f\"\n }\n} ]", "code" : 200 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "code", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/form", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", "form" ], "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" : "POST", "description" : { "content" : "Create an invocation form. This is useful primarily for debugging when you want to see exactly what content is being forwarded to the generator" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"attributes\" : [ {\n \"name\" : \"8bcfa61cea34\",\n \"value\" : \"2749766bab2b\"\n } ]\n}", "mode" : "raw" } }, "name" : "POST /:orgKey/:applicationKey/:version/form", "description" : { "content" : "Create an invocation form. This is useful primarily for debugging when you want to see exactly what content is being forwarded to the generator" }, "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 - invocation_form", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/form", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", "form" ], "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" : "POST", "description" : { "content" : "Create an invocation form. This is useful primarily for debugging when you want to see exactly what content is being forwarded to the generator" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"attributes\" : [ {\n \"name\" : \"8bcfa61cea34\",\n \"value\" : \"2749766bab2b\"\n } ]\n}", "mode" : "raw" } }, "body" : "{\n \"service\" : {\n \"name\" : \"740d182272e3\",\n \"description\" : \"046cfb5536b9\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"5f4da8da06bf\"\n },\n \"organization\" : {\n \"key\" : \"755e7c8da6d9\"\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\" : \"f832efe19ec8\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"attributes\" : [ ],\n \"user_agent\" : \"143a04941b62\",\n \"imported_services\" : [ {\n \"name\" : \"f07f3abc2fcf\",\n \"description\" : \"690314a2470f\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"939b06183ab2\"\n },\n \"organization\" : {\n \"key\" : \"74c2cd9167b5\"\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\" : \"c87b0ea35e05\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n } ]\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/form", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", "form" ], "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" : "POST", "description" : { "content" : "Create an invocation form. This is useful primarily for debugging when you want to see exactly what content is being forwarded to the generator" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"attributes\" : [ {\n \"name\" : \"8bcfa61cea34\",\n \"value\" : \"2749766bab2b\"\n } ]\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"2e4c98afa99b\",\n \"message\" : \"fed6c729524c\"\n} ]", "code" : 409 } ], "type" : "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\" : \"01963140-2488-494b-a0c1-5fd1347255be\",\n \"uri\" : \"d3bd1b77247f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.149Z\",\n \"created_by\" : {\n \"guid\" : \"18e3368c-2cb1-4952-b22e-badd04027e5c\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.149Z\",\n \"updated_by\" : {\n \"guid\" : \"1c6c7194-862f-4e54-a892-23d2574c2032\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"ea925690c950\",\n \"description\" : \"71058850ca38\",\n \"attributes\" : [ ],\n \"key\" : \"b3e85aecd110\",\n \"language\" : \"scala\"\n }\n },\n \"source\" : \"62d0dad92af8\",\n \"files\" : [ ]\n}", "code" : 200 }, { "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\" : \"3b89bc428c0e\",\n \"message\" : \"c7575a76be07\"\n} ]", "code" : 409 } ], "type" : "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" : "POST", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"attributes\" : [ {\n \"name\" : \"97965ae97359\",\n \"value\" : \"6308bc6d463a\"\n } ]\n}", "mode" : "raw" } }, "name" : "POST /:orgKey/:applicationKey/:version/:generatorKey", "description" : { "content" : "Generate code for a specific version of 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 - 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" : "POST", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"attributes\" : [ {\n \"name\" : \"97965ae97359\",\n \"value\" : \"6308bc6d463a\"\n } ]\n}", "mode" : "raw" } }, "body" : "{\n \"generator\" : {\n \"service\" : {\n \"guid\" : \"2efc194e-e44d-41e4-951b-6e4e02b05ee3\",\n \"uri\" : \"f0567494de7f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.149Z\",\n \"created_by\" : {\n \"guid\" : \"a460a9e0-22e2-4ffd-b99e-a31e24054db6\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.149Z\",\n \"updated_by\" : {\n \"guid\" : \"b15ccb61-53ad-4e68-ac73-f7c243266f0d\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"4249c35b38db\",\n \"description\" : \"069ee8f540ad\",\n \"attributes\" : [ ],\n \"key\" : \"7e179806583b\",\n \"language\" : \"scala\"\n }\n },\n \"source\" : \"aeb0896802ce\",\n \"files\" : [ ]\n}", "code" : 200 }, { "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" : "POST", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"attributes\" : [ {\n \"name\" : \"97965ae97359\",\n \"value\" : \"6308bc6d463a\"\n } ]\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"2ef33153bb73\",\n \"message\" : \"ae917b5f31d4\"\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\" : \"e9a9a5137173\",\n \"message\" : \"521abf3b7fbb\"\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\" : \"b37611f44f7b\"\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\" : \"b37611f44f7b\"\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\" : \"b37611f44f7b\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"888a763a587d\",\n \"message\" : \"53967bf3fa5c\"\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\" : \"9c6e61ba-3b36-4ae8-ab0c-149713e418e2\",\n \"uri\" : \"cdff29a629c1\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.149Z\",\n \"created_by\" : {\n \"guid\" : \"61a50a9e-41c1-43bb-8e0c-a5f3f83ea606\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.150Z\",\n \"updated_by\" : {\n \"guid\" : \"db6915e1-0118-42ed-84a7-88cf78242162\"\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\" : \"249bbd76-e757-466f-8897-208e76930249\",\n \"uri\" : \"019d074c431b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.150Z\",\n \"created_by\" : {\n \"guid\" : \"d5769d16-6e54-4f89-a874-df3f72f7913b\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.150Z\",\n \"updated_by\" : {\n \"guid\" : \"dc2954a5-ca7a-4eae-bbd2-8ee8dc49f331\"\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\" : \"9a55cd241cdf\"\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\" : \"9a55cd241cdf\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"4c4202bf-965b-4f2d-b8a9-143244b614a6\",\n \"uri\" : \"8deb3e1f34c3\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.150Z\",\n \"created_by\" : {\n \"guid\" : \"0d14c162-c62f-4abd-b47a-644d5a19cec7\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.150Z\",\n \"updated_by\" : {\n \"guid\" : \"4a7aac24-7cf3-4ea6-ba0d-5a12fb8d5d10\"\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\" : \"9a55cd241cdf\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"e137b837e689\",\n \"message\" : \"6bd8ddd5ec3a\"\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\" : \"0519d59f-c826-4fab-8cc4-8028e1f1d8a0\",\n \"uri\" : \"b83b25bd3fdc\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.150Z\",\n \"created_by\" : {\n \"guid\" : \"8dc59372-3aa4-417f-b76b-c53817f1f37b\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.150Z\",\n \"updated_by\" : {\n \"guid\" : \"b12a393a-1f80-41ab-b9ec-a2917f5e8575\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"093df1bddcfe\",\n \"description\" : \"ef9d02b2533e\",\n \"attributes\" : [ ],\n \"key\" : \"c6462a234e5d\",\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\" : \"80c3665f-b22c-455d-942b-9c346d05a3e0\",\n \"uri\" : \"9dc03f6e078e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.150Z\",\n \"created_by\" : {\n \"guid\" : \"9cd2d9d6-d92a-46af-91b2-4f51ce867744\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.150Z\",\n \"updated_by\" : {\n \"guid\" : \"842d8fec-8512-4d77-977d-9380cd5e1680\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"ecf666b287dd\",\n \"description\" : \"d35b437d35a5\",\n \"attributes\" : [ ],\n \"key\" : \"2941f2f8e259\",\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\" : \"60831886e3e9\"\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\" : \"f23aba0a-3deb-43c3-8646-c663025c9564\",\n \"detail\" : {\n \"type\" : \"application_summary\",\n \"guid\" : \"de0c4837-1094-473a-9dad-536d27d68240\",\n \"organization\" : {\n \"guid\" : \"088faf2e-a177-44ba-98cd-b1f1fa5ba111\",\n \"key\" : \"1fb647ae8487\"\n },\n \"key\" : \"2e85c44a82d6\"\n },\n \"label\" : \"fe34839f98b4\",\n \"description\" : \"8db8ad01b383\"\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\" : \"bdd40c73-2c53-4be8-ac5d-a9d3b3e5d0e4\",\n \"detail\" : {\n \"type\" : \"application_summary\",\n \"guid\" : \"49f3fef5-296a-478f-99e8-0fe0af2decb9\",\n \"organization\" : {\n \"guid\" : \"d315e182-24ea-4795-bcf9-7ae3afe0f3ae\",\n \"key\" : \"42ee0bab57b3\"\n },\n \"key\" : \"5929f24401a7\"\n },\n \"label\" : \"edd06682d326\",\n \"description\" : \"9d513adebc85\"\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\" : \"2ffa17e694ad\",\n \"guid\" : \"313f5c6b-39aa-484d-b9da-d26619ef0d46\",\n \"domains\" : [ ],\n \"key\" : \"68a552d442f2\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.151Z\",\n \"created_by\" : {\n \"guid\" : \"50493fda-32a4-4ab4-9801-d721c1d855c1\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.151Z\",\n \"updated_by\" : {\n \"guid\" : \"d37e8a3e-32a3-4324-a936-5f18001b48f0\"\n }\n },\n \"visibility\" : \"user\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"f4a76773-3d53-40d5-8947-98fe79f774f9\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.151Z\",\n \"created_by\" : {\n \"guid\" : \"47b57cdd-32bb-4a21-acd2-a7da1b7c97ea\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.151Z\",\n \"updated_by\" : {\n \"guid\" : \"e6ade911-74ed-44df-a250-017da24cd02d\"\n }\n },\n \"user\" : {\n \"name\" : \"12b76aad5871\",\n \"email\" : \"3355b43edba0\",\n \"guid\" : \"8c6ccd0f-a007-43a7-bf55-48b71ad3a613\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.151Z\",\n \"created_by\" : {\n \"guid\" : \"15606aa6-f35d-4d20-92c7-0d1ee5c4ec4a\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.151Z\",\n \"updated_by\" : {\n \"guid\" : \"e25f9bc5-7cca-4c84-9377-75b6cbdfd4d6\"\n }\n },\n \"nickname\" : \"865250bbad65\"\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\" : \"a5117c184e9b\",\n \"guid\" : \"531f205d-d86a-4232-b6f3-a2732d3a4dc9\",\n \"domains\" : [ ],\n \"key\" : \"375ae49b0aae\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.151Z\",\n \"created_by\" : {\n \"guid\" : \"37c871e0-4b88-4f32-a8b2-74075db2aecd\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.151Z\",\n \"updated_by\" : {\n \"guid\" : \"922a19df-1d58-4b79-9bca-b12d9d92b416\"\n }\n },\n \"visibility\" : \"user\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"8a7b3264-4af1-4c06-8cf5-7cc9b3dcd485\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.151Z\",\n \"created_by\" : {\n \"guid\" : \"8c36ff9b-3b19-4b6a-9461-79a944de42eb\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.151Z\",\n \"updated_by\" : {\n \"guid\" : \"ca5ff961-58c1-4d48-aaac-14d23846f5f5\"\n }\n },\n \"user\" : {\n \"name\" : \"9e6d2dbee1e3\",\n \"email\" : \"3f7d87d10a37\",\n \"guid\" : \"9281ea45-f8aa-4803-ae59-c4615ab2d457\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.151Z\",\n \"created_by\" : {\n \"guid\" : \"a9353178-be5c-4ea3-86b2-cd48458c4e7a\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.151Z\",\n \"updated_by\" : {\n \"guid\" : \"2e9b5305-f40d-47b9-9333-1891f46d880c\"\n }\n },\n \"nickname\" : \"3a502f3448df\"\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\" : \"22e0b025f81e\",\n \"guid\" : \"4f64e20d-8422-4046-9b29-888cfa23e6b6\",\n \"domains\" : [ ],\n \"key\" : \"479c2a3a3d09\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.152Z\",\n \"created_by\" : {\n \"guid\" : \"dda6246f-6355-4032-837d-3d80a6e163ee\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.152Z\",\n \"updated_by\" : {\n \"guid\" : \"772f7b98-e4e0-467e-985b-10dbc762461f\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"6f4ea874-cde5-40d8-9163-c23ba0bf067f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.152Z\",\n \"created_by\" : {\n \"guid\" : \"ee2a0dac-4f25-4e54-820d-35c085f821c0\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.152Z\",\n \"updated_by\" : {\n \"guid\" : \"e3759832-8fe6-489e-9ea2-b22324d24369\"\n }\n },\n \"user\" : {\n \"name\" : \"9f7c2101248e\",\n \"email\" : \"dc18889e9465\",\n \"guid\" : \"a30c9d24-a7fc-4ee9-bc98-0a6b3b729e0a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.151Z\",\n \"created_by\" : {\n \"guid\" : \"6de3bacd-af07-4508-bfdc-7e4118c74b7f\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.151Z\",\n \"updated_by\" : {\n \"guid\" : \"49f4eab5-69b2-4410-864b-24bb6dbe3a45\"\n }\n },\n \"nickname\" : \"76b588728429\"\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\" : \"c7a894e119be\",\n \"guid\" : \"d7e2f0e8-aadb-4a69-952c-3d0520a89d46\",\n \"domains\" : [ ],\n \"key\" : \"29c60213e330\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.152Z\",\n \"created_by\" : {\n \"guid\" : \"ca8fd40c-ccac-43c9-afbc-b31e67b537be\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.152Z\",\n \"updated_by\" : {\n \"guid\" : \"1b8d769b-af34-4b7b-ac88-c18bec0c785e\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"18e76367-51b8-449f-8c3a-3104cf3de54b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.152Z\",\n \"created_by\" : {\n \"guid\" : \"44c585fd-3b88-4d49-ac5e-cdf7224f15a7\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.152Z\",\n \"updated_by\" : {\n \"guid\" : \"ae94c577-375c-45e2-9964-fe6a6ee2a738\"\n }\n },\n \"user\" : {\n \"name\" : \"9f3efc517016\",\n \"email\" : \"277896242b90\",\n \"guid\" : \"9a984b12-fe3e-4241-95a7-3e2f418e1bfc\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.152Z\",\n \"created_by\" : {\n \"guid\" : \"7ce42fdd-ccc0-4f95-beb1-6743aba3b5e4\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.152Z\",\n \"updated_by\" : {\n \"guid\" : \"600fb6d8-f41c-4f25-81d0-9ffc6dbb2364\"\n }\n },\n \"nickname\" : \"13be237a2efa\"\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\" : \"2e045e840b03\",\n \"message\" : \"67b1b1d4caa3\"\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\" : \"ede524888b5e\",\n \"message\" : \"63546d017008\"\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\" : \"4e9981f40106\",\n \"message\" : \"15ba3ca6258f\"\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\" : \"78a663eb1a48\",\n \"guid\" : \"82915ad4-1b80-4c0b-9423-0b28c2e97632\",\n \"domains\" : [ ],\n \"key\" : \"c5918168b245\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.152Z\",\n \"created_by\" : {\n \"guid\" : \"b14ffefe-4766-4505-9167-70c5d2cd74c6\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.152Z\",\n \"updated_by\" : {\n \"guid\" : \"bb697040-d841-4db1-bc49-9f2938092a2a\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the organization with this key." }, "header" : [ ] }, "name" : "GET /organizations/:key", "description" : { "content" : "Returns the organization with this key." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - organization", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns the organization with this key." }, "header" : [ ] }, "body" : "{\n \"name\" : \"5d34baf9d56f\",\n \"guid\" : \"4182343d-9821-4298-b924-3a9303fb9c75\",\n \"domains\" : [ ],\n \"key\" : \"55b85878dc78\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.152Z\",\n \"created_by\" : {\n \"guid\" : \"b786bb26-4b5d-41b4-ad2a-86cbf43f15da\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.152Z\",\n \"updated_by\" : {\n \"guid\" : \"8b3d860c-59d5-40f6-b52d-c1816742766c\"\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\" : \"c21e239d53a7\",\n \"domains\" : [ \"05558fad2c74\" ],\n \"key\" : \"339c9af6272a\",\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\" : \"c21e239d53a7\",\n \"domains\" : [ \"05558fad2c74\" ],\n \"key\" : \"339c9af6272a\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"ccfbaf606851\",\n \"guid\" : \"5219989e-0e1c-46a7-ac48-45f792850441\",\n \"domains\" : [ ],\n \"key\" : \"73c65d5841e6\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.153Z\",\n \"created_by\" : {\n \"guid\" : \"162f8347-05cd-4368-85d3-1da4b41af0de\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.153Z\",\n \"updated_by\" : {\n \"guid\" : \"db99ea8d-7ceb-4de2-a845-2c554762fafc\"\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\" : \"c21e239d53a7\",\n \"domains\" : [ \"05558fad2c74\" ],\n \"key\" : \"339c9af6272a\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"ab4c912e5436\",\n \"message\" : \"6113fe32a6fb\"\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\" : \"1bdfca2d04c9\",\n \"domains\" : [ \"ca5bb4580b3a\" ],\n \"key\" : \"fa6aa87e494e\",\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\" : \"1bdfca2d04c9\",\n \"domains\" : [ \"ca5bb4580b3a\" ],\n \"key\" : \"fa6aa87e494e\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"eef937d63fe7\",\n \"guid\" : \"10b271c4-a273-4825-9cfe-30c6047ce941\",\n \"domains\" : [ ],\n \"key\" : \"03400bd4a53f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.153Z\",\n \"created_by\" : {\n \"guid\" : \"e4dff0bc-6551-4ea6-bd1b-8724e8f9bef3\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.153Z\",\n \"updated_by\" : {\n \"guid\" : \"8b3df138-b7d1-4d96-830e-2141bd572c51\"\n }\n },\n \"visibility\" : \"organization\",\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\" : \"1bdfca2d04c9\",\n \"domains\" : [ \"ca5bb4580b3a\" ],\n \"key\" : \"fa6aa87e494e\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"b0557fbe062c\",\n \"message\" : \"6d5067579111\"\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\" : \"5ae1cf68-1ac0-4a36-a34e-f2b243fd624e\",\n \"attribute\" : {\n \"guid\" : \"9c29767e-264b-4a35-9643-f67a711b6f0f\",\n \"name\" : \"f1b7d36c8895\"\n },\n \"value\" : \"3ce66e412164\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.153Z\",\n \"created_by\" : {\n \"guid\" : \"78e708b4-ea1b-4234-aad3-a445e619a2ed\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.153Z\",\n \"updated_by\" : {\n \"guid\" : \"1cb85020-077b-4b16-96ef-962dcf0f3596\"\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\" : \"2fb6e561-63cf-4875-b6c7-506e77058307\",\n \"attribute\" : {\n \"guid\" : \"cfbc0f60-b310-4a34-a0c6-85c305c034f5\",\n \"name\" : \"bccd1ddaefc7\"\n },\n \"value\" : \"6c8f528be50e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.153Z\",\n \"created_by\" : {\n \"guid\" : \"9fa231f7-8c5d-42ed-948c-6301f587b7a1\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.153Z\",\n \"updated_by\" : {\n \"guid\" : \"af4fdc03-1437-44ff-bd6f-993c687d6a9e\"\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\" : \"c2669b7c0e53\"\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\" : \"c2669b7c0e53\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"f9302687-325f-4dc6-b206-e601d5d5e545\",\n \"attribute\" : {\n \"guid\" : \"549d0c5e-bbd1-451c-9bb0-d24500697985\",\n \"name\" : \"d1f8b4a120c8\"\n },\n \"value\" : \"23c6557c6a7a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.153Z\",\n \"created_by\" : {\n \"guid\" : \"4a383d7e-7d2f-48da-8382-b8508e5be805\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.153Z\",\n \"updated_by\" : {\n \"guid\" : \"676e5634-f76d-413f-8dff-6e09a31b3f59\"\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\" : \"c2669b7c0e53\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"5f61bf10-e245-43d0-9ee9-d4ce0d716864\",\n \"attribute\" : {\n \"guid\" : \"1764a283-7d2c-4f90-aa6f-2a459dcfd32a\",\n \"name\" : \"3ab9cb1d1668\"\n },\n \"value\" : \"451747cb8a63\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.154Z\",\n \"created_by\" : {\n \"guid\" : \"5b440ccc-3e71-4904-9d8c-befafdc5cc16\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.154Z\",\n \"updated_by\" : {\n \"guid\" : \"0679ce3c-dfe9-4297-8c7f-c49b188326f5\"\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\" : \"c2669b7c0e53\"\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\" : \"c2669b7c0e53\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"891be754257b\",\n \"message\" : \"e6acfff719f3\"\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\" : \"56f4765593be\",\n \"password\" : \"be2386bd9e8b\"\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\" : \"56f4765593be\",\n \"password\" : \"be2386bd9e8b\"\n}", "mode" : "raw" } }, "body" : "{\n \"user\" : {\n \"name\" : \"c0923314a62c\",\n \"email\" : \"12d0c384771e\",\n \"guid\" : \"721d4334-382a-4c85-ac46-2348e8db0f1b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.154Z\",\n \"created_by\" : {\n \"guid\" : \"c35845c2-2a96-4814-99e6-a6a5779cf629\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.154Z\",\n \"updated_by\" : {\n \"guid\" : \"0fcffe39-0025-4436-83ea-543271484c99\"\n }\n },\n \"nickname\" : \"a53f71793563\"\n },\n \"session\" : {\n \"id\" : \"8cdf19896081\",\n \"expires_at\" : \"2026-10-17T09:10:25.154Z\"\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\" : \"56f4765593be\",\n \"password\" : \"be2386bd9e8b\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"dab082aac3e4\",\n \"message\" : \"3a1ae9f4ef0a\"\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\" : \"8f56d5064be1\"\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\" : \"8f56d5064be1\"\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\" : \"8f56d5064be1\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"9af86754fb09\",\n \"message\" : \"0b042c6000b2\"\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\" : \"dd0c73ae93e5\",\n \"guid\" : \"823a1e58-b927-4712-bbd9-397846cc67b9\",\n \"domains\" : [ ],\n \"key\" : \"18590426e4ee\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.154Z\",\n \"created_by\" : {\n \"guid\" : \"113b1407-0b8f-4bbe-800d-13cafa9b91e3\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.154Z\",\n \"updated_by\" : {\n \"guid\" : \"5b85e5b9-c1b1-4ea1-a644-e37656a2539a\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"56fc98e7-743e-4fb3-9671-0f1441c3cdd1\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.154Z\",\n \"created_by\" : {\n \"guid\" : \"dbf04211-73bb-4127-bd39-3e7ff54c8eeb\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.154Z\",\n \"updated_by\" : {\n \"guid\" : \"e3d73a41-a6aa-41e0-8a3d-d434931723dd\"\n }\n },\n \"publication\" : \"applications.create\",\n \"user\" : {\n \"name\" : \"b9ee5a304249\",\n \"email\" : \"df010f6662b1\",\n \"guid\" : \"9c0e1426-09c3-4a2b-94b8-9aabce8b3c1f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.154Z\",\n \"created_by\" : {\n \"guid\" : \"3b8a111f-5555-4d40-9722-8c55657cc9f9\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.154Z\",\n \"updated_by\" : {\n \"guid\" : \"cda8f40b-0bb4-4042-b34a-cc4ea45f9ae2\"\n }\n },\n \"nickname\" : \"a30086a669bc\"\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\" : \"d8101569fd16\",\n \"guid\" : \"9b907993-08fd-4f07-a151-4b5c75190174\",\n \"domains\" : [ ],\n \"key\" : \"174868e6267d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.154Z\",\n \"created_by\" : {\n \"guid\" : \"31f9d549-3578-4649-b7ce-f83355759d9d\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.154Z\",\n \"updated_by\" : {\n \"guid\" : \"ed70297b-d370-4444-9973-3a702b114174\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"0b9a8908-3256-481e-afde-d86d7cb100b1\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.155Z\",\n \"created_by\" : {\n \"guid\" : \"26184d6e-7318-445c-a7f2-2ba9adf57f72\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.155Z\",\n \"updated_by\" : {\n \"guid\" : \"07124960-14d1-448b-b01b-d1df0b9b05ff\"\n }\n },\n \"publication\" : \"memberships.create\",\n \"user\" : {\n \"name\" : \"088352f5e7b4\",\n \"email\" : \"00e818146afa\",\n \"guid\" : \"26bf0642-726a-4a27-9a68-6288077ff9f6\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.154Z\",\n \"created_by\" : {\n \"guid\" : \"25bff21a-721f-4bbc-8b1e-6920a3213e51\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.154Z\",\n \"updated_by\" : {\n \"guid\" : \"6620a739-9ab0-4f1b-a2cb-dba418018654\"\n }\n },\n \"nickname\" : \"2f0761fa7aec\"\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\" : \"191917d15e4a\",\n \"user_guid\" : \"15c3295c-780c-4614-811f-aee814b10c70\",\n \"publication\" : \"applications.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\" : \"191917d15e4a\",\n \"user_guid\" : \"15c3295c-780c-4614-811f-aee814b10c70\",\n \"publication\" : \"applications.create\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"name\" : \"3f7ef6adf985\",\n \"guid\" : \"46037b30-0258-47f6-8c76-cd20f276a5f5\",\n \"domains\" : [ ],\n \"key\" : \"ef7f4cfa9208\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.155Z\",\n \"created_by\" : {\n \"guid\" : \"323bb9ee-5b96-4391-852b-5f55d54ca3f1\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.155Z\",\n \"updated_by\" : {\n \"guid\" : \"e225715f-9c03-4096-9e42-2e13e64dadb7\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"6b61a2e8-58eb-447b-b51e-29f5bdc57de0\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.155Z\",\n \"created_by\" : {\n \"guid\" : \"73fad118-b5c9-4148-a41d-9662e210a6e1\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.155Z\",\n \"updated_by\" : {\n \"guid\" : \"a4495d09-da2b-4951-b134-d7544d6eb852\"\n }\n },\n \"publication\" : \"applications.create\",\n \"user\" : {\n \"name\" : \"061b413c0b48\",\n \"email\" : \"e8fec8eb8a97\",\n \"guid\" : \"f62a5de8-d7b3-46c6-bdba-f96d11b5650d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.155Z\",\n \"created_by\" : {\n \"guid\" : \"7e247a76-4c44-4628-af82-da9c99aa9aec\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.155Z\",\n \"updated_by\" : {\n \"guid\" : \"c1867dfc-938f-4674-b8dd-84230e878e83\"\n }\n },\n \"nickname\" : \"ef094d396188\"\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\" : \"191917d15e4a\",\n \"user_guid\" : \"15c3295c-780c-4614-811f-aee814b10c70\",\n \"publication\" : \"applications.create\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"dbb1b5a8eb88\",\n \"message\" : \"89b25d5b5813\"\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\" : \"7e27d95d-515b-49ef-9a14-db1852696bfe\",\n \"description\" : \"e4120616b612\",\n \"masked_token\" : \"b690038f57f8\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.155Z\",\n \"created_by\" : {\n \"guid\" : \"95e61cc9-924d-4095-954a-5e3a54734ae9\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.155Z\",\n \"updated_by\" : {\n \"guid\" : \"b6687ccb-df42-472d-a387-01527ecd0757\"\n }\n },\n \"user\" : {\n \"name\" : \"578c40515b07\",\n \"email\" : \"6f4d42beaa64\",\n \"guid\" : \"7b57ac33-df60-4ab5-8542-270b1741b938\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.155Z\",\n \"created_by\" : {\n \"guid\" : \"9fd9f184-a72c-40ca-a55b-7753a820fb1a\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.155Z\",\n \"updated_by\" : {\n \"guid\" : \"b204d043-c474-48e7-a099-5c865aded272\"\n }\n },\n \"nickname\" : \"195758c00da9\"\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\" : \"581589b8acf5\"\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\" : \"cc45706d-373c-4281-a081-dc674d4cd61a\",\n \"description\" : \"12c9de14b509\"\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\" : \"cc45706d-373c-4281-a081-dc674d4cd61a\",\n \"description\" : \"12c9de14b509\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"d53349f4-03ff-4b20-bb4c-59ab80fde566\",\n \"description\" : \"9b2b573a24ed\",\n \"masked_token\" : \"94f75ccd9ad1\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.155Z\",\n \"created_by\" : {\n \"guid\" : \"88cba523-3db2-4fb9-9e35-3df7092436af\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.155Z\",\n \"updated_by\" : {\n \"guid\" : \"3076c4a3-309c-4a8e-ac9f-a8163a2cf76e\"\n }\n },\n \"user\" : {\n \"name\" : \"29cdbd3c6514\",\n \"email\" : \"c62142d5aaa9\",\n \"guid\" : \"0e4803c0-91d2-4531-a955-e07c3718b558\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.155Z\",\n \"created_by\" : {\n \"guid\" : \"720cef9f-a1df-49b4-80cc-dfca96d93828\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.155Z\",\n \"updated_by\" : {\n \"guid\" : \"5e0670b2-ebbb-4ef3-a5fd-398ac0e7ab1d\"\n }\n },\n \"nickname\" : \"9ad03353692a\"\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\" : \"cc45706d-373c-4281-a081-dc674d4cd61a\",\n \"description\" : \"12c9de14b509\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"bc40dea15e50\",\n \"message\" : \"696d2d393f7f\"\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\" : \"62b1208c3794\",\n \"email\" : \"1847902213eb\",\n \"guid\" : \"e83c7389-768a-4c1f-806a-a87790d7bce3\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.156Z\",\n \"created_by\" : {\n \"guid\" : \"4fa8d327-eec3-48f3-b818-255f6f41811f\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.156Z\",\n \"updated_by\" : {\n \"guid\" : \"efa61804-7098-4c0d-8251-4dcf8aa67c70\"\n }\n },\n \"nickname\" : \"16fd66a5303a\"\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\" : \"74957424b3be\",\n \"email\" : \"a6b904460c04\",\n \"guid\" : \"81f231d6-8c7c-4dc0-a7da-6c66b7605956\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.156Z\",\n \"created_by\" : {\n \"guid\" : \"d01e98a9-fe9a-4e4f-a137-0bfc67ccd5a3\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.156Z\",\n \"updated_by\" : {\n \"guid\" : \"10390bbe-7a7b-4bad-9bfd-0969a40ef8b6\"\n }\n },\n \"nickname\" : \"d74291a29dc0\"\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\" : \"6ddf7d6afe2a\",\n \"email\" : \"fbc4851b5d51\",\n \"guid\" : \"ca5b492b-32df-411f-8630-80184b315d6b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.156Z\",\n \"created_by\" : {\n \"guid\" : \"77a1b55d-1923-467b-8970-51940e9ce216\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.156Z\",\n \"updated_by\" : {\n \"guid\" : \"2e6648a2-9045-4c35-a4b5-dec39f809c78\"\n }\n },\n \"nickname\" : \"443dee016881\"\n },\n \"session\" : {\n \"id\" : \"126cea5be426\",\n \"expires_at\" : \"2026-10-17T09:10:25.156Z\"\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\" : \"b9a10581e19e\",\n \"message\" : \"7f74a6c1c034\"\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\" : \"c48861babf9a\",\n \"email\" : \"2e21842a0fc5\",\n \"guid\" : \"c68e88c8-6621-46c9-8856-590531155888\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.156Z\",\n \"created_by\" : {\n \"guid\" : \"f33ff2dd-1f36-4a60-82fd-9af314a3f696\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.156Z\",\n \"updated_by\" : {\n \"guid\" : \"2b4a82c8-298c-4791-9e86-37351260f337\"\n }\n },\n \"nickname\" : \"c4b8c7c70afa\"\n },\n \"session\" : {\n \"id\" : \"8fddc170bf00\",\n \"expires_at\" : \"2026-10-17T09:10:25.156Z\"\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\" : \"18004d00ec00\",\n \"message\" : \"411523a2b34f\"\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\" : \"19bc921e0520\",\n \"password\" : \"3b1c597146a3\",\n \"nickname\" : \"6c421856a577\",\n \"name\" : \"a65285486623\"\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\" : \"19bc921e0520\",\n \"password\" : \"3b1c597146a3\",\n \"nickname\" : \"6c421856a577\",\n \"name\" : \"a65285486623\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"45e2d05be051\",\n \"email\" : \"10dfa0d606b1\",\n \"guid\" : \"848f4ddf-185a-4655-8d31-7319f860e40f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.156Z\",\n \"created_by\" : {\n \"guid\" : \"6caf3cb8-9c64-4668-9727-8b3435025875\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.156Z\",\n \"updated_by\" : {\n \"guid\" : \"9457bd42-af71-4ef2-84ed-c554b389713d\"\n }\n },\n \"nickname\" : \"493000753efb\"\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\" : \"19bc921e0520\",\n \"password\" : \"3b1c597146a3\",\n \"nickname\" : \"6c421856a577\",\n \"name\" : \"a65285486623\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"4327d9671fe8\",\n \"message\" : \"979703c91b73\"\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\" : \"136681129935\",\n \"nickname\" : \"2af074823b9d\",\n \"name\" : \"432289a75d90\"\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\" : \"136681129935\",\n \"nickname\" : \"2af074823b9d\",\n \"name\" : \"432289a75d90\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"411e8c5bf837\",\n \"email\" : \"b1d5981ee22d\",\n \"guid\" : \"0756c6b7-7189-4dd9-93c9-1b25a70c0869\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.156Z\",\n \"created_by\" : {\n \"guid\" : \"f41b77ab-fd46-48bf-9982-38915373258d\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.156Z\",\n \"updated_by\" : {\n \"guid\" : \"4e66ae18-a90b-4b3f-9cf0-91d2180e6752\"\n }\n },\n \"nickname\" : \"957126cb0462\"\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\" : \"136681129935\",\n \"nickname\" : \"2af074823b9d\",\n \"name\" : \"432289a75d90\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"7a24f03683be\",\n \"message\" : \"3e7814106089\"\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" : "\"cf88b6eae424\"", "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" : "\"cf88b6eae424\"", "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\" : \"b5ff820a-865b-4f48-9f9a-5dc91aa1abed\",\n \"service\" : {\n \"name\" : \"bf92e65cbd30\",\n \"description\" : \"e6b2a148a2db\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"5d994586ce89\"\n },\n \"organization\" : {\n \"key\" : \"6e9538f017b8\"\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\" : \"9ea6678f2922\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"847d12ca-9691-4b52-aff3-7a959e48d558\",\n \"key\" : \"9ec498b071dd\"\n },\n \"organization\" : {\n \"guid\" : \"c966f63b-6d62-40c4-842f-6efb57970979\",\n \"key\" : \"37c3923938fa\"\n },\n \"original\" : {\n \"type\" : \"api_json\",\n \"data\" : \"141e5dc1deeb\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.157Z\",\n \"created_by\" : {\n \"guid\" : \"b1b7cc74-aa26-4099-a386-1f85efafc290\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.157Z\",\n \"updated_by\" : {\n \"guid\" : \"aa6b6341-49b5-46b8-84f1-4f788da59b64\"\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\" : \"aca5b981-91a9-45ac-91eb-3ca3657007c3\",\n \"service\" : {\n \"name\" : \"b68cf38448ff\",\n \"description\" : \"24df73caea2d\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"3cb28ec2ad84\"\n },\n \"organization\" : {\n \"key\" : \"7b6dd7be6e0a\"\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\" : \"5e06daf0f742\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"4b8c7d8b-085f-498f-af60-b0d190d811fd\",\n \"key\" : \"187415e088fc\"\n },\n \"organization\" : {\n \"guid\" : \"5265677e-1923-4ba1-9461-f7b3df36768e\",\n \"key\" : \"46b068e15b17\"\n },\n \"original\" : {\n \"type\" : \"swagger\",\n \"data\" : \"9293f2049ff8\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.157Z\",\n \"created_by\" : {\n \"guid\" : \"bda87964-d47b-4e5a-b7da-24c5d1d9b298\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.157Z\",\n \"updated_by\" : {\n \"guid\" : \"b90cd2fe-2674-4349-8879-ae5629b844c1\"\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\" : \"8409c4f1f283\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "name" : "POST /:orgKey/:version", "description" : { "content" : "Create a new version for an application" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - version", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create a new version for an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"api_json\",\n \"data\" : \"8409c4f1f283\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"7cc3f66a-bd8d-487a-88f0-d0ed38f0c933\",\n \"service\" : {\n \"name\" : \"339c0a14ba16\",\n \"description\" : \"e01ff9565caf\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"d7b770bff132\"\n },\n \"organization\" : {\n \"key\" : \"5e76b75a77fd\"\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\" : \"027e7d3a8959\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"4516feca-762b-43dc-b3b4-3041918a6475\",\n \"key\" : \"442ec5155827\"\n },\n \"organization\" : {\n \"guid\" : \"c0893b9a-72a5-4805-9da4-a274b57d8a10\",\n \"key\" : \"7c2e890ee884\"\n },\n \"original\" : {\n \"type\" : \"api_json\",\n \"data\" : \"cfdd4372b111\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.158Z\",\n \"created_by\" : {\n \"guid\" : \"a35b841b-cf94-4c87-99da-52ad54af83e9\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.158Z\",\n \"updated_by\" : {\n \"guid\" : \"dc25b5b6-1616-4419-aabc-8b7d35aecb20\"\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\" : \"8409c4f1f283\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"02c9a804e04b\",\n \"message\" : \"7a09efcac28a\"\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\" : \"service_json\",\n \"data\" : \"e2915c658da1\"\n },\n \"visibility\" : \"user\"\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\" : \"service_json\",\n \"data\" : \"e2915c658da1\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"e3cb6a5d-6704-4685-84c2-24af8ad6a69e\",\n \"service\" : {\n \"name\" : \"ea703bc75205\",\n \"description\" : \"fbef9005a5aa\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"823fb2dddfb1\"\n },\n \"organization\" : {\n \"key\" : \"68bb8181a9b1\"\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\" : \"9f919b0c1adf\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"7fddf641-683d-499a-95a4-85cb223af1e4\",\n \"key\" : \"b381181a5f97\"\n },\n \"organization\" : {\n \"guid\" : \"08d9ae66-eeab-4273-b1de-e3ec11cead82\",\n \"key\" : \"e4fafb88e583\"\n },\n \"original\" : {\n \"type\" : \"swagger\",\n \"data\" : \"946422992ae7\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.158Z\",\n \"created_by\" : {\n \"guid\" : \"1c1b1a97-12a0-43b1-a621-d63512079ff3\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.158Z\",\n \"updated_by\" : {\n \"guid\" : \"3233b2a3-6ff0-44cf-bb77-7f877ec175b3\"\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\" : \"service_json\",\n \"data\" : \"e2915c658da1\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"b523bed58daf\",\n \"message\" : \"a48ff4836c94\"\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\" : \"fd44ecde-6870-4455-888c-a57bbbc6c731\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.159Z\",\n \"created_by\" : {\n \"guid\" : \"73a67d97-99cd-431f-a5fb-a8c38c2e6cff\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.159Z\",\n \"updated_by\" : {\n \"guid\" : \"d4fdddc6-3ac3-4b99-a796-8ac58fd09dd9\"\n }\n },\n \"user\" : {\n \"name\" : \"9b075b336b26\",\n \"email\" : \"1edd9f7619e3\",\n \"guid\" : \"b4402aaa-369d-441d-8732-3ead12eb7fc8\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.158Z\",\n \"created_by\" : {\n \"guid\" : \"bb97d3fb-b6c0-45c1-9b7d-5bb6c69e9671\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.158Z\",\n \"updated_by\" : {\n \"guid\" : \"f0349860-48d3-4c6b-8b00-f430b82306c2\"\n }\n },\n \"nickname\" : \"59bba4e99095\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"794dc9e9-3074-4589-891f-8b7be8ab1d5b\",\n \"key\" : \"efc205b7172b\"\n },\n \"name\" : \"aa706ab9c4b1\",\n \"guid\" : \"09daba8d-3b07-4317-94a4-1a8abc181a1f\",\n \"description\" : \"8e2d28bb5cc6\",\n \"last_updated_at\" : \"2026-10-17T09:10:25.159Z\",\n \"key\" : \"7166e3f591d9\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.159Z\",\n \"created_by\" : {\n \"guid\" : \"5db2105d-a551-4883-a328-386019149c4d\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.159Z\",\n \"updated_by\" : {\n \"guid\" : \"a3d7ef26-d3d4-4edc-bf33-7e2fb04606a5\"\n }\n },\n \"visibility\" : \"user\"\n },\n \"organization\" : {\n \"name\" : \"0a2bc7089574\",\n \"guid\" : \"f86e97e6-2947-4336-ad15-8baf05014081\",\n \"domains\" : [ ],\n \"key\" : \"0a78cf678a00\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.158Z\",\n \"created_by\" : {\n \"guid\" : \"5b7fe231-b630-4702-a18b-ab14d0c8cb5e\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.158Z\",\n \"updated_by\" : {\n \"guid\" : \"8036e91a-17f1-4ec9-bed9-ea65514b839f\"\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\" : \"83701a98-77cf-4b2e-a4e2-edf4bf7914d3\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.159Z\",\n \"created_by\" : {\n \"guid\" : \"322a2b4a-a9f0-4e25-b560-0d8f8a538fca\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.159Z\",\n \"updated_by\" : {\n \"guid\" : \"ba0340c9-d01c-4e8c-86df-e5bd95eb7dd0\"\n }\n },\n \"user\" : {\n \"name\" : \"f14602c83513\",\n \"email\" : \"f1d571d82979\",\n \"guid\" : \"1e520f84-1acc-4962-a961-04e10ec759f5\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.159Z\",\n \"created_by\" : {\n \"guid\" : \"9b7c7831-b888-470c-96bb-a4736c80ad1a\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.159Z\",\n \"updated_by\" : {\n \"guid\" : \"62e485ce-cf79-4936-95f0-eddbd97f3158\"\n }\n },\n \"nickname\" : \"69b2c34ee40d\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"3fa8c29e-393f-4bbd-9d9b-e9290ab77e19\",\n \"key\" : \"62935ca8aa81\"\n },\n \"name\" : \"6748d26d577a\",\n \"guid\" : \"231858e8-be6e-4610-b433-8e302e5d1f92\",\n \"description\" : \"acfa4188dcea\",\n \"last_updated_at\" : \"2026-10-17T09:10:25.159Z\",\n \"key\" : \"fad739e435f4\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.159Z\",\n \"created_by\" : {\n \"guid\" : \"64a77c24-083f-4500-8953-d3af2532294f\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.159Z\",\n \"updated_by\" : {\n \"guid\" : \"480bdf59-5976-4afc-88f6-368efa36ada9\"\n }\n },\n \"visibility\" : \"user\"\n },\n \"organization\" : {\n \"name\" : \"210ba334d031\",\n \"guid\" : \"d1ab7503-9288-4f0d-9d6d-a8a6078ce987\",\n \"domains\" : [ ],\n \"key\" : \"a012261076b5\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.159Z\",\n \"created_by\" : {\n \"guid\" : \"7551f8ff-7647-4c4f-a0a6-81ce27396f87\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.159Z\",\n \"updated_by\" : {\n \"guid\" : \"982ec5d2-e228-4e99-a784-b736ff195000\"\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\" : \"a49ff4f3-3399-429c-a7d8-167c26488d7a\",\n \"organization_key\" : \"4425c57940ff\",\n \"application_key\" : \"c56130574923\"\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\" : \"a49ff4f3-3399-429c-a7d8-167c26488d7a\",\n \"organization_key\" : \"4425c57940ff\",\n \"application_key\" : \"c56130574923\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"d9976bd6-7dc8-4619-b9f0-f3400ebc3ec3\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.160Z\",\n \"created_by\" : {\n \"guid\" : \"c6cb0da3-e87e-4da4-8ec4-17c498907226\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.160Z\",\n \"updated_by\" : {\n \"guid\" : \"4f57ca55-e9c2-475a-b9a0-ce763737d07b\"\n }\n },\n \"user\" : {\n \"name\" : \"def6168de090\",\n \"email\" : \"5a703f16f681\",\n \"guid\" : \"187a30e4-299d-4a42-9ed2-c86441499d6a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.159Z\",\n \"created_by\" : {\n \"guid\" : \"94185476-96b4-429f-9b5b-e4561a18bfb5\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.159Z\",\n \"updated_by\" : {\n \"guid\" : \"cc0e18a3-1b73-44ef-a71c-5bb25d1ce9c3\"\n }\n },\n \"nickname\" : \"844e42eb1a59\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"89b6d642-cf21-41dc-a181-8641ec43a97b\",\n \"key\" : \"9055f2006b13\"\n },\n \"name\" : \"faeb0059224a\",\n \"guid\" : \"f1d8b21e-b8c3-4e92-8a00-088ec3c816bf\",\n \"description\" : \"5174c142a5a1\",\n \"last_updated_at\" : \"2026-10-17T09:10:25.159Z\",\n \"key\" : \"a0e94f244874\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.159Z\",\n \"created_by\" : {\n \"guid\" : \"9a808f2c-8443-43b9-9c6b-3d7439b56b3c\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.159Z\",\n \"updated_by\" : {\n \"guid\" : \"c2c54892-3279-49b2-a3e3-257d21d9978b\"\n }\n },\n \"visibility\" : \"organization\"\n },\n \"organization\" : {\n \"name\" : \"e0b128a915e1\",\n \"guid\" : \"73346c44-f67e-48d2-b917-0a63a3701b34\",\n \"domains\" : [ ],\n \"key\" : \"49c830d1734a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T09:10:25.159Z\",\n \"created_by\" : {\n \"guid\" : \"b2192680-2d5f-4ed1-b26c-13d23e9a28d6\"\n },\n \"updated_at\" : \"2026-10-17T09:10:25.159Z\",\n \"updated_by\" : {\n \"guid\" : \"7c2a8795-3ae5-4ede-b4d6-98cc8cebdc49\"\n }\n },\n \"visibility\" : \"organization\",\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\" : \"a49ff4f3-3399-429c-a7d8-167c26488d7a\",\n \"organization_key\" : \"4425c57940ff\",\n \"application_key\" : \"c56130574923\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"0a17abbcf080\",\n \"message\" : \"c5b36382ba3f\"\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" } ] }