{ "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" : "\"fa05fba2c9f7\"", "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\" : \"95d6ba2e-3d00-4ce4-b8bf-81956628d640\",\n \"key\" : \"fe7554db1373\"\n },\n \"name\" : \"06edad337df6\",\n \"guid\" : \"f6760c04-5077-477b-a19a-2ae6f43949b8\",\n \"description\" : \"bec27c719fb2\",\n \"last_updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"key\" : \"8d338383eefb\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.916Z\",\n \"created_by\" : {\n \"guid\" : \"f97c4099-56d7-41d8-ab1c-01f6c799ea3d\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"updated_by\" : {\n \"guid\" : \"aceb0a7f-9e3f-47a3-b429-4a2603f44225\"\n }\n },\n \"visibility\" : \"public\"\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"de38acab520e\",\n \"key\" : \"7ec420b1cb34\",\n \"description\" : \"22077fd75f90\",\n \"visibility\" : \"organization\"\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\" : \"de38acab520e\",\n \"key\" : \"7ec420b1cb34\",\n \"description\" : \"22077fd75f90\",\n \"visibility\" : \"organization\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"d50b0cef-66ff-4d53-9c9d-a975746cdf4f\",\n \"key\" : \"38e95763efc7\"\n },\n \"name\" : \"454bd009200e\",\n \"guid\" : \"fd55e0eb-f354-4963-b506-a266edf6e2e7\",\n \"description\" : \"648904214dca\",\n \"last_updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"key\" : \"b543807a837d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.916Z\",\n \"created_by\" : {\n \"guid\" : \"448ef15a-a009-4ef1-9fb5-ccd67ef9f656\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"updated_by\" : {\n \"guid\" : \"77e7d4f5-c207-4af5-8282-c00d5fdb1142\"\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\" : \"de38acab520e\",\n \"key\" : \"7ec420b1cb34\",\n \"description\" : \"22077fd75f90\",\n \"visibility\" : \"organization\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"adbc484e0f2d\",\n \"message\" : \"2a9d2f8d8b22\"\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\" : \"4a1282b18c3a\",\n \"key\" : \"2182ed59cc32\",\n \"description\" : \"f5aef4dda3ca\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "name" : "PUT /:orgKey/:applicationKey", "description" : { "content" : "Updates an application." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - application", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates an application." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"4a1282b18c3a\",\n \"key\" : \"2182ed59cc32\",\n \"description\" : \"f5aef4dda3ca\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"863a35ec-e2eb-4edf-a00e-430ce61abc18\",\n \"key\" : \"59e28fb79a52\"\n },\n \"name\" : \"274d2e27631e\",\n \"guid\" : \"4b9dbd3c-5cb8-4a03-acad-f27196f79bab\",\n \"description\" : \"fdab03e24d1f\",\n \"last_updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"key\" : \"24296151ae07\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.916Z\",\n \"created_by\" : {\n \"guid\" : \"925d1f34-b1f5-4164-94e0-2ef8aaae423e\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"updated_by\" : {\n \"guid\" : \"611f9b69-4934-4fc2-895f-2c816af3514d\"\n }\n },\n \"visibility\" : \"user\"\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\" : \"4a1282b18c3a\",\n \"key\" : \"2182ed59cc32\",\n \"description\" : \"f5aef4dda3ca\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"f719fc2cd2ea\",\n \"message\" : \"2bb8477a577d\"\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\" : \"8dcc7056dad9\"\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\" : \"8dcc7056dad9\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"84c4acd0-351a-43e6-bc80-2fdf23dcaacc\",\n \"key\" : \"0699f7e31a55\"\n },\n \"name\" : \"daf3c298177c\",\n \"guid\" : \"70fb2773-188f-4dc6-8d40-5256cf346296\",\n \"description\" : \"8df49422c950\",\n \"last_updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"key\" : \"6faefc49035a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.916Z\",\n \"created_by\" : {\n \"guid\" : \"8234d0ec-59b7-4f43-8109-f5cbea60dfa4\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"updated_by\" : {\n \"guid\" : \"bdea558e-8849-4d14-b514-ec8333c67e59\"\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\" : \"8dcc7056dad9\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"4b34c1bd5343\",\n \"message\" : \"50e9d807ed52\"\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\" : \"a7b378f8-d492-48e6-ad03-2780783e386c\",\n \"name\" : \"fb4c76b5bddf\",\n \"description\" : \"0d9c27c02f71\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.916Z\",\n \"created_by\" : {\n \"guid\" : \"cd2cdd6a-791a-41b5-a7ef-0cb47e526cbd\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"updated_by\" : {\n \"guid\" : \"51fdeb94-a065-4c94-b87f-3c93bcd1affb\"\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\" : \"995effd7-fd37-4d92-9361-e4d72fbf2dd0\",\n \"name\" : \"ca000166cc46\",\n \"description\" : \"0508283b099a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.916Z\",\n \"created_by\" : {\n \"guid\" : \"395d9777-c532-4411-8f47-a7552565ec61\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"updated_by\" : {\n \"guid\" : \"1ca2abce-0894-4fc4-8611-c93af2f0f1ea\"\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\" : \"638ac2f6327d\",\n \"description\" : \"75fd3c193584\"\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\" : \"638ac2f6327d\",\n \"description\" : \"75fd3c193584\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"11a09a82-42f4-47d4-a447-2cd78a2f4175\",\n \"name\" : \"7ada90d5873c\",\n \"description\" : \"502479c0f214\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.916Z\",\n \"created_by\" : {\n \"guid\" : \"27a0f8a0-46e1-49fd-b77a-01292453a27d\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"updated_by\" : {\n \"guid\" : \"1aea6ab9-4fa4-49f4-b384-ac21c47c2755\"\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\" : \"638ac2f6327d\",\n \"description\" : \"75fd3c193584\"\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\" : \"638ac2f6327d\",\n \"description\" : \"75fd3c193584\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"e024f894ef10\",\n \"message\" : \"d23324c026aa\"\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\" : \"12a7a3e8d8d7\",\n \"email\" : \"5fe0d75203ca\",\n \"guid\" : \"a504fb24-5561-45e9-a010-0c2bb2c9658c\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.916Z\",\n \"created_by\" : {\n \"guid\" : \"6df07487-3249-4c82-a373-7eb1aeb8519f\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"updated_by\" : {\n \"guid\" : \"fcd37d6c-fe4b-4bd5-8481-3d32717c9ce4\"\n }\n },\n \"nickname\" : \"165e5ff64853\"\n },\n \"session\" : {\n \"id\" : \"9ebe98e3bffb\",\n \"expires_at\" : \"2026-10-18T15:41:39.916Z\"\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-18T15:41:39.916Z\",\n \"changed_by\" : {\n \"guid\" : \"195ef9cf-f978-443c-95a9-cf0aaac3649f\",\n \"nickname\" : \"22510c25a51a\"\n },\n \"diff\" : {\n \"type\" : \"diff_breaking\",\n \"description\" : \"model removed: user\"\n },\n \"from_version\" : {\n \"guid\" : \"1da28f13-55b1-4aa2-8883-97a7a77ccef7\",\n \"version\" : \"9a05adb1d192\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.916Z\",\n \"created_by\" : {\n \"guid\" : \"3155c727-c1bc-4a37-8aac-3ac2e6542220\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"updated_by\" : {\n \"guid\" : \"dc7e38ca-d186-4468-abec-b1e25320a73f\"\n }\n },\n \"application\" : {\n \"guid\" : \"955cb8f4-f3ad-47ae-b187-ff8d6b6b2894\",\n \"key\" : \"fd01c393b8b4\"\n },\n \"organization\" : {\n \"guid\" : \"404a5e4f-d2a7-4367-91e2-d8dfd4e7ee3e\",\n \"key\" : \"080806b25522\"\n },\n \"guid\" : \"974b3ca8-b4a9-4880-85bd-7a5d590dd28a\",\n \"to_version\" : {\n \"guid\" : \"d9638e6d-f8cb-433e-a46e-c9a0cdcd51ba\",\n \"version\" : \"cabfa9d63409\"\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\" : \"4b49a5c127b4\",\n \"value\" : \"076b56c96be5\"\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\" : \"4b49a5c127b4\",\n \"value\" : \"076b56c96be5\"\n } ]\n}", "mode" : "raw" } }, "body" : "{\n \"service\" : {\n \"name\" : \"b0865a152f1d\",\n \"description\" : \"310d56994b94\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"6631524547e3\"\n },\n \"organization\" : {\n \"key\" : \"1646d1baa4b1\"\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\" : \"dc70e1037492\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"attributes\" : [ ],\n \"user_agent\" : \"bc90356dd10f\",\n \"imported_services\" : [ {\n \"name\" : \"ea68ceff767e\",\n \"description\" : \"f76eb1f49ad4\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"21115e1c4515\"\n },\n \"organization\" : {\n \"key\" : \"5b2717b21ba2\"\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\" : \"6fd0ebe92d9b\",\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\" : \"4b49a5c127b4\",\n \"value\" : \"076b56c96be5\"\n } ]\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"e99bd50295b7\",\n \"message\" : \"d190eef2c6ab\"\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\" : \"54de65af-cf33-4c15-8eaa-1945ad1e9263\",\n \"uri\" : \"493f5fccc405\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.916Z\",\n \"created_by\" : {\n \"guid\" : \"664d37ac-b914-46bf-9a3c-20306aaa76b0\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"updated_by\" : {\n \"guid\" : \"11943866-7d07-4fac-853c-67ed67554c69\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"bf2c1fb406e7\",\n \"description\" : \"8aa17ab821d9\",\n \"attributes\" : [ ],\n \"key\" : \"3c306b8716e4\",\n \"language\" : \"scala\"\n }\n },\n \"source\" : \"fc33df37a93f\",\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\" : \"20e0e6058fd6\",\n \"message\" : \"230662b4d754\"\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\" : \"9c5f470ba84c\",\n \"value\" : \"71b5d9a6e925\"\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\" : \"9c5f470ba84c\",\n \"value\" : \"71b5d9a6e925\"\n } ]\n}", "mode" : "raw" } }, "body" : "{\n \"generator\" : {\n \"service\" : {\n \"guid\" : \"8ae78031-e5cf-48bf-a7e5-bc4879abb993\",\n \"uri\" : \"3dd47eed109d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.916Z\",\n \"created_by\" : {\n \"guid\" : \"997f723f-e66b-4414-b3bd-6de97421997d\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"updated_by\" : {\n \"guid\" : \"4e68cf8c-cee0-4883-b525-af5fc6c15dbb\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"5f1275578a64\",\n \"description\" : \"0b4aa8e5ab66\",\n \"attributes\" : [ ],\n \"key\" : \"4ac975cc2d5f\",\n \"language\" : \"scala\"\n }\n },\n \"source\" : \"0d2887611f11\",\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\" : \"9c5f470ba84c\",\n \"value\" : \"71b5d9a6e925\"\n } ]\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"7a12a0e3f65e\",\n \"message\" : \"86bed8ee5323\"\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\" : \"6b9550845a97\",\n \"message\" : \"c2130bd7f44a\"\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\" : \"fa4b7778f94f\"\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\" : \"fa4b7778f94f\"\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\" : \"fa4b7778f94f\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"11e02f319179\",\n \"message\" : \"8667cea2fb0f\"\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\" : \"3bb5a3ee-52f7-423c-9d57-036738c1c70b\",\n \"uri\" : \"38fa4647c58b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.916Z\",\n \"created_by\" : {\n \"guid\" : \"58f8f2b0-752b-4104-8609-c729befb9c03\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.916Z\",\n \"updated_by\" : {\n \"guid\" : \"0cb22a71-6c55-41ec-b6e9-c04fd59e82f0\"\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\" : \"4d20f55f-62cd-461c-ab70-978b7f6c8471\",\n \"uri\" : \"dc8f69d30512\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"031e567b-aa9c-4745-9135-3ca730a95c77\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"f975a5f1-8186-4a9a-8dfe-b0ad507386e5\"\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\" : \"f05b8886e522\"\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\" : \"f05b8886e522\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"64f14e37-3e0e-4d2c-b28b-c8b48b6b7fb7\",\n \"uri\" : \"e1471b405b7f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"5d508243-bfe3-4000-bc7c-3d9746ab8787\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"0155804a-54d0-4f9c-ada9-be927bf8e31d\"\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\" : \"f05b8886e522\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"52cbbeabf7d9\",\n \"message\" : \"05c4134b7361\"\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\" : \"0df77139-14df-483b-a550-742b958e5e40\",\n \"uri\" : \"a2ad04e05400\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"c9cd1070-f8f5-406a-8463-2a3bb6ab89a3\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"d59c1087-4c4f-42b0-82d2-0982037b5afc\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"6192a4518aaf\",\n \"description\" : \"b29671601f69\",\n \"attributes\" : [ ],\n \"key\" : \"c9f7529359e1\",\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\" : \"32eab1fc-0830-4497-9993-d7c3f478e68e\",\n \"uri\" : \"cdbe1ad8bdb4\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"e9659f57-92c3-4b2f-926c-4791f35b8999\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"3efd43ca-fb1a-4b73-a892-2681b0b02b24\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"61cfdf071272\",\n \"description\" : \"f39a6120139f\",\n \"attributes\" : [ ],\n \"key\" : \"623d132a1063\",\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\" : \"0035939d478b\"\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\" : \"d206309d-9b80-42c7-8afd-9112479e144e\",\n \"detail\" : {\n \"type\" : \"application_summary\",\n \"guid\" : \"e8f1fe29-e107-41bf-b36a-712c0b08d344\",\n \"organization\" : {\n \"guid\" : \"07d07351-6e22-4cd7-a1e5-e595b9106a00\",\n \"key\" : \"c0566d1f7d94\"\n },\n \"key\" : \"7e6f4e60a81c\"\n },\n \"label\" : \"a0da0fc7c752\",\n \"description\" : \"d2978ee6ef3e\"\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\" : \"d74ce9e6-24de-4ea0-98ef-16483013db7d\",\n \"detail\" : {\n \"type\" : \"application_summary\",\n \"guid\" : \"2dd9df97-947d-4c94-b00b-4cab78e17ae7\",\n \"organization\" : {\n \"guid\" : \"9bd0c80d-ac42-435c-a684-3794397b1ec3\",\n \"key\" : \"c1ae1e0c7215\"\n },\n \"key\" : \"85ff305bbc32\"\n },\n \"label\" : \"d9540563d376\",\n \"description\" : \"c86c3e9ae497\"\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\" : \"27d53d8fde57\",\n \"guid\" : \"07daefab-dee0-4ba1-99ce-2379fbf359cf\",\n \"domains\" : [ ],\n \"key\" : \"47948426f313\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"df30b561-b9b0-4c8c-9a2c-35ad02859a09\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"991ed0e1-1157-42ef-970a-8758317e549d\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"817bee7b-767a-40e6-9a93-5b03d46ca8ec\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"505cc10b-e3cb-4d48-8215-83fe26d7597e\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"d0d38e51-0cc0-4902-8328-26201103ada5\"\n }\n },\n \"user\" : {\n \"name\" : \"4013b07ffac4\",\n \"email\" : \"96b8b0d6fb58\",\n \"guid\" : \"7b92c87e-0dd3-43ac-ab1d-bd9def3397c8\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"fe410206-90f5-406a-a91a-d6c2480cb5bc\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"6e44bce8-7dd7-440f-a908-58079860b2b3\"\n }\n },\n \"nickname\" : \"207125f15f62\"\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\" : \"6d500c7eb754\",\n \"guid\" : \"e6a3afa5-3ff1-4029-b156-47eaf86c54cd\",\n \"domains\" : [ ],\n \"key\" : \"2676a044e644\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"85b36a95-0e5b-490e-a6ce-9c82e979b51b\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"f0332e67-c61e-48e5-b316-bf966700dfd4\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"9d69973c-fbd6-4d11-957e-538674de2ba7\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"e8fc8ef1-6423-417c-a828-ef1676700cb6\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"b0c15452-3223-415c-9d98-5e7b2d9098c2\"\n }\n },\n \"user\" : {\n \"name\" : \"ade97cb3d4b8\",\n \"email\" : \"1d90a3873b72\",\n \"guid\" : \"e64a73aa-4b92-4b26-8ab7-1c303dbad29b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"7e5c4d13-4b36-4358-bb29-963b9047de43\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"ceb292bd-1aa3-4ad0-b6f4-80fa4f4751ee\"\n }\n },\n \"nickname\" : \"9fa37c94bfa4\"\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\" : \"3fd90501d2b0\",\n \"guid\" : \"0cce7c1c-229a-4381-86d5-81540a26d38b\",\n \"domains\" : [ ],\n \"key\" : \"3584c42cc450\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"8b066f75-c2b4-45d7-b978-d6da1264984c\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"2682f27b-a498-4e1b-9fc8-ef515d7fcc07\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"99b4c9e0-142d-4618-bcd1-33d2c2bc5233\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"69547967-f29b-4a77-a9a0-daf364f7e80c\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"0dd62e35-28e6-4934-8a06-54adf19afd06\"\n }\n },\n \"user\" : {\n \"name\" : \"bf75f80dac3a\",\n \"email\" : \"3641bd222383\",\n \"guid\" : \"5ed4df26-5e9c-4e88-8d85-e46283a6712a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"dc3e5c87-0930-446d-b64f-091b5c148fee\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"74674a14-d54c-4578-a09d-5ca786d07b45\"\n }\n },\n \"nickname\" : \"da32509e326c\"\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\" : \"7713ebe28a05\",\n \"guid\" : \"255e61ca-b876-4735-b64a-ec398e4e0373\",\n \"domains\" : [ ],\n \"key\" : \"c35c8a3f5d09\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"dde4b938-6657-4c76-9fd9-188b5cadd0aa\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"ef6350c1-ec17-4598-a262-b7ec2eba3555\"\n }\n },\n \"visibility\" : \"user\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"cb051272-6082-4295-a6ca-862e3cc2c208\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"20ee5b29-f9b5-4b9b-a2a1-0729f883d46b\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"58d8cd92-20d0-488f-98c5-607698f5530d\"\n }\n },\n \"user\" : {\n \"name\" : \"3d0d42fa11c2\",\n \"email\" : \"1a3c18bbe8ec\",\n \"guid\" : \"377133db-2e86-4ba7-bfa2-bb3c4b06fc4d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"ed65a68a-1070-46e4-9ef5-e0494bf5555b\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"78a9efe0-4048-4912-8a96-ebb379b2e00b\"\n }\n },\n \"nickname\" : \"975f483af5d2\"\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\" : \"b15d6f3930d5\",\n \"message\" : \"67d86bb8d59c\"\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\" : \"94b4fe452b3b\",\n \"message\" : \"4596b92b8143\"\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\" : \"4b801dfca097\",\n \"message\" : \"12708549b412\"\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\" : \"5be4f2d31747\",\n \"guid\" : \"21e0836e-b5ac-4acf-be40-21e7b09faadb\",\n \"domains\" : [ ],\n \"key\" : \"be91114d3f6b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"388ff469-7333-4355-a9bb-a92d7997f358\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"55cbb145-4ceb-4b0c-898d-2978c952972f\"\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\" : \"fd4faad97cfc\",\n \"guid\" : \"82c9a78f-faa6-4efe-83dd-7f5c3b4d689b\",\n \"domains\" : [ ],\n \"key\" : \"5ee0400c5aaf\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"f8cbbd68-f069-4440-9b29-e52bd375eb47\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"c8119697-0512-4fef-93a8-20aad0eed970\"\n }\n },\n \"visibility\" : \"organization\",\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\" : \"4c15760658e1\",\n \"domains\" : [ \"7f0832b2ab3e\" ],\n \"key\" : \"5b259066c281\",\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\" : \"4c15760658e1\",\n \"domains\" : [ \"7f0832b2ab3e\" ],\n \"key\" : \"5b259066c281\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"3181032d9b27\",\n \"guid\" : \"8898cd94-77cc-4468-87c8-3da0c5856081\",\n \"domains\" : [ ],\n \"key\" : \"2cae83f06ff4\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"8e40ba90-8fce-4501-b8fa-2fb707250fa8\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"88f30ed4-3654-49f6-b09c-76d265680e92\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"4c15760658e1\",\n \"domains\" : [ \"7f0832b2ab3e\" ],\n \"key\" : \"5b259066c281\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"ecc3abfeb84b\",\n \"message\" : \"2601e3278fd8\"\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\" : \"5fb086b8eb2a\",\n \"domains\" : [ \"209bb82b068e\" ],\n \"key\" : \"6ee59e0146a1\",\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\" : \"5fb086b8eb2a\",\n \"domains\" : [ \"209bb82b068e\" ],\n \"key\" : \"6ee59e0146a1\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"89ece4605afc\",\n \"guid\" : \"1137fa0d-fcec-4641-850f-366e3444f48c\",\n \"domains\" : [ ],\n \"key\" : \"e0b8e7b17107\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"efe1a122-ee4d-4706-9e61-f0e6f977670a\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"b5cf6b1c-4937-4201-8083-d8581ce36a72\"\n }\n },\n \"visibility\" : \"user\",\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\" : \"5fb086b8eb2a\",\n \"domains\" : [ \"209bb82b068e\" ],\n \"key\" : \"6ee59e0146a1\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"99829b20303d\",\n \"message\" : \"42dc87c8ec7f\"\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\" : \"4d964f8f-b59e-4074-9aab-c7b5749b92b3\",\n \"attribute\" : {\n \"guid\" : \"628ce50f-5971-492a-8f2d-b59bf5240461\",\n \"name\" : \"34bd9a52cc96\"\n },\n \"value\" : \"4aa3086bf4c5\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"1fd990be-e88f-4fcd-b575-c0b1072b7630\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"38242d42-ce73-4854-85eb-71333a505e38\"\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\" : \"954e4e33-c31e-4afc-b88a-9df8544c9923\",\n \"attribute\" : {\n \"guid\" : \"c13fe05d-4d18-4c13-a751-289f422101dc\",\n \"name\" : \"54c566cbf464\"\n },\n \"value\" : \"a391072a082c\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"33243809-72a7-48cd-86be-2e7b0c31d242\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"ac6932ce-12a6-42a0-b080-68682bf3f58a\"\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\" : \"76cac35eb486\"\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\" : \"76cac35eb486\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"a547651e-dfd7-4c0a-bb9a-54d2bc0ba3b1\",\n \"attribute\" : {\n \"guid\" : \"f40b6b94-d3b8-4d82-9c4a-b9ec0d892fe3\",\n \"name\" : \"fed426e09f83\"\n },\n \"value\" : \"96528ee6cd00\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"15a49e88-9775-43bd-b7a6-b30d4df8832b\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"32952a3f-cd48-4c03-9744-5de5264ab80e\"\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\" : \"76cac35eb486\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"a190dc41-2bb2-46d9-9eb6-e7c8a867262e\",\n \"attribute\" : {\n \"guid\" : \"36c67fa7-0ce6-4f86-8f98-12a9715d5c57\",\n \"name\" : \"ffbc1ca1e630\"\n },\n \"value\" : \"3398af128b30\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"e28f227b-0649-4fd0-a4bd-c5c15aa6c568\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"d6d4969d-fa4b-4cc0-bc71-0749242c5748\"\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\" : \"76cac35eb486\"\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\" : \"76cac35eb486\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"67258a1a2c50\",\n \"message\" : \"7cbb83ec9f5b\"\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\" : \"f88072aca216\",\n \"password\" : \"b11c23556632\"\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\" : \"f88072aca216\",\n \"password\" : \"b11c23556632\"\n}", "mode" : "raw" } }, "body" : "{\n \"user\" : {\n \"name\" : \"8d2caafdf0e0\",\n \"email\" : \"8ed4e0ece6a1\",\n \"guid\" : \"b898f582-08d0-4b9d-9c45-cf2af88a7467\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"edbf9630-862e-48ec-a968-7db40d4c9af0\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"07c90771-63bc-4ce1-bb2b-90dbe4bf42cb\"\n }\n },\n \"nickname\" : \"b900188395d4\"\n },\n \"session\" : {\n \"id\" : \"d290117b2de9\",\n \"expires_at\" : \"2026-10-18T15:41:39.917Z\"\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\" : \"f88072aca216\",\n \"password\" : \"b11c23556632\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"20c3bd6da628\",\n \"message\" : \"1783a5a4b3c9\"\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\" : \"bbfa181e39ee\"\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\" : \"bbfa181e39ee\"\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\" : \"bbfa181e39ee\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"a5e3bc17c228\",\n \"message\" : \"48e0bf96ee59\"\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\" : \"b1c95fe26362\",\n \"guid\" : \"982d4ced-3798-4723-914a-f010710e59d0\",\n \"domains\" : [ ],\n \"key\" : \"9f6dda57dce7\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"d98332c7-0e23-448c-8bb8-ddc739d2dfb3\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"77837cb1-8e93-4fac-a3eb-b5af2e84ac75\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"3696a04d-a11b-4393-9160-5cdab82519fe\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"b03f452b-93f9-4723-b5df-0b13bd3db281\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"3c3f2450-6d7a-419a-abef-c3189514bd11\"\n }\n },\n \"publication\" : \"membership_requests.create\",\n \"user\" : {\n \"name\" : \"8ee05901560c\",\n \"email\" : \"61aa9b38af5a\",\n \"guid\" : \"c4a9f1b9-9166-4824-93c9-a611c57e985a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"2c45021e-1a19-45f7-b306-644192017002\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"a560195c-d0a6-48fd-9532-13a6d6ab5ea5\"\n }\n },\n \"nickname\" : \"c1bb55a27fad\"\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\" : \"0ea141018e6f\",\n \"guid\" : \"71834420-d1c5-45bc-9bf5-dd8d15bc066c\",\n \"domains\" : [ ],\n \"key\" : \"8faeb9868e2b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"a895016b-9a1c-4483-a015-abcfbb238795\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"3445c0e2-e848-40b0-ad11-72aefd1019cd\"\n }\n },\n \"visibility\" : \"user\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"d5c02de5-91e2-4337-acc5-1207a06bd455\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"e954e0d5-51a4-4ad6-84af-161816eb6760\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"22878884-51a3-47e5-a779-d0d74e639ec4\"\n }\n },\n \"publication\" : \"memberships.create\",\n \"user\" : {\n \"name\" : \"d413829a6f94\",\n \"email\" : \"bd314fe26c71\",\n \"guid\" : \"750f66c7-42ae-4ba1-b081-2f9e9f1e31db\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.917Z\",\n \"created_by\" : {\n \"guid\" : \"717c2deb-9d46-42bb-bc92-49f672376509\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.917Z\",\n \"updated_by\" : {\n \"guid\" : \"bbd461d7-1827-40ee-aa40-98c3418d1560\"\n }\n },\n \"nickname\" : \"f2bad321bd7c\"\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\" : \"7086bbbf7488\",\n \"user_guid\" : \"d53294db-4e8e-4fd1-b651-a29d8275d9e7\",\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\" : \"7086bbbf7488\",\n \"user_guid\" : \"d53294db-4e8e-4fd1-b651-a29d8275d9e7\",\n \"publication\" : \"applications.create\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"name\" : \"7a9f9dc89d09\",\n \"guid\" : \"3f46448f-8f90-47c7-8145-af96a22cf4e4\",\n \"domains\" : [ ],\n \"key\" : \"e583e217f5b0\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"a9f184d9-d875-41a9-b46b-5970a09f9d74\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"8ca2795c-21f3-4725-986d-199d6f4382f1\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"fc52bf41-70a8-46c9-b69a-4dd7a252a9a5\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"e4a78631-e21f-4188-bd55-df755ee6fee9\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"02885a72-d003-4ca9-9b29-1ef72f6aa814\"\n }\n },\n \"publication\" : \"applications.create\",\n \"user\" : {\n \"name\" : \"6ec131bddd8b\",\n \"email\" : \"7674f970b570\",\n \"guid\" : \"3937452b-b387-426e-96f9-e5a413a38205\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"98f86ada-a725-4671-88d0-da7c4a409abd\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"899b1418-883a-472c-8a68-a057828293ef\"\n }\n },\n \"nickname\" : \"435b601b6ae7\"\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\" : \"7086bbbf7488\",\n \"user_guid\" : \"d53294db-4e8e-4fd1-b651-a29d8275d9e7\",\n \"publication\" : \"applications.create\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"975d0c2d7268\",\n \"message\" : \"4be4a3a6620e\"\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\" : \"5615111e-f30d-4c63-b45f-80b85dd103ac\",\n \"description\" : \"db3decbe3444\",\n \"masked_token\" : \"33215ea39daa\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"49de4baa-ea94-4f70-b3be-84fb5f57c6a3\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"67e28978-f3cc-4fde-a544-61576261871b\"\n }\n },\n \"user\" : {\n \"name\" : \"af7fdcaa5298\",\n \"email\" : \"31f2ab6dd657\",\n \"guid\" : \"fa14b83b-8e23-4473-9a8c-b5a91299419e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"3c3442de-98bb-4e2f-996f-0e8dfe6cd983\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"3fc5f609-8c60-4f1f-88b9-e6efecd139f2\"\n }\n },\n \"nickname\" : \"f6a1c1ffd10a\"\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\" : \"97cac16773a6\"\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\" : \"1a4fda52-f6b6-411f-97a2-3b4e0d3e8c40\",\n \"description\" : \"d918977e95c7\"\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\" : \"1a4fda52-f6b6-411f-97a2-3b4e0d3e8c40\",\n \"description\" : \"d918977e95c7\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"f5c0c79d-0b72-44a8-b84d-25d9a683f16a\",\n \"description\" : \"34e14a37f0c2\",\n \"masked_token\" : \"024e6fd357d2\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"ac5e5a95-dd9f-401e-bfd5-76682fa35789\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"add4283f-af82-4d28-9532-14076360ad59\"\n }\n },\n \"user\" : {\n \"name\" : \"c3be1df42cd7\",\n \"email\" : \"dabb681a156d\",\n \"guid\" : \"faa08d90-c8b9-4f69-8d7f-40fffdab87f7\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"78c905b9-4d9b-4904-b369-c63d1831ff20\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"73a3e5da-ba5a-4868-8b68-a25717c8bbdc\"\n }\n },\n \"nickname\" : \"1affdec0e4a4\"\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\" : \"1a4fda52-f6b6-411f-97a2-3b4e0d3e8c40\",\n \"description\" : \"d918977e95c7\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"be5452e2ff0f\",\n \"message\" : \"de05fdd438a4\"\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\" : \"6e414f117063\",\n \"email\" : \"e7bf6b2950f5\",\n \"guid\" : \"7e13c07c-034a-4e12-a6a6-8c6923cde278\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"fc8f9ded-f3ea-470e-85e0-de6502487458\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"5715e45e-61d1-43b6-a50c-ac71172717ee\"\n }\n },\n \"nickname\" : \"adcca04a07c5\"\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\" : \"6233bdb1fa3b\",\n \"email\" : \"c159ac22dbad\",\n \"guid\" : \"fb866754-24af-4f77-a1c7-4bc538056a6e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"a5d62b5e-bc97-4f94-b4e3-89eb22c02d4c\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"207b1d3e-3bc5-412e-ba81-8a11ebc282fc\"\n }\n },\n \"nickname\" : \"548338782930\"\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\" : \"6bd89e6b4c71\",\n \"email\" : \"8d44777748aa\",\n \"guid\" : \"8fdcb7c5-28d3-40f2-b6e9-00853e155944\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"66b67170-2141-424d-99df-11435a237812\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"e7a76ded-8871-4ff7-aad5-2cb92b040b08\"\n }\n },\n \"nickname\" : \"74027a6ce24b\"\n },\n \"session\" : {\n \"id\" : \"638d1c963f60\",\n \"expires_at\" : \"2026-10-18T15:41:39.918Z\"\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\" : \"36c8dfc0b63c\",\n \"message\" : \"c4c5d4e95a53\"\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\" : \"7d05155eb8b0\",\n \"email\" : \"27ea0cc39a8c\",\n \"guid\" : \"12f49dc5-97a6-46c0-b634-6d87e46fc185\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"3b76b6ab-df9d-4714-9cf7-df60c83d6fab\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"464f98c3-739a-49d3-9d7a-08af7025f406\"\n }\n },\n \"nickname\" : \"fabda4483a35\"\n },\n \"session\" : {\n \"id\" : \"da242ab08a6c\",\n \"expires_at\" : \"2026-10-18T15:41:39.918Z\"\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\" : \"01dff6c89997\",\n \"message\" : \"cb627ecbfd22\"\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\" : \"aaec1d38e227\",\n \"password\" : \"6e4495745f75\",\n \"nickname\" : \"d928434c6568\",\n \"name\" : \"7a5522d0a28c\"\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\" : \"aaec1d38e227\",\n \"password\" : \"6e4495745f75\",\n \"nickname\" : \"d928434c6568\",\n \"name\" : \"7a5522d0a28c\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"d6b3602e8cea\",\n \"email\" : \"5673b46f25ce\",\n \"guid\" : \"940f0f28-3c89-4c91-9fe4-39d523426959\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"6ee6d594-9c57-481f-9e90-7f96cf0e40b4\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"47619a71-0dfe-4c01-9fc9-f44d3c3a1b90\"\n }\n },\n \"nickname\" : \"feddb3093e0a\"\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\" : \"aaec1d38e227\",\n \"password\" : \"6e4495745f75\",\n \"nickname\" : \"d928434c6568\",\n \"name\" : \"7a5522d0a28c\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"1a3778710c79\",\n \"message\" : \"7f9a0b01abbb\"\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\" : \"61b33278a35e\",\n \"nickname\" : \"1b231666c553\",\n \"name\" : \"6069c15e5dff\"\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\" : \"61b33278a35e\",\n \"nickname\" : \"1b231666c553\",\n \"name\" : \"6069c15e5dff\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"586824ebba1f\",\n \"email\" : \"56e5d7b91fa2\",\n \"guid\" : \"3c549be2-bb43-4d82-b901-d4bd24cf7803\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"079c7e20-02da-4441-ab68-aefa3e2a8ded\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"917c5741-0638-426a-be67-739476032e4a\"\n }\n },\n \"nickname\" : \"c7a686581c5e\"\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\" : \"61b33278a35e\",\n \"nickname\" : \"1b231666c553\",\n \"name\" : \"6069c15e5dff\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"55c8262d1788\",\n \"message\" : \"d7f44713ed2e\"\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" : "\"b4cbc39926a1\"", "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" : "\"b4cbc39926a1\"", "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\" : \"43f3c764-7569-4b36-a429-64290f77fd55\",\n \"service\" : {\n \"name\" : \"40399ff2010f\",\n \"description\" : \"bc50be6715fd\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"83a617096d02\"\n },\n \"organization\" : {\n \"key\" : \"58d1fcf72009\"\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\" : \"f594c518b212\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"80786278-7e42-4a06-8a49-b2c4fca9cb20\",\n \"key\" : \"925514403218\"\n },\n \"organization\" : {\n \"guid\" : \"6ed2f6d0-3829-4dee-bb3b-3ce4be546b39\",\n \"key\" : \"855763a86f43\"\n },\n \"original\" : {\n \"type\" : \"avro_idl\",\n \"data\" : \"6e5ecd70b013\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"bd15d4f4-9e7a-44f0-921f-e51b6ed8af5f\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"5e665c7e-5d6a-4a6c-acd6-5d10aeb1d479\"\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\" : \"8515c7b6-eb4c-414a-9411-581ff9d6f513\",\n \"service\" : {\n \"name\" : \"a23332af26a1\",\n \"description\" : \"f7e8cb2d92a3\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"b1b65df23026\"\n },\n \"organization\" : {\n \"key\" : \"812e80e5acd2\"\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\" : \"c42a58582f0b\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"70de28a1-b2ae-47a9-827c-55ef27fc06f4\",\n \"key\" : \"c7360e7cb65c\"\n },\n \"organization\" : {\n \"guid\" : \"13b36b39-1fa9-42a4-bc90-946d7a159b28\",\n \"key\" : \"d161498ea05b\"\n },\n \"original\" : {\n \"type\" : \"api_json\",\n \"data\" : \"745cf5b8bbd0\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"7da321fa-a4cd-4f7d-b5c8-95e65c74ab5e\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"13abdaba-2cc6-4a61-926a-efe3d16b23fd\"\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\" : \"swagger\",\n \"data\" : \"f45c04a1ddea\"\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\" : \"swagger\",\n \"data\" : \"f45c04a1ddea\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"44d104db-6326-415c-9759-29f054101593\",\n \"service\" : {\n \"name\" : \"f0bb77b0502e\",\n \"description\" : \"b427fc72aaa4\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"56815221d7ee\"\n },\n \"organization\" : {\n \"key\" : \"f9d07c7879c3\"\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\" : \"bdd190bcf952\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"f8fd7f52-a950-4ea9-9d15-a0c2b8efdbdf\",\n \"key\" : \"193cb6841c04\"\n },\n \"organization\" : {\n \"guid\" : \"9c46e9c7-b74a-46bc-a0c1-a452c4970af3\",\n \"key\" : \"c04da537eb0a\"\n },\n \"original\" : {\n \"type\" : \"avro_idl\",\n \"data\" : \"06923c12854c\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"e20298e5-0ddc-4988-9555-b30ed00c710d\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"12af28be-3fe6-43dd-8b27-b51c04a3abe0\"\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\" : \"swagger\",\n \"data\" : \"f45c04a1ddea\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"43411294f980\",\n \"message\" : \"79a3118e44ec\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Upsert a version of an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"api_json\",\n \"data\" : \"15b3422580fb\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "name" : "PUT /:orgKey/:applicationKey/:version", "description" : { "content" : "Upsert a version of an application" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - version", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Upsert a version of an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"api_json\",\n \"data\" : \"15b3422580fb\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"c859b120-4833-44ed-978c-abf1a44b5b20\",\n \"service\" : {\n \"name\" : \"4a3bf8318278\",\n \"description\" : \"6f398c69e827\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"b7551e49e5ff\"\n },\n \"organization\" : {\n \"key\" : \"5b067a1c4db0\"\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\" : \"29e5fb3f4545\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"5025d6fc-81bd-4116-8709-cdd9c3688b21\",\n \"key\" : \"6a5b1fc574aa\"\n },\n \"organization\" : {\n \"guid\" : \"60fe5a6e-aa3d-4ee7-921e-5e19af009f46\",\n \"key\" : \"42e376c10e98\"\n },\n \"original\" : {\n \"type\" : \"api_json\",\n \"data\" : \"0d65ce329ad8\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"b3499de3-1f85-4eb6-8a1a-28a73cedc1a2\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"fa9b7ae0-8276-4dda-9e00-89bd61147fac\"\n }\n }\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Upsert a version of an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"api_json\",\n \"data\" : \"15b3422580fb\"\n },\n \"visibility\" : \"public\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"805ddb9c7a1b\",\n \"message\" : \"fa701962e5a9\"\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\" : \"0e4af371-3893-41b5-b30f-7e326e5828d7\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"dedb0b29-0c92-45ec-9883-51eb84f89465\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"7320a09d-3830-40dc-95e3-93071e16a64a\"\n }\n },\n \"user\" : {\n \"name\" : \"60f9d76bbbff\",\n \"email\" : \"a0d2c0aa9bb0\",\n \"guid\" : \"0a20f1e8-8bec-4140-9ea8-62aafca9398c\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"108e145c-a3aa-4802-8129-90f4f9624a7b\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"f390aee1-a8dd-49b2-b598-c0cc5c72189a\"\n }\n },\n \"nickname\" : \"90e604801f85\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"ed35e4e0-b457-4b6b-9db9-9b41c7f10df1\",\n \"key\" : \"3fe822e554d7\"\n },\n \"name\" : \"dc3cb9aa535f\",\n \"guid\" : \"5d38a19d-aa79-40f9-b5bf-8768a71eef6e\",\n \"description\" : \"fd8b89ddb77c\",\n \"last_updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"key\" : \"6bee184b3404\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"b827196c-6a6a-4d11-8c00-fa176af37a55\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"e0d718a7-6033-4dd5-92c8-9af058dbec3b\"\n }\n },\n \"visibility\" : \"user\"\n },\n \"organization\" : {\n \"name\" : \"7fd18f480d71\",\n \"guid\" : \"546d82db-1838-4b9a-8586-8b2098e4bc72\",\n \"domains\" : [ ],\n \"key\" : \"feb431096923\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"8257ff9d-fa82-4c8c-ae04-e30bf6b62732\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"9b2aa0c8-926b-4e8b-a85f-fc205051ea7d\"\n }\n },\n \"visibility\" : \"public\",\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\" : \"e100ef3a-9d88-4709-97ac-dba225901b46\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"a891217b-3aba-48fc-b95f-78ccd7352059\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"8eccae73-7745-4d58-b754-a7c5ee66d0d9\"\n }\n },\n \"user\" : {\n \"name\" : \"4d15bdbd4c21\",\n \"email\" : \"33ece04c7c94\",\n \"guid\" : \"0ea0af35-55e7-4cda-a4f9-9595a9593372\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"b110d83f-f105-4072-af6c-77d670fbda6f\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"552ecd77-39ae-4f89-b938-e07998b0adc6\"\n }\n },\n \"nickname\" : \"5cb821987ad2\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"e80aa05d-2858-4150-bceb-4e0090648529\",\n \"key\" : \"e81ad6930a90\"\n },\n \"name\" : \"412a7554b932\",\n \"guid\" : \"c6e5b40b-5367-4316-affb-1418f24e76b2\",\n \"description\" : \"73ba15ab69f0\",\n \"last_updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"key\" : \"7883d6ab11e1\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"77b5a359-f14f-4433-a729-e96f24a60d09\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"167ce626-e55c-49af-924e-d93df83fcaaf\"\n }\n },\n \"visibility\" : \"public\"\n },\n \"organization\" : {\n \"name\" : \"97158838de0d\",\n \"guid\" : \"a17f2416-7ade-4069-8181-cea19165ccdc\",\n \"domains\" : [ ],\n \"key\" : \"496c4050d2cd\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"e4dec63f-795a-483e-9548-8ae8d1ee357a\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"c741d551-b546-4c7e-bee5-1a1cd76b86dc\"\n }\n },\n \"visibility\" : \"user\",\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\" : \"332e68fb-73f4-4bda-8683-cbfd0e86d3ce\",\n \"organization_key\" : \"724cf4d088da\",\n \"application_key\" : \"7abbb2c39863\"\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\" : \"332e68fb-73f4-4bda-8683-cbfd0e86d3ce\",\n \"organization_key\" : \"724cf4d088da\",\n \"application_key\" : \"7abbb2c39863\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"6389b199-67c3-406f-b0e7-83b2c3ee9036\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"1a6857ab-fb31-4243-9542-0b2673529364\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"e3a3af41-c2f2-49bf-a21f-fd250e46e946\"\n }\n },\n \"user\" : {\n \"name\" : \"77b72d736000\",\n \"email\" : \"fad602f2d651\",\n \"guid\" : \"4c0329ed-75df-4bf3-9adc-86449bcc602f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"0820bb0a-75e9-41b8-8377-297c72c58c52\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"cfb4386a-61d0-41bf-8fd3-18d5d0795f0e\"\n }\n },\n \"nickname\" : \"ba1fc28c1fc7\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"2cacd560-0746-4256-a3bb-adb203fb6b6b\",\n \"key\" : \"ddac80f86dad\"\n },\n \"name\" : \"a90e7074cd4c\",\n \"guid\" : \"625b3a40-4415-46a9-92e0-9701ab3f9bbd\",\n \"description\" : \"2803417796da\",\n \"last_updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"key\" : \"17b41a2e7f1e\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"b558bd6c-6e8d-4464-909d-d5c509921d2f\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"1456a18e-e00d-4895-a06f-bf87aefffd14\"\n }\n },\n \"visibility\" : \"organization\"\n },\n \"organization\" : {\n \"name\" : \"87213f314742\",\n \"guid\" : \"6300e788-94de-4433-ad92-e3309da8d07e\",\n \"domains\" : [ ],\n \"key\" : \"243a2398ade4\",\n \"audit\" : {\n \"created_at\" : \"2026-10-18T15:41:39.918Z\",\n \"created_by\" : {\n \"guid\" : \"958fdf34-f73c-4b2e-bd9b-dcfaab0e854f\"\n },\n \"updated_at\" : \"2026-10-18T15:41:39.918Z\",\n \"updated_by\" : {\n \"guid\" : \"f4e0fa86-f3c1-43dd-b6f8-21edc1933408\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n }\n}", "code" : 201 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new watch." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"user_guid\" : \"332e68fb-73f4-4bda-8683-cbfd0e86d3ce\",\n \"organization_key\" : \"724cf4d088da\",\n \"application_key\" : \"7abbb2c39863\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"ca2a2ae51b5c\",\n \"message\" : \"1506738c85b4\"\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" } ] }