{ "info" : { "name" : "apibuilder api", "schema" : "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description" : { "content" : "Host API documentation for applications providing REST APIs, facilitating the design of good resource first APIs." }, "version" : "0.12.14" }, "item" : [ { "name" : "applications", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ { "key" : "name", "disabled" : true, "description" : { "content" : "The name of an application. Case in-sensitive. Exact match" } }, { "key" : "guid", "disabled" : true, "description" : { "content" : "The guid of an application. Exact match" } }, { "key" : "key", "disabled" : true, "description" : { "content" : "The key of an application. Case in-sensitive. Exact match" } }, { "key" : "has_version", "disabled" : true, "description" : { "content" : "If true, we return applications that have at least one version. If false, we return applications that have no versions in the system" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to search applications" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Search all applications. Results are always paginated." }, "header" : [ ] }, "name" : "GET /:orgKey", "description" : { "content" : "Search all applications. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [application]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey" ], "query" : [ { "key" : "name", "disabled" : true, "description" : { "content" : "The name of an application. Case in-sensitive. Exact match" } }, { "key" : "guid", "disabled" : true, "description" : { "content" : "The guid of an application. Exact match" } }, { "key" : "key", "disabled" : true, "description" : { "content" : "The key of an application. Case in-sensitive. Exact match" } }, { "key" : "has_version", "disabled" : true, "description" : { "content" : "If true, we return applications that have at least one version. If false, we return applications that have no versions in the system" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to search applications" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Search all applications. Results are always paginated." }, "header" : [ ] }, "body" : "[ {\n \"organization\" : {\n \"guid\" : \"49137d2e-9991-4e69-a4a6-2665fa33e5bd\",\n \"key\" : \"8ca9dd5a43af\"\n },\n \"name\" : \"fb0e5673fa2f\",\n \"guid\" : \"5cb9dfe6-3bb3-468e-86f0-95af38f60028\",\n \"description\" : \"bb06d1f307e3\",\n \"key\" : \"bb15a1f6010b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.460Z\",\n \"created_by\" : {\n \"guid\" : \"75dfad39-9bfc-4e41-95d9-04d0d22e6c3f\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.460Z\",\n \"updated_by\" : {\n \"guid\" : \"80d86c8e-59e8-45f2-ab03-14166121a878\"\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\" : \"e49d7ad3f3dd\",\n \"key\" : \"7418b20cdac2\",\n \"description\" : \"da53a0310912\",\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\" : \"e49d7ad3f3dd\",\n \"key\" : \"7418b20cdac2\",\n \"description\" : \"da53a0310912\",\n \"visibility\" : \"organization\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"5dedff66-5e06-4cd9-8577-baf5f4583a68\",\n \"key\" : \"9008517baf19\"\n },\n \"name\" : \"ee8acf72e459\",\n \"guid\" : \"62272e19-a59b-4053-822a-397da007c6c1\",\n \"description\" : \"7aa3f634000a\",\n \"key\" : \"731ca8b6b54b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.460Z\",\n \"created_by\" : {\n \"guid\" : \"d21493fc-9c74-4910-b5d0-466efb3a8584\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.460Z\",\n \"updated_by\" : {\n \"guid\" : \"5bb0b8dc-dbd0-4474-a344-6cbf0d3fed0e\"\n }\n },\n \"visibility\" : \"organization\"\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\" : \"e49d7ad3f3dd\",\n \"key\" : \"7418b20cdac2\",\n \"description\" : \"da53a0310912\",\n \"visibility\" : \"organization\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"b9a68d7aee8c\",\n \"message\" : \"1fb70ce85fa4\"\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\" : \"64e69a87e5a7\",\n \"key\" : \"dec6bc3e05bc\",\n \"description\" : \"3b551adeabbe\",\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\" : \"64e69a87e5a7\",\n \"key\" : \"dec6bc3e05bc\",\n \"description\" : \"3b551adeabbe\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"97788c5f-52bd-43eb-8f81-4392b4ffbcfe\",\n \"key\" : \"c89c43913445\"\n },\n \"name\" : \"fd02e4342bb9\",\n \"guid\" : \"0eaf80c1-ce81-4e7d-b3d6-772c7cd7178c\",\n \"description\" : \"9b56bf1a7e34\",\n \"key\" : \"2096e3b3e3b0\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.461Z\",\n \"created_by\" : {\n \"guid\" : \"e794624c-65c1-4445-8f42-441bf272e7e0\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.461Z\",\n \"updated_by\" : {\n \"guid\" : \"42fd54ea-a151-4eb3-a417-ea9cd4ad4625\"\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\" : \"64e69a87e5a7\",\n \"key\" : \"dec6bc3e05bc\",\n \"description\" : \"3b551adeabbe\",\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"1b2f769ad7a5\",\n \"message\" : \"fbc211d26479\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific application and its associated versions." }, "header" : [ ] }, "name" : "DELETE /:orgKey/:applicationKey", "description" : { "content" : "Deletes a specific application and its associated versions." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific application and its associated versions." }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/move", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", "move" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Moves application to a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"org_key\" : \"b99fcfabd0c0\"\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\" : \"b99fcfabd0c0\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"guid\" : \"88cdb730-7b11-446f-bd27-67f2794ec762\",\n \"key\" : \"2de03aed118f\"\n },\n \"name\" : \"c5ceffcc38fd\",\n \"guid\" : \"97968e72-1bc0-4624-9bee-d56669d01d60\",\n \"description\" : \"4b33427640c5\",\n \"key\" : \"62dde4c05065\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.461Z\",\n \"created_by\" : {\n \"guid\" : \"91b3f301-f6c0-44fd-afb1-1df6b56b0d38\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.461Z\",\n \"updated_by\" : {\n \"guid\" : \"142cf0bb-e1dd-4544-9172-5c9ac6423e8e\"\n }\n },\n \"visibility\" : \"user\"\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\" : \"b99fcfabd0c0\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"4684cba201a9\",\n \"message\" : \"1efcfebc375a\"\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\" : \"41825ce4-2a1b-4d40-a0bf-8825b00b0875\",\n \"name\" : \"23beaff6cb1e\",\n \"description\" : \"2dea52b92437\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.461Z\",\n \"created_by\" : {\n \"guid\" : \"ca91ac3b-9cbe-4844-9f91-18ce651f939c\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.461Z\",\n \"updated_by\" : {\n \"guid\" : \"aab2c72c-d476-4649-825a-85c3bd22b3f3\"\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\" : \"7ac8910e-d7c5-4a88-bc0b-b95be68233c1\",\n \"name\" : \"5eb085d11787\",\n \"description\" : \"0084507e861f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.461Z\",\n \"created_by\" : {\n \"guid\" : \"84fb6849-8f3c-40a9-a6d3-cb6d1f02c4eb\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.461Z\",\n \"updated_by\" : {\n \"guid\" : \"a7628cf6-626f-4ec2-80cd-7a9a9b1876bb\"\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\" : \"f9446947b093\",\n \"description\" : \"2aa44290cadb\"\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\" : \"f9446947b093\",\n \"description\" : \"2aa44290cadb\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"0d1d86c4-7a37-4a82-bdba-466e19777b95\",\n \"name\" : \"214ec7041654\",\n \"description\" : \"9784f5179b52\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.462Z\",\n \"created_by\" : {\n \"guid\" : \"08d3bc15-585d-4434-a6df-e0676f3ac626\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.462Z\",\n \"updated_by\" : {\n \"guid\" : \"87b6f899-f1b7-4399-9639-44bf2931ff4c\"\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\" : \"f9446947b093\",\n \"description\" : \"2aa44290cadb\"\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\" : \"f9446947b093\",\n \"description\" : \"2aa44290cadb\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"70975a43942f\",\n \"message\" : \"f2217d3191f6\"\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\" : \"a293ac29238e\",\n \"email\" : \"87893146b91d\",\n \"guid\" : \"74298ee5-a2f1-4372-9d40-39f5c36b8fad\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.462Z\",\n \"created_by\" : {\n \"guid\" : \"f26a864e-bccb-4551-a5d0-10c880d8f30d\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.462Z\",\n \"updated_by\" : {\n \"guid\" : \"593e4869-442a-461b-8043-a949083d4ff8\"\n }\n },\n \"nickname\" : \"873790066cfb\"\n },\n \"session\" : {\n \"id\" : \"a3800cc002d3\",\n \"expires_at\" : \"2026-10-17T16:39:51.462Z\"\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-17T16:39:51.462Z\",\n \"changed_by\" : {\n \"guid\" : \"3e81ff90-e528-4e4b-862f-8b0bc089fa07\",\n \"nickname\" : \"74fef128e0c5\"\n },\n \"diff\" : {\n \"type\" : \"diff_breaking\",\n \"description\" : \"model removed: user\"\n },\n \"from_version\" : {\n \"guid\" : \"dbc6aa7a-cd74-4f60-baa5-f16902584f8f\",\n \"version\" : \"4b5c86c613ec\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.462Z\",\n \"created_by\" : {\n \"guid\" : \"39e19c59-8c4f-4c80-82ab-2c34a347600e\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.462Z\",\n \"updated_by\" : {\n \"guid\" : \"8adb1e64-82b0-4abb-90ec-7f381f289779\"\n }\n },\n \"application\" : {\n \"guid\" : \"7fccf4b4-7b48-4058-9e34-f51037f20023\",\n \"key\" : \"27eb8a713963\"\n },\n \"organization\" : {\n \"guid\" : \"e7771468-3a00-419d-a3c4-88c3cbbb1422\",\n \"key\" : \"bc4a837da606\"\n },\n \"guid\" : \"c38a543b-5d8b-4df7-8232-17d2bfb74a7d\",\n \"to_version\" : {\n \"guid\" : \"4107e716-1a79-41fa-a4c1-40e631803fc1\",\n \"version\" : \"5554d48b6c47\"\n }\n} ]", "code" : 200 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "code", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/:generatorKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", ":generatorKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to generate code" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to generate code" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "The version of this application. Can be 'latest'" }, "disabled" : false }, { "key" : "generatorKey", "value" : "{{generatorKey}}", "description" : { "content" : "The key of the generator to invoke" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ ] }, "name" : "GET /:orgKey/:applicationKey/:version/:generatorKey", "description" : { "content" : "Generate code for a specific version of an application." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - code", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/:generatorKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", ":generatorKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to generate code" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to generate code" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "The version of this application. Can be 'latest'" }, "disabled" : false }, { "key" : "generatorKey", "value" : "{{generatorKey}}", "description" : { "content" : "The key of the generator to invoke" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ ] }, "body" : "{\n \"generator\" : {\n \"service\" : {\n \"guid\" : \"abcfc294-ac48-4a94-b117-e1b39966caef\",\n \"uri\" : \"a9cb9642e692\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.462Z\",\n \"created_by\" : {\n \"guid\" : \"59d88ffd-6877-474c-b98f-148d6c31106c\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.462Z\",\n \"updated_by\" : {\n \"guid\" : \"8120779e-ad5d-409e-8975-9a21f46e3035\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"1260db1150e9\",\n \"description\" : \"a591a8e4c8bf\",\n \"attributes\" : [ ],\n \"key\" : \"076a0d2bf92e\",\n \"language\" : \"scala\"\n }\n },\n \"source\" : \"df1ef234513d\",\n \"files\" : [ ]\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/:generatorKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", ":generatorKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to generate code" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to generate code" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "The version of this application. Can be 'latest'" }, "disabled" : false }, { "key" : "generatorKey", "value" : "{{generatorKey}}", "description" : { "content" : "The key of the generator to invoke" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ ] }, "code" : 404 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/:generatorKey", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", ":generatorKey" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "The organization key for which to generate code" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "The application key for which to generate code" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "The version of this application. Can be 'latest'" }, "disabled" : false }, { "key" : "generatorKey", "value" : "{{generatorKey}}", "description" : { "content" : "The key of the generator to invoke" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generate code for a specific version of an application." }, "header" : [ ] }, "body" : "[ {\n \"code\" : \"fd7b0c459f7c\",\n \"message\" : \"a07c45cf258c\"\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\" : \"bdcfec16ab29\",\n \"message\" : \"86de101dfa45\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/domains/:orgKey/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "domains", ":orgKey", ":name" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Remove this domain from this organization" }, "header" : [ ] }, "name" : "DELETE /domains/:orgKey/:name", "description" : { "content" : "Remove this domain from this organization" }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/domains/:orgKey/:name", "host" : [ "{{BASE_URL}}" ], "path" : [ "domains", ":orgKey", ":name" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "name", "value" : "{{name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Remove this domain from this organization" }, "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "email_verification_confirmation_forms", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/email_verification_confirmations", "host" : [ "{{BASE_URL}}" ], "path" : [ "email_verification_confirmations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Validate an email address using a token." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"token\" : \"2932393283ce\"\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\" : \"2932393283ce\"\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\" : \"2932393283ce\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"b5820b627272\",\n \"message\" : \"d98e661ae190\"\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\" : \"30a67c98-9bcd-4ee7-a0a6-b92f165c70c3\",\n \"uri\" : \"a6249f845fc7\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.464Z\",\n \"created_by\" : {\n \"guid\" : \"e0a51032-115d-499d-815d-69c2e403c626\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.464Z\",\n \"updated_by\" : {\n \"guid\" : \"f4d01c2b-4b0c-46ef-91aa-0929b4bab8a4\"\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\" : \"c388fc57-ece6-40a5-af7c-733757d10097\",\n \"uri\" : \"6d17b5431515\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.464Z\",\n \"created_by\" : {\n \"guid\" : \"ec9628a3-b60e-4e62-91d7-4f2389d6a632\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.464Z\",\n \"updated_by\" : {\n \"guid\" : \"f316d6a7-1eb2-4b4e-ae14-568c6905bae2\"\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\" : \"bfa233a25e7a\"\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\" : \"bfa233a25e7a\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"f8f5258e-9035-4822-a4b6-997d6068cdb4\",\n \"uri\" : \"00fc696f8475\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.464Z\",\n \"created_by\" : {\n \"guid\" : \"3336f311-a1d7-44d4-8f18-4e952bcb74a3\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.464Z\",\n \"updated_by\" : {\n \"guid\" : \"47845cc8-5515-4679-afe9-76021c362e18\"\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\" : \"bfa233a25e7a\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"1c1a9120e94d\",\n \"message\" : \"33d2a881daaf\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a generator service." }, "header" : [ ] }, "name" : "DELETE /generator_services/:guid", "description" : { "content" : "Deletes a generator service." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a generator service." }, "header" : [ ] }, "code" : 204 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a generator service." }, "header" : [ ] }, "code" : 404 }, { "name" : "Example 403 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generator_services/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "generator_services", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a generator service." }, "header" : [ ] }, "code" : 403 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "generator_with_services", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/generators", "host" : [ "{{BASE_URL}}" ], "path" : [ "generators" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Filter to generator with this guid" } }, { "key" : "service_guid", "disabled" : true, "description" : { "content" : "Filter to generator from this service" } }, { "key" : "service_uri", "disabled" : true, "description" : { "content" : "Filter to generator from this service URI" } }, { "key" : "attribute_name", "disabled" : true, "description" : { "content" : "Filter to generators that use this attribute" } }, { "key" : "key", "disabled" : true, "description" : { "content" : "Filter to generator with this key" } }, { "key" : "limit", "value" : "100", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "List all available generators" }, "header" : [ ] }, "name" : "GET /generators", "description" : { "content" : "List all available generators" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [generator_with_service]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/generators", "host" : [ "{{BASE_URL}}" ], "path" : [ "generators" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Filter to generator with this guid" } }, { "key" : "service_guid", "disabled" : true, "description" : { "content" : "Filter to generator from this service" } }, { "key" : "service_uri", "disabled" : true, "description" : { "content" : "Filter to generator from this service URI" } }, { "key" : "attribute_name", "disabled" : true, "description" : { "content" : "Filter to generators that use this attribute" } }, { "key" : "key", "disabled" : true, "description" : { "content" : "Filter to generator with this key" } }, { "key" : "limit", "value" : "100", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "List all available generators" }, "header" : [ ] }, "body" : "[ {\n \"service\" : {\n \"guid\" : \"fa3138dc-329c-46d7-9299-135400e33944\",\n \"uri\" : \"ab6e78358b24\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.464Z\",\n \"created_by\" : {\n \"guid\" : \"91c5ba01-99d5-4f58-9e15-570539d38583\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.464Z\",\n \"updated_by\" : {\n \"guid\" : \"08181e70-05d3-4ed0-939e-2699d565d853\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"ec30339a4438\",\n \"description\" : \"08d8f7000193\",\n \"attributes\" : [ ],\n \"key\" : \"730476ebfb94\",\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\" : \"c35a00df-64fb-488e-933f-52c5ba1c095e\",\n \"uri\" : \"d117d2c59a38\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.465Z\",\n \"created_by\" : {\n \"guid\" : \"e164c845-b87c-49bb-9b54-00432ba7f1b1\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.465Z\",\n \"updated_by\" : {\n \"guid\" : \"43186137-1273-4b7d-8d38-3aaf261fbdf1\"\n }\n }\n },\n \"generator\" : {\n \"name\" : \"c1c7475eda9b\",\n \"description\" : \"36ebd1e2efa9\",\n \"attributes\" : [ ],\n \"key\" : \"b010e6f67ca3\",\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\" : \"91ea1f55ee23\"\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\" : \"9ecf00d0-b0b9-448a-8db1-bae845215d5c\",\n \"detail\" : {\n \"type\" : \"application_summary\",\n \"guid\" : \"db9e44fc-5599-43a4-8070-1419fa60cf99\",\n \"organization\" : {\n \"guid\" : \"0f5a9274-d8d0-4945-a0ae-624ee52e45fb\",\n \"key\" : \"41602f665850\"\n },\n \"key\" : \"c7734cc2e7a3\"\n },\n \"label\" : \"45c71734af9b\",\n \"description\" : \"4aad5634ed96\"\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\" : \"5bf9fd08-1089-452c-9ba2-01ce29893436\",\n \"detail\" : {\n \"type\" : \"application_summary\",\n \"guid\" : \"c7fd097f-cc7c-4d2f-9f10-3f5feed2d6ad\",\n \"organization\" : {\n \"guid\" : \"cb367903-39ec-44d1-9d49-052529982270\",\n \"key\" : \"9cc41ac7b6e8\"\n },\n \"key\" : \"d8d6c122a021\"\n },\n \"label\" : \"8ca667603309\",\n \"description\" : \"d27691e6b2ae\"\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\" : \"04a6c4f52bed\",\n \"guid\" : \"ee528f21-fb78-4af4-b623-60cfc889f654\",\n \"domains\" : [ ],\n \"key\" : \"e4c0d6c46044\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.467Z\",\n \"created_by\" : {\n \"guid\" : \"f1e07d4f-161f-4375-9cbc-d3b0f532111a\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.467Z\",\n \"updated_by\" : {\n \"guid\" : \"7df49b9b-99bd-473d-9af1-0aa39eaaa6ab\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"631a07b1-cf06-42e7-9103-1c8ea1523dd5\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.467Z\",\n \"created_by\" : {\n \"guid\" : \"8459ec9c-4467-4140-a1ae-54c0e17866a1\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.467Z\",\n \"updated_by\" : {\n \"guid\" : \"101015ce-5de4-4960-be2e-6d5e0ec929b6\"\n }\n },\n \"user\" : {\n \"name\" : \"10e3dbbd4f13\",\n \"email\" : \"cf4a30d8489c\",\n \"guid\" : \"f1299c7d-36a2-4225-bb4b-6de02e318865\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.466Z\",\n \"created_by\" : {\n \"guid\" : \"6e1df33c-22c8-43bd-9e31-de48d49732a1\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.466Z\",\n \"updated_by\" : {\n \"guid\" : \"00b9d437-0d29-4176-8387-5688fec0420c\"\n }\n },\n \"nickname\" : \"489cb8fd68b3\"\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\" : \"63076022daf8\",\n \"guid\" : \"322e34dc-ebcc-48f4-a943-cbdbbfc4d660\",\n \"domains\" : [ ],\n \"key\" : \"59956fe536d5\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.467Z\",\n \"created_by\" : {\n \"guid\" : \"b46cbcad-74b7-4b3e-bacd-13414ee51587\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.467Z\",\n \"updated_by\" : {\n \"guid\" : \"0d8b5ece-d239-408e-90fc-c6f50666ae79\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"741950dc-d4a0-4455-ac0f-218ee654b630\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.467Z\",\n \"created_by\" : {\n \"guid\" : \"aea0e8ac-16af-498c-aad8-cae477ae15a4\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.467Z\",\n \"updated_by\" : {\n \"guid\" : \"7f703d45-ba71-4572-944f-63317902fcc6\"\n }\n },\n \"user\" : {\n \"name\" : \"7c4c2eac388e\",\n \"email\" : \"9db06894a956\",\n \"guid\" : \"844808ce-39c4-43c7-a495-163ab4f5b506\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.467Z\",\n \"created_by\" : {\n \"guid\" : \"9979b61e-6b90-4d70-a892-02dca7858890\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.467Z\",\n \"updated_by\" : {\n \"guid\" : \"9a78cfaa-c06b-4763-8a80-f264df8a113f\"\n }\n },\n \"nickname\" : \"7c68e891c84a\"\n }\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "code" : 404 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "name" : "DELETE /memberships/:guid", "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/memberships/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "memberships", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "membership_requests", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests" ], "query" : [ { "key" : "org_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "org_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "role", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all membership requests. Results are always paginated." }, "header" : [ ] }, "name" : "GET /membership_requests", "description" : { "content" : "Search all membership requests. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [membership_request]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/membership_requests", "host" : [ "{{BASE_URL}}" ], "path" : [ "membership_requests" ], "query" : [ { "key" : "org_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "org_key", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "role", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search all membership requests. Results are always paginated." }, "header" : [ ] }, "body" : "[ {\n \"organization\" : {\n \"name\" : \"7ed4b9293069\",\n \"guid\" : \"7f8b6816-5354-4574-b152-6d45d4e0e879\",\n \"domains\" : [ ],\n \"key\" : \"b55234cc297a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.467Z\",\n \"created_by\" : {\n \"guid\" : \"20d61f1c-8ac5-4692-86ab-8b655d8105ef\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.467Z\",\n \"updated_by\" : {\n \"guid\" : \"d4ffb6d0-de9d-4079-8f9b-9b6369f78ff8\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"a7eb30a0-338b-41ae-bc8c-d3a417338302\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.467Z\",\n \"created_by\" : {\n \"guid\" : \"bb55b2ff-1ee7-4eed-a1a5-3466d7348138\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.467Z\",\n \"updated_by\" : {\n \"guid\" : \"2fa5dc6d-606e-41ae-ab44-c5b46e0a09ba\"\n }\n },\n \"user\" : {\n \"name\" : \"5225464fa2bf\",\n \"email\" : \"e098905a4da5\",\n \"guid\" : \"6b9c287b-02ec-4993-b4cf-3e9dc19e4e65\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.467Z\",\n \"created_by\" : {\n \"guid\" : \"9b2baffb-0356-4527-80de-90627561cd8a\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.467Z\",\n \"updated_by\" : {\n \"guid\" : \"3dac79df-3f60-41da-97d8-2d9e7d071c99\"\n }\n },\n \"nickname\" : \"42ba55325e4f\"\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\" : \"42345a4a7f36\",\n \"guid\" : \"a1de8436-09d9-4883-9f24-4c95ed7a384c\",\n \"domains\" : [ ],\n \"key\" : \"633ed3e2c125\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.468Z\",\n \"created_by\" : {\n \"guid\" : \"134834bc-561c-46ea-9744-6454deedd5bd\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.468Z\",\n \"updated_by\" : {\n \"guid\" : \"7c5b75a6-55c4-4b5f-924c-b64a83a3219e\"\n }\n },\n \"visibility\" : \"user\",\n \"namespace\" : \"io.apicollective\"\n },\n \"role\" : \"member\",\n \"guid\" : \"bfec61c2-50ee-4da2-a26e-aa9d7ce13470\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.469Z\",\n \"created_by\" : {\n \"guid\" : \"634596d5-bcb5-429b-bdb0-eeadcbc8a366\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.469Z\",\n \"updated_by\" : {\n \"guid\" : \"d6821ad3-5cec-4d5d-8e61-49d93eb2455f\"\n }\n },\n \"user\" : {\n \"name\" : \"cbd75c7496fe\",\n \"email\" : \"ff6f209902c1\",\n \"guid\" : \"a923a0e5-2b29-42b9-b7d7-71e63a5a160d\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.467Z\",\n \"created_by\" : {\n \"guid\" : \"14acd10f-a875-446d-8ad1-3bbc6469d4d9\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.467Z\",\n \"updated_by\" : {\n \"guid\" : \"4c583fc6-08ad-4286-9871-2a5f2b9aa88f\"\n }\n },\n \"nickname\" : \"1aba17cdb35b\"\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\" : \"14d71cc2c7ec\",\n \"message\" : \"c1e80ad2348e\"\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\" : \"71c22f1b9cb0\",\n \"message\" : \"615b9f06d4e4\"\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\" : \"660f07bf1db8\",\n \"message\" : \"9152bd22c176\"\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\" : \"bb81232f4984\",\n \"guid\" : \"c932bf26-9b75-4c5c-8452-eca3022960fa\",\n \"domains\" : [ ],\n \"key\" : \"487f44800c09\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.471Z\",\n \"created_by\" : {\n \"guid\" : \"7f307134-7ab1-4a00-91cc-63d6b96639c5\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.471Z\",\n \"updated_by\" : {\n \"guid\" : \"c3d05931-a297-4351-926c-045ac7b6ccb6\"\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\" : \"4a31ed04104b\",\n \"guid\" : \"c29ac49c-925e-4fbb-9709-ec7b18bea629\",\n \"domains\" : [ ],\n \"key\" : \"79a26be109b3\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.471Z\",\n \"created_by\" : {\n \"guid\" : \"5f98c5e7-7d44-4500-91cb-c4b0150e45a3\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.471Z\",\n \"updated_by\" : {\n \"guid\" : \"e9a16b72-79ea-4c7c-ae90-622acbc30118\"\n }\n },\n \"visibility\" : \"public\",\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\" : \"bcf417076161\",\n \"domains\" : [ \"dc83f1daa99e\" ],\n \"key\" : \"db3ac6bc42b4\",\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\" : \"bcf417076161\",\n \"domains\" : [ \"dc83f1daa99e\" ],\n \"key\" : \"db3ac6bc42b4\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"f638f2255391\",\n \"guid\" : \"df10e65d-e09e-40e2-bd3a-229ba0044cdc\",\n \"domains\" : [ ],\n \"key\" : \"5c70a418c0f4\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.472Z\",\n \"created_by\" : {\n \"guid\" : \"b2de2f2e-b5a8-4b74-af5d-6536caf79956\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.472Z\",\n \"updated_by\" : {\n \"guid\" : \"215af63c-6740-4313-9008-8de9aff750d1\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"bcf417076161\",\n \"domains\" : [ \"dc83f1daa99e\" ],\n \"key\" : \"db3ac6bc42b4\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"7444e66c5e45\",\n \"message\" : \"1d2ed3a033de\"\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\" : \"6d1f81c5f4a3\",\n \"domains\" : [ \"016b7dcdb06e\" ],\n \"key\" : \"440f3905f471\",\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\" : \"6d1f81c5f4a3\",\n \"domains\" : [ \"016b7dcdb06e\" ],\n \"key\" : \"440f3905f471\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"30027e0fbc3e\",\n \"guid\" : \"8a5c6ab0-0e8d-4823-b80e-a5d2e50b8469\",\n \"domains\" : [ ],\n \"key\" : \"778815ef8273\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.472Z\",\n \"created_by\" : {\n \"guid\" : \"04c25bd9-5935-4caa-968f-9bffbdbff542\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.472Z\",\n \"updated_by\" : {\n \"guid\" : \"51e9d564-af86-4e22-9178-b94caa3a90a7\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n}", "code" : 200 }, { "name" : "Example 409 - [error]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Update an organization." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"name\" : \"6d1f81c5f4a3\",\n \"domains\" : [ \"016b7dcdb06e\" ],\n \"key\" : \"440f3905f471\",\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"792e068add7c\",\n \"message\" : \"9e107c7aeaf7\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes an organization and all of its associated applications." }, "header" : [ ] }, "name" : "DELETE /organizations/:key", "description" : { "content" : "Deletes an organization and all of its associated applications." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key" ], "query" : [ ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes an organization and all of its associated applications." }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes" ], "query" : [ { "key" : "name", "disabled" : true, "description" : { "content" : "Find the values for the attribute with this name." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns all attribute values for this organization. Results are always paginated." }, "header" : [ ] }, "name" : "GET /organizations/:key/attributes", "description" : { "content" : "Returns all attribute values for this organization. Results are always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [attribute_value]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/organizations/:key/attributes", "host" : [ "{{BASE_URL}}" ], "path" : [ "organizations", ":key", "attributes" ], "query" : [ { "key" : "name", "disabled" : true, "description" : { "content" : "Find the values for the attribute with this name." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "key", "value" : "{{key}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns all attribute values for this organization. Results are always paginated." }, "header" : [ ] }, "body" : "[ {\n \"guid\" : \"743fbc45-2533-44b2-a1f5-96f81defed24\",\n \"attribute\" : {\n \"guid\" : \"c9c0e9ac-19e9-425e-987b-bd6b085355da\",\n \"name\" : \"c0f93b6e8164\"\n },\n \"value\" : \"0e960940caba\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.472Z\",\n \"created_by\" : {\n \"guid\" : \"96fb03bb-829a-4091-ae76-2c70898d7e11\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.472Z\",\n \"updated_by\" : {\n \"guid\" : \"711ce568-23d3-42cb-bf67-c70a9d8b2606\"\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\" : \"7295ef5c-662e-49dc-b7c9-1e040eb3e182\",\n \"attribute\" : {\n \"guid\" : \"44b320c3-2dae-4fdb-bc53-7acbea0219bd\",\n \"name\" : \"d922c4084822\"\n },\n \"value\" : \"c94cd0d7506a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.472Z\",\n \"created_by\" : {\n \"guid\" : \"e35929b4-2719-4cad-bfe1-d002a67886c5\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.472Z\",\n \"updated_by\" : {\n \"guid\" : \"632e8d56-f862-4262-ae2f-462eaa4308f4\"\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\" : \"66c477d28b9c\"\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\" : \"66c477d28b9c\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"99e5100c-a55f-4486-8b7f-4b3303b485be\",\n \"attribute\" : {\n \"guid\" : \"cb2bd73a-6382-48bb-a22a-71ae196a4cc4\",\n \"name\" : \"823c62c127d7\"\n },\n \"value\" : \"b7626e82b398\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.473Z\",\n \"created_by\" : {\n \"guid\" : \"9fd2432e-26d8-48c6-b96a-2362956c4ca4\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.473Z\",\n \"updated_by\" : {\n \"guid\" : \"bfd2a583-0137-4ca7-85ad-13d9fec3270f\"\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\" : \"66c477d28b9c\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"238d7072-b273-4d1a-a5f8-707b3c48024e\",\n \"attribute\" : {\n \"guid\" : \"ea837d3d-69e1-42f6-9c66-7b6d6a05bebc\",\n \"name\" : \"03bc979d4dd8\"\n },\n \"value\" : \"37778a7580ac\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.473Z\",\n \"created_by\" : {\n \"guid\" : \"972de44c-8623-477a-9098-2f939b172ce7\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.473Z\",\n \"updated_by\" : {\n \"guid\" : \"5e233255-baaa-403c-8026-84a852fc2cb8\"\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\" : \"66c477d28b9c\"\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\" : \"66c477d28b9c\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"b606ab3ccbff\",\n \"message\" : \"30dffb048e4c\"\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\" : \"4b04dacbb089\",\n \"password\" : \"351ad0908402\"\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\" : \"4b04dacbb089\",\n \"password\" : \"351ad0908402\"\n}", "mode" : "raw" } }, "body" : "{\n \"user\" : {\n \"name\" : \"544b3a171a48\",\n \"email\" : \"85baef4e70d5\",\n \"guid\" : \"041f1484-0a7d-48b1-b60f-149e562bd467\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.474Z\",\n \"created_by\" : {\n \"guid\" : \"c95b189e-0f94-4c37-97ee-3333c8fd7475\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.474Z\",\n \"updated_by\" : {\n \"guid\" : \"0b520ce8-a655-47ef-8901-7ecfd9c8fa4f\"\n }\n },\n \"nickname\" : \"2a65416efd9b\"\n },\n \"session\" : {\n \"id\" : \"26792adab203\",\n \"expires_at\" : \"2026-10-17T16:39:51.474Z\"\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\" : \"4b04dacbb089\",\n \"password\" : \"351ad0908402\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"fb57397af6f4\",\n \"message\" : \"04e960b84efb\"\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\" : \"859982270d2a\"\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\" : \"859982270d2a\"\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\" : \"859982270d2a\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"58a6611bb012\",\n \"message\" : \"854753e23542\"\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\" : \"799f90037ebd\",\n \"guid\" : \"43729f25-6ba5-48ae-8e9a-02173f94681c\",\n \"domains\" : [ ],\n \"key\" : \"29d4d9caaaad\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.475Z\",\n \"created_by\" : {\n \"guid\" : \"9f90cc5e-8bcd-4c31-9d5c-b99dbce44cc4\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.475Z\",\n \"updated_by\" : {\n \"guid\" : \"983a73d3-57f9-407a-a1c7-4bfafe0e02cf\"\n }\n },\n \"visibility\" : \"public\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"7d7df493-5d32-4dfd-b115-33a9801169e0\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.475Z\",\n \"created_by\" : {\n \"guid\" : \"98fc1a4d-afdc-4807-ba85-067940b3e4dd\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.475Z\",\n \"updated_by\" : {\n \"guid\" : \"d8d0a93b-a94a-47f3-b7c5-0dfd7734f552\"\n }\n },\n \"publication\" : \"membership_requests.create\",\n \"user\" : {\n \"name\" : \"cf1fd6dbe53a\",\n \"email\" : \"31639603bed3\",\n \"guid\" : \"97d0e26b-4a65-4513-93c4-87e619babd9c\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.475Z\",\n \"created_by\" : {\n \"guid\" : \"06520359-bc8e-48c0-a7e2-1adde946f895\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.475Z\",\n \"updated_by\" : {\n \"guid\" : \"bfda08f8-3578-4bfd-8ee0-a9c8ffc10c73\"\n }\n },\n \"nickname\" : \"db567c593cac\"\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\" : \"e40733d109c0\",\n \"guid\" : \"b1c4d767-4da7-42a7-9932-0e8e8854572f\",\n \"domains\" : [ ],\n \"key\" : \"595491c560fe\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.475Z\",\n \"created_by\" : {\n \"guid\" : \"2ac8a019-8856-4e81-95d8-2a43589b9a1d\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.475Z\",\n \"updated_by\" : {\n \"guid\" : \"f8258932-5065-48fe-b68f-dc5bdfba5759\"\n }\n },\n \"visibility\" : \"user\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"b6eadeeb-17ea-47e8-a49e-a75ae21488d0\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.475Z\",\n \"created_by\" : {\n \"guid\" : \"79734e6a-912a-42dd-9935-243e8c708e0a\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.475Z\",\n \"updated_by\" : {\n \"guid\" : \"d53a2a39-0357-4776-bbdd-2922bc039278\"\n }\n },\n \"publication\" : \"membership_requests.create\",\n \"user\" : {\n \"name\" : \"7b52c8b966ce\",\n \"email\" : \"22e56c900de7\",\n \"guid\" : \"7fc31dfe-f337-4c7b-afbc-580e10f561b3\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.475Z\",\n \"created_by\" : {\n \"guid\" : \"ac09697e-df6e-400f-af81-9d76ab4d6199\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.475Z\",\n \"updated_by\" : {\n \"guid\" : \"a0bf9453-074a-4ade-99f8-2775b1629bc9\"\n }\n },\n \"nickname\" : \"85542a5724b0\"\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\" : \"ab39be1755dd\",\n \"user_guid\" : \"0ffa3172-f5ba-4830-a918-d398ea3d4c76\",\n \"publication\" : \"memberships.create\"\n}", "mode" : "raw" } }, "name" : "POST /subscriptions", "description" : { "content" : "Create a new subscription." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 201 - subscription", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions" ], "query" : [ ], "variable" : [ ] }, "method" : "POST", "description" : { "content" : "Create a new subscription." }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"organization_key\" : \"ab39be1755dd\",\n \"user_guid\" : \"0ffa3172-f5ba-4830-a918-d398ea3d4c76\",\n \"publication\" : \"memberships.create\"\n}", "mode" : "raw" } }, "body" : "{\n \"organization\" : {\n \"name\" : \"6c14ea4742ba\",\n \"guid\" : \"b888a869-3cda-4fc8-97ff-a82d2846fda4\",\n \"domains\" : [ ],\n \"key\" : \"07989e7ce19c\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.476Z\",\n \"created_by\" : {\n \"guid\" : \"15564703-0d8f-41e2-9fea-c54832ed91c6\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.476Z\",\n \"updated_by\" : {\n \"guid\" : \"ee5a5299-9bb7-4692-aa11-9d369dd07a19\"\n }\n },\n \"visibility\" : \"organization\",\n \"namespace\" : \"io.apicollective\"\n },\n \"guid\" : \"27e29cd3-1a3a-4b8f-873a-57e455a90a85\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.476Z\",\n \"created_by\" : {\n \"guid\" : \"47274641-d08b-4f40-9d0a-13b147840b8d\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.476Z\",\n \"updated_by\" : {\n \"guid\" : \"2dfb1695-0774-4b04-8dbe-1851abe9197a\"\n }\n },\n \"publication\" : \"versions.create\",\n \"user\" : {\n \"name\" : \"be85cbcf2312\",\n \"email\" : \"7c14750603dd\",\n \"guid\" : \"84585f1c-fcdf-4c6f-832a-07cc0d3534fc\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.476Z\",\n \"created_by\" : {\n \"guid\" : \"c171400a-e92b-4b77-819f-a0cf82e779a7\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.476Z\",\n \"updated_by\" : {\n \"guid\" : \"0be86e65-01de-40fc-b640-4714e55df2f8\"\n }\n },\n \"nickname\" : \"a088c01482f3\"\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\" : \"ab39be1755dd\",\n \"user_guid\" : \"0ffa3172-f5ba-4830-a918-d398ea3d4c76\",\n \"publication\" : \"memberships.create\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"0210f3413512\",\n \"message\" : \"6bb230ca2969\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "name" : "DELETE /subscriptions/:guid", "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/subscriptions/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "subscriptions", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "tokens", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/tokens/users/:user_guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", "users", ":user_guid" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "user_guid", "value" : "{{user_guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /tokens/users/:user_guid", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [token]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens/users/:user_guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", "users", ":user_guid" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Type: uuid | Required: false" } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ { "key" : "user_guid", "value" : "{{user_guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "header" : [ ] }, "body" : "[ {\n \"guid\" : \"d340b46c-f51b-4787-b54d-b80506b8a0be\",\n \"description\" : \"34a9d20deb7c\",\n \"masked_token\" : \"92784754d06a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.476Z\",\n \"created_by\" : {\n \"guid\" : \"7ed8267d-4d81-404e-81c4-b9807a860def\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.476Z\",\n \"updated_by\" : {\n \"guid\" : \"54c8b2da-3ba6-46d7-8a21-b882fb539e20\"\n }\n },\n \"user\" : {\n \"name\" : \"5f6a4021e8be\",\n \"email\" : \"1fc6c4be656d\",\n \"guid\" : \"b6d54770-fb4b-4cd9-a4fd-8d5096e28696\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.476Z\",\n \"created_by\" : {\n \"guid\" : \"7c6acf6e-284f-4193-88e0-f71480209bc6\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.476Z\",\n \"updated_by\" : {\n \"guid\" : \"88d15aac-953e-4a63-b6ea-de9082b9cf61\"\n }\n },\n \"nickname\" : \"3048a861635b\"\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\" : \"4d588e2aa697\"\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\" : \"eadac924-780d-4507-84d7-f8f9ee22629e\",\n \"description\" : \"e4ccbd6fead6\"\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\" : \"eadac924-780d-4507-84d7-f8f9ee22629e\",\n \"description\" : \"e4ccbd6fead6\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"d8a219d6-283f-4a3d-b975-b0e83335b240\",\n \"description\" : \"4727e9a92f22\",\n \"masked_token\" : \"0675ea9d5a5b\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.479Z\",\n \"created_by\" : {\n \"guid\" : \"d9d315cb-f42b-489c-9296-10577c6c262b\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.479Z\",\n \"updated_by\" : {\n \"guid\" : \"efce2a71-4dae-4326-b828-6c887bec6499\"\n }\n },\n \"user\" : {\n \"name\" : \"a24fcdab39c6\",\n \"email\" : \"dc2ab4e9078e\",\n \"guid\" : \"ad5985fb-3b1b-4d34-b2bc-4413ac25c80c\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.476Z\",\n \"created_by\" : {\n \"guid\" : \"ac0b1cbc-b9cd-4a7b-ab2f-72b0f72e9ddf\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.476Z\",\n \"updated_by\" : {\n \"guid\" : \"7a97d948-d0c8-42b6-8acf-70e0ebd501b5\"\n }\n },\n \"nickname\" : \"317bc21476bf\"\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\" : \"eadac924-780d-4507-84d7-f8f9ee22629e\",\n \"description\" : \"e4ccbd6fead6\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"62b2c12c0e17\",\n \"message\" : \"e4628481d959\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/tokens/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "name" : "DELETE /tokens/:guid", "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/tokens/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "tokens", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "users", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/users", "host" : [ "{{BASE_URL}}" ], "path" : [ "users" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find user with this guid. Exact match" } }, { "key" : "email", "disabled" : true, "description" : { "content" : "Find user with this email address. Case in-sensitive. Exact match" } }, { "key" : "token", "disabled" : true, "description" : { "content" : "Find the user with this API token. Exact match" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search for a specific user. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users." }, "header" : [ ] }, "name" : "GET /users", "description" : { "content" : "Search for a specific user. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [user]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/users", "host" : [ "{{BASE_URL}}" ], "path" : [ "users" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find user with this guid. Exact match" } }, { "key" : "email", "disabled" : true, "description" : { "content" : "Find user with this email address. Case in-sensitive. Exact match" } }, { "key" : "token", "disabled" : true, "description" : { "content" : "Find the user with this API token. Exact match" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search for a specific user. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users." }, "header" : [ ] }, "body" : "[ {\n \"name\" : \"9d09a0f5f8a2\",\n \"email\" : \"815f29678668\",\n \"guid\" : \"8e0e3bd0-f03d-4cfb-9219-3b1ef2f0af6c\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.479Z\",\n \"created_by\" : {\n \"guid\" : \"8be41cb6-2352-4207-8a63-766c361c82b2\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.479Z\",\n \"updated_by\" : {\n \"guid\" : \"01cddaf8-a322-4c31-9453-87960c27aaed\"\n }\n },\n \"nickname\" : \"6aa15122c8e6\"\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\" : \"9530ec5dc7e9\",\n \"email\" : \"bd15e0d21f83\",\n \"guid\" : \"4ba94b6e-dd83-4659-92da-4fc4a55641a9\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.479Z\",\n \"created_by\" : {\n \"guid\" : \"30603ab3-73c8-451b-8ad0-ca52eb94fa88\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.479Z\",\n \"updated_by\" : {\n \"guid\" : \"19d92ae0-7d21-4480-8b41-6a46dd1ca12a\"\n }\n },\n \"nickname\" : \"1dfddfdc5b9a\"\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\" : \"e0f5f5eb364e\",\n \"email\" : \"d01ac292fb70\",\n \"guid\" : \"8b8e01a0-c284-44d1-9fc8-e59edc249e76\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.479Z\",\n \"created_by\" : {\n \"guid\" : \"17717ee7-a477-4923-b727-be053c591c68\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.479Z\",\n \"updated_by\" : {\n \"guid\" : \"599d4907-9893-46f6-9846-9aa1b4b9e501\"\n }\n },\n \"nickname\" : \"09a354bdf0eb\"\n },\n \"session\" : {\n \"id\" : \"165049061267\",\n \"expires_at\" : \"2026-10-17T16:39:51.479Z\"\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\" : \"5938f726748c\",\n \"message\" : \"503ff24598b0\"\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\" : \"c47fa2e7d8ad\",\n \"email\" : \"9dcaf6980fe6\",\n \"guid\" : \"13289129-c06a-4cee-aae7-16b37ac59a42\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.480Z\",\n \"created_by\" : {\n \"guid\" : \"f8f96f22-7bc9-4849-9ed0-f99027e07c39\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.480Z\",\n \"updated_by\" : {\n \"guid\" : \"506f1888-543b-4cf5-8f45-44b05801c67e\"\n }\n },\n \"nickname\" : \"0efd2b1a47ad\"\n },\n \"session\" : {\n \"id\" : \"48f026921119\",\n \"expires_at\" : \"2026-10-17T16:39:51.480Z\"\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\" : \"fedbc1a8c06a\",\n \"message\" : \"f8feab499282\"\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\" : \"727f26faeb5a\",\n \"password\" : \"0910e730bd47\",\n \"nickname\" : \"1026f676cdb8\",\n \"name\" : \"d76ce4f547b1\"\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\" : \"727f26faeb5a\",\n \"password\" : \"0910e730bd47\",\n \"nickname\" : \"1026f676cdb8\",\n \"name\" : \"d76ce4f547b1\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"915349e607fa\",\n \"email\" : \"1aeffa44d0af\",\n \"guid\" : \"ca203bb1-d1ec-409d-808b-ea381054544a\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.480Z\",\n \"created_by\" : {\n \"guid\" : \"9ca203db-256c-44e0-86c7-f1c715731bc9\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.480Z\",\n \"updated_by\" : {\n \"guid\" : \"6789e0c9-2ae8-4420-95ea-ce29885a3c43\"\n }\n },\n \"nickname\" : \"a79644996bfa\"\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\" : \"727f26faeb5a\",\n \"password\" : \"0910e730bd47\",\n \"nickname\" : \"1026f676cdb8\",\n \"name\" : \"d76ce4f547b1\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"83b22be0fce0\",\n \"message\" : \"785ec6f4e586\"\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\" : \"a9095b76535e\",\n \"nickname\" : \"8c48e1ffc531\",\n \"name\" : \"0b10ca999a64\"\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\" : \"a9095b76535e\",\n \"nickname\" : \"8c48e1ffc531\",\n \"name\" : \"0b10ca999a64\"\n}", "mode" : "raw" } }, "body" : "{\n \"name\" : \"1c2f003b7c0b\",\n \"email\" : \"c6290d80a12b\",\n \"guid\" : \"713efb0d-b2cf-467f-9990-2ef463869759\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.480Z\",\n \"created_by\" : {\n \"guid\" : \"bdd90a10-fa7d-4b1e-bead-8dd7e8ec541c\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.480Z\",\n \"updated_by\" : {\n \"guid\" : \"c7c25f0c-0088-431e-b939-2561d548cad9\"\n }\n },\n \"nickname\" : \"eeca3f905e8b\"\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\" : \"a9095b76535e\",\n \"nickname\" : \"8c48e1ffc531\",\n \"name\" : \"0b10ca999a64\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"ab915bd47249\",\n \"message\" : \"c50567858498\"\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" : "\"1b3a9601094d\"", "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" : "\"1b3a9601094d\"", "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\" : \"a7705cb2-1192-4f51-89ee-7901fda9e7c6\",\n \"service\" : {\n \"name\" : \"27a89bebc3a7\",\n \"description\" : \"ffff097bf0d5\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"e2bbdd31c514\"\n },\n \"organization\" : {\n \"key\" : \"bbe4d8ab3cd1\"\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\" : \"0abf5ca5aef0\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"482b2e2b-483c-478d-b93c-97cfdc5507ad\",\n \"key\" : \"642b009c41bd\"\n },\n \"organization\" : {\n \"guid\" : \"dbbb29fd-5692-4ef5-a10b-e63b6a5b4bf8\",\n \"key\" : \"b4c0e9f2edc7\"\n },\n \"original\" : {\n \"type\" : \"avro_idl\",\n \"data\" : \"f7abd404c7cd\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.481Z\",\n \"created_by\" : {\n \"guid\" : \"3781b5bf-b540-4b1f-a91f-75aa0f72aa16\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.481Z\",\n \"updated_by\" : {\n \"guid\" : \"52b2f438-52b9-492f-92e1-83a151356551\"\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\" : \"64be842e-ec0a-4ac0-a9a1-a3abb27117fd\",\n \"service\" : {\n \"name\" : \"72765d9adc35\",\n \"description\" : \"3909ef76487c\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"ad24e6ce1b09\"\n },\n \"organization\" : {\n \"key\" : \"9222628c72d6\"\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\" : \"4c70ca5e53dd\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"83abab5b-7cdd-4abb-8863-b1341ccc9933\",\n \"key\" : \"320d16f43f5d\"\n },\n \"organization\" : {\n \"guid\" : \"d288b5df-bb12-4546-b44b-f5baab97c4d0\",\n \"key\" : \"16b27dc5cb09\"\n },\n \"original\" : {\n \"type\" : \"service_json\",\n \"data\" : \"ec47104b605e\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.481Z\",\n \"created_by\" : {\n \"guid\" : \"2e137e94-8b4d-4729-81ed-512c01467a19\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.481Z\",\n \"updated_by\" : {\n \"guid\" : \"55f5b817-4b4d-4412-b41a-e4aeff37d761\"\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\" : \"avro_idl\",\n \"data\" : \"182f6ae39956\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "name" : "POST /:orgKey/:version", "description" : { "content" : "Create a new version for an application" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - version", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Create a new version for an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"avro_idl\",\n \"data\" : \"182f6ae39956\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"27f1e075-c274-463e-944d-7cfc119f5886\",\n \"service\" : {\n \"name\" : \"7595926e3ecc\",\n \"description\" : \"bbb29292742b\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"ad63bbaee434\"\n },\n \"organization\" : {\n \"key\" : \"79a4a8eb87f1\"\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\" : \"608e047f8508\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"751efd0e-b41e-4695-90c2-ee06d9fa9f83\",\n \"key\" : \"65814c2bb267\"\n },\n \"organization\" : {\n \"guid\" : \"bde6a8ea-616b-4e19-adc7-c286484d4a65\",\n \"key\" : \"6b98fafcf322\"\n },\n \"original\" : {\n \"type\" : \"swagger\",\n \"data\" : \"4c46b5cd8450\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.481Z\",\n \"created_by\" : {\n \"guid\" : \"d586a50d-efe3-4ebe-8ba7-f90ce9c983f2\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.481Z\",\n \"updated_by\" : {\n \"guid\" : \"c7c0de1d-19cd-476d-8a64-638b90133d31\"\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\" : \"avro_idl\",\n \"data\" : \"182f6ae39956\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"7f1312d6eee9\",\n \"message\" : \"9986b514affc\"\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\" : \"swagger\",\n \"data\" : \"867a8157df4c\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "name" : "PUT /:orgKey/:applicationKey/:version", "description" : { "content" : "Upsert a version of an application" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - version", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Upsert a version of an application" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"original_form\" : {\n \"type\" : \"swagger\",\n \"data\" : \"867a8157df4c\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"238cceb8-2687-4c34-a586-2b411a028e39\",\n \"service\" : {\n \"name\" : \"0494256db879\",\n \"description\" : \"d70720d636c1\",\n \"interfaces\" : [ ],\n \"enums\" : [ ],\n \"resources\" : [ ],\n \"models\" : [ ],\n \"headers\" : [ ],\n \"apidoc\" : {\n \"version\" : \"1.0.3\"\n },\n \"unions\" : [ ],\n \"application\" : {\n \"key\" : \"4df45c859e71\"\n },\n \"organization\" : {\n \"key\" : \"ae4e125abb6c\"\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\" : \"c6088055719b\",\n \"annotations\" : [ ],\n \"version\" : \"1.0.0\",\n \"namespace\" : \"io.apibuilder\",\n \"imports\" : [ ]\n },\n \"version\" : \"1.0.0\",\n \"application\" : {\n \"guid\" : \"a3540d18-279e-49f2-b140-4fa8afed8242\",\n \"key\" : \"3e7540516379\"\n },\n \"organization\" : {\n \"guid\" : \"1c79b238-89a6-45be-b70b-2ef5e26c62b7\",\n \"key\" : \"0938ed8cd758\"\n },\n \"original\" : {\n \"type\" : \"api_json\",\n \"data\" : \"cd7c1a346367\"\n },\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.482Z\",\n \"created_by\" : {\n \"guid\" : \"95a09b9d-d759-4b2a-805a-2df051848e40\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.482Z\",\n \"updated_by\" : {\n \"guid\" : \"e0dd6af0-4054-45cf-a9ab-3426fdd6dbfa\"\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\" : \"swagger\",\n \"data\" : \"867a8157df4c\"\n },\n \"visibility\" : \"user\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"09d43417b9c6\",\n \"message\" : \"0b88b9cfb985\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific version." }, "header" : [ ] }, "name" : "DELETE /:orgKey/:applicationKey/:version", "description" : { "content" : "Deletes a specific version." }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version" ], "query" : [ ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "{{version}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a specific version." }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/example/:type_name", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", "example", ":type_name" ], "query" : [ { "key" : "optional_fields", "disabled" : true, "description" : { "content" : "If true, we generate sample data for all optional fields. Otherwise the generated sample will contain only required fields, where applicable" } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "latest", "description" : { "content" : "The version of tthis application to download, or the keyword latest to get the latest version" }, "disabled" : false }, { "key" : "type_name", "value" : "{{type_name}}", "description" : { "content" : "The name of the type (e.g. model name) for which you would like to generate a sample json document" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generates an example JSON document of the type with the specified name." }, "header" : [ ] }, "name" : "GET /:orgKey/:applicationKey/:version/example/:type_name", "description" : { "content" : "Generates an example JSON document of the type with the specified name." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - object", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/example/:type_name", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", "example", ":type_name" ], "query" : [ { "key" : "optional_fields", "disabled" : true, "description" : { "content" : "If true, we generate sample data for all optional fields. Otherwise the generated sample will contain only required fields, where applicable" } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "latest", "description" : { "content" : "The version of tthis application to download, or the keyword latest to get the latest version" }, "disabled" : false }, { "key" : "type_name", "value" : "{{type_name}}", "description" : { "content" : "The name of the type (e.g. model name) for which you would like to generate a sample json document" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generates an example JSON document of the type with the specified name." }, "header" : [ ] }, "body" : "{\n \"foo\" : \"bar\"\n}", "code" : 200 }, { "name" : "Example 404 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/:orgKey/:applicationKey/:version/example/:type_name", "host" : [ "{{BASE_URL}}" ], "path" : [ ":orgKey", ":applicationKey", ":version", "example", ":type_name" ], "query" : [ { "key" : "optional_fields", "disabled" : true, "description" : { "content" : "If true, we generate sample data for all optional fields. Otherwise the generated sample will contain only required fields, where applicable" } } ], "variable" : [ { "key" : "orgKey", "value" : "{{orgKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "applicationKey", "value" : "{{applicationKey}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false }, { "key" : "version", "value" : "latest", "description" : { "content" : "The version of tthis application to download, or the keyword latest to get the latest version" }, "disabled" : false }, { "key" : "type_name", "value" : "{{type_name}}", "description" : { "content" : "The name of the type (e.g. model name) for which you would like to generate a sample json document" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Generates an example JSON document of the type with the specified name." }, "header" : [ ] }, "code" : 404 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "watches", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the watch with this guid." } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Find attributes for this user." } }, { "key" : "organization_key", "disabled" : true, "description" : { "content" : "Find attributes for this organization." } }, { "key" : "application_key", "disabled" : true, "description" : { "content" : "Find attributes for this application." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search attributes. Always paginated." }, "header" : [ ] }, "name" : "GET /watches", "description" : { "content" : "Search attributes. Always paginated." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [watch]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches" ], "query" : [ { "key" : "guid", "disabled" : true, "description" : { "content" : "Find the watch with this guid." } }, { "key" : "user_guid", "disabled" : true, "description" : { "content" : "Find attributes for this user." } }, { "key" : "organization_key", "disabled" : true, "description" : { "content" : "Find attributes for this organization." } }, { "key" : "application_key", "disabled" : true, "description" : { "content" : "Find attributes for this application." } }, { "key" : "limit", "value" : "25", "disabled" : false, "description" : { "content" : "The number of records to return" } }, { "key" : "offset", "value" : "0", "disabled" : false, "description" : { "content" : "Used to paginate. First page of results is 0." } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Search attributes. Always paginated." }, "header" : [ ] }, "body" : "[ {\n \"guid\" : \"b8c5b438-c6d4-495b-a4e8-3771f17989bb\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.482Z\",\n \"created_by\" : {\n \"guid\" : \"2e8fdb6f-f11a-4285-874c-fbf48ba91cc0\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.482Z\",\n \"updated_by\" : {\n \"guid\" : \"6ba1e7d4-1e96-4dc2-a39c-91b24226ee6a\"\n }\n },\n \"user\" : {\n \"name\" : \"ab3af817fa3d\",\n \"email\" : \"39898aef5313\",\n \"guid\" : \"b4994b99-3a63-4848-81fc-d27aec2c2be8\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.482Z\",\n \"created_by\" : {\n \"guid\" : \"d54294d8-a87d-4498-93e6-c9552a7bbb9d\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.482Z\",\n \"updated_by\" : {\n \"guid\" : \"7979fddb-ac26-4094-8d09-9d3a6218b69c\"\n }\n },\n \"nickname\" : \"d9eb58e25adb\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"23ededfc-62dc-4ac9-8f51-aa263f9e0f2e\",\n \"key\" : \"bb304c46e7e0\"\n },\n \"name\" : \"d861b36b6080\",\n \"guid\" : \"8aac4b0e-c971-42e6-8bdd-c8b433b2587d\",\n \"description\" : \"3a14ab128cfe\",\n \"key\" : \"98011e497c75\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.482Z\",\n \"created_by\" : {\n \"guid\" : \"fb8f9c00-6e9f-4201-8fd0-0b7b1326a8b6\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.482Z\",\n \"updated_by\" : {\n \"guid\" : \"5530f360-5737-47fd-a1f5-41b67a0b4160\"\n }\n },\n \"visibility\" : \"public\"\n },\n \"organization\" : {\n \"name\" : \"111f5b22eb6c\",\n \"guid\" : \"e3169425-93ed-44ad-8edb-47e4944b2441\",\n \"domains\" : [ ],\n \"key\" : \"bf7d5a3a1257\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.482Z\",\n \"created_by\" : {\n \"guid\" : \"e8d8e767-4e71-486b-a080-390b13e5784a\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.482Z\",\n \"updated_by\" : {\n \"guid\" : \"8553031a-fa7a-48a5-a1cf-b0329dee365e\"\n }\n },\n \"visibility\" : \"user\",\n \"namespace\" : \"io.apicollective\"\n }\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific watch." }, "header" : [ ] }, "name" : "GET /watches/:guid", "description" : { "content" : "Returns information about a specific watch." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - watch", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Returns information about a specific watch." }, "header" : [ ] }, "body" : "{\n \"guid\" : \"c7a6723c-a549-4c7c-8637-0864e88a1623\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.483Z\",\n \"created_by\" : {\n \"guid\" : \"420004db-78db-464e-8b4c-e7d9b07a3023\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.483Z\",\n \"updated_by\" : {\n \"guid\" : \"810631ad-aa75-42e0-80fb-cc377f590e1e\"\n }\n },\n \"user\" : {\n \"name\" : \"0b029aef2f43\",\n \"email\" : \"4f6088cb7d1c\",\n \"guid\" : \"3b300438-eae7-4865-8ee9-d3209fcfca79\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.482Z\",\n \"created_by\" : {\n \"guid\" : \"e9652d72-d726-4271-a61f-b286dcfcb487\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.482Z\",\n \"updated_by\" : {\n \"guid\" : \"2e27ca97-43b9-471a-ae52-e6c0d83ae051\"\n }\n },\n \"nickname\" : \"c543fffaecee\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"a8a558ad-d1a0-4505-a870-541a42f59b6f\",\n \"key\" : \"66a6c94c9999\"\n },\n \"name\" : \"5e44f72167d3\",\n \"guid\" : \"06dc0c21-b738-4e66-a1f1-5305d9c78010\",\n \"description\" : \"ec74afbf436b\",\n \"key\" : \"23058e7d3b82\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.483Z\",\n \"created_by\" : {\n \"guid\" : \"cad6374a-2053-4334-ae9b-c326425e0f8c\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.483Z\",\n \"updated_by\" : {\n \"guid\" : \"1260c241-c1ec-4327-aa2e-db3c2ddb2d66\"\n }\n },\n \"visibility\" : \"public\"\n },\n \"organization\" : {\n \"name\" : \"0a280ea8facb\",\n \"guid\" : \"bb657ac1-865f-4cf7-ac64-cf61652c570e\",\n \"domains\" : [ ],\n \"key\" : \"d091a128260f\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.483Z\",\n \"created_by\" : {\n \"guid\" : \"929cc000-2f6f-495e-82e1-8fccd0ff8e1d\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.483Z\",\n \"updated_by\" : {\n \"guid\" : \"e60b5944-1eab-40d7-b446-a6249c9c4c76\"\n }\n },\n \"visibility\" : \"organization\",\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\" : \"7d24a03f-85e7-49d6-b96e-236c287f244f\",\n \"organization_key\" : \"194746f346fb\",\n \"application_key\" : \"e06da2c3e0b8\"\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\" : \"7d24a03f-85e7-49d6-b96e-236c287f244f\",\n \"organization_key\" : \"194746f346fb\",\n \"application_key\" : \"e06da2c3e0b8\"\n}", "mode" : "raw" } }, "body" : "{\n \"guid\" : \"0c4a5653-35c0-423c-ad45-ff4811542d77\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.483Z\",\n \"created_by\" : {\n \"guid\" : \"fae19622-812e-4c90-953e-0ee8049b68d3\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.483Z\",\n \"updated_by\" : {\n \"guid\" : \"54280c6c-8b7a-4d33-af70-60271f045ab1\"\n }\n },\n \"user\" : {\n \"name\" : \"70cfe922716a\",\n \"email\" : \"4143f0d4539d\",\n \"guid\" : \"53b36856-484b-423c-aed7-844a0022f8fe\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.483Z\",\n \"created_by\" : {\n \"guid\" : \"b64612d1-4398-445e-8db6-cfc046ed1740\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.483Z\",\n \"updated_by\" : {\n \"guid\" : \"422a2002-9589-4390-97af-794ac9466e2a\"\n }\n },\n \"nickname\" : \"3fbdeb5d1655\"\n },\n \"application\" : {\n \"organization\" : {\n \"guid\" : \"72f5d665-fd70-4c6a-82c4-69f3af71f622\",\n \"key\" : \"5f010d00f9bb\"\n },\n \"name\" : \"fd0b6d77d67a\",\n \"guid\" : \"8cedb0b1-23c1-473b-925b-a3faeb4d081b\",\n \"description\" : \"ce4304668fed\",\n \"key\" : \"42bf2a2ec315\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.483Z\",\n \"created_by\" : {\n \"guid\" : \"5f2e202b-d052-49af-af25-d820e47db1e5\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.483Z\",\n \"updated_by\" : {\n \"guid\" : \"6da9d5b7-b587-40b7-8837-f81f1c96c8ac\"\n }\n },\n \"visibility\" : \"user\"\n },\n \"organization\" : {\n \"name\" : \"4817f8e65ff8\",\n \"guid\" : \"3eb57877-eccd-4d44-a257-bf4e32620ed1\",\n \"domains\" : [ ],\n \"key\" : \"3b7df765d9b9\",\n \"audit\" : {\n \"created_at\" : \"2026-10-17T16:39:51.483Z\",\n \"created_by\" : {\n \"guid\" : \"01e3efea-9e5b-4e66-9f67-69843f85726a\"\n },\n \"updated_at\" : \"2026-10-17T16:39:51.483Z\",\n \"updated_by\" : {\n \"guid\" : \"36979b7d-1529-439e-a47d-b6ef0de0a2e4\"\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\" : \"7d24a03f-85e7-49d6-b96e-236c287f244f\",\n \"organization_key\" : \"194746f346fb\",\n \"application_key\" : \"e06da2c3e0b8\"\n}", "mode" : "raw" } }, "body" : "[ {\n \"code\" : \"dbaea6078847\",\n \"message\" : \"d0d5616f4f59\"\n} ]", "code" : 409 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "name" : "DELETE /watches/:guid", "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/watches/:guid", "host" : [ "{{BASE_URL}}" ], "path" : [ "watches", ":guid" ], "query" : [ ], "variable" : [ { "key" : "guid", "value" : "{{guid}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" } ], "event" : [ ], "variable" : [ { "key" : "BASE_URL", "value" : "https://api.apibuilder.io", "type" : "string" } ] }