{ "item": [ { "name": "api", "description": "", "item": [ { "name": "v1", "description": "", "item": [ { "name": "health", "description": "", "item": [ { "id": "fcd6558c-8432-4de2-ab11-3c64f0ed7751", "name": "Liveness + readiness probe", "request": { "name": "Liveness + readiness probe", "description": { "content": "Unauthenticated. Returns `ok` when the database round-trip succeeds; `degraded` when it does not. Suitable for uptime monitors and load-balancer probes.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "bab19794-bdf7-4b5f-b9d7-9bba62c5d647", "name": "Service is healthy.", "originalRequest": { "url": { "path": [ "api", "v1", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"status\": \"ok\",\n \"db_latency_ms\": \"\",\n \"version\": \"\",\n \"commit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40279c9e-90e8-4d0a-b24e-e1640eab5ccc", "name": "Service is degraded (database unreachable).", "originalRequest": { "url": { "path": [ "api", "v1", "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"status\": \"ok\",\n \"db_latency_ms\": \"\",\n \"version\": \"\",\n \"commit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "instance", "description": "", "item": [ { "id": "4b33fbff-8209-40d6-b1cc-1733a54c52d6", "name": "Read instance settings", "request": { "name": "Read instance settings", "description": { "content": "Returns the public-facing instance configuration: branding, sender identity, default API rate limit. Credential-bearing columns (SMTP password, vault pointers) are intentionally excluded.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "instance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "89bd3340-fa06-4434-9d10-e95be0eca9c7", "name": "Current instance settings.", "originalRequest": { "url": { "path": [ "api", "v1", "instance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"app_name\": \"\",\n \"app_name_short\": \"\",\n \"support_email\": \"\",\n \"primary_color\": \"\",\n \"secondary_color\": \"\",\n \"accent_color\": \"\",\n \"logo_url\": \"\",\n \"icon_url\": \"\",\n \"from_email\": \"\",\n \"from_name\": \"\",\n \"api_rate_limit_default\": \"\",\n \"media_bucket_visibility\": \"private\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c2de81cd-bf4e-4dde-890d-6d1b75f9899d", "name": "Update instance settings", "request": { "name": "Update instance settings", "description": { "content": "Partial update — only the fields you provide are changed. Instance-scoped API keys only; org-scoped keys receive 403.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "instance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"app_name\": \"\",\n \"app_name_short\": \"\",\n \"support_email\": \"\",\n \"primary_color\": \"#4AB\",\n \"secondary_color\": \"#EE8\",\n \"accent_color\": \"#c2b\",\n \"logo_url\": \"\",\n \"icon_url\": \"\",\n \"from_email\": \"\",\n \"from_name\": \"\",\n \"api_rate_limit_default\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bf59c29b-4118-4271-87a0-6a6ab9f1cee6", "name": "Updated instance settings.", "originalRequest": { "url": { "path": [ "api", "v1", "instance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"app_name\": \"\",\n \"app_name_short\": \"\",\n \"support_email\": \"\",\n \"primary_color\": \"#4AB\",\n \"secondary_color\": \"#EE8\",\n \"accent_color\": \"#c2b\",\n \"logo_url\": \"\",\n \"icon_url\": \"\",\n \"from_email\": \"\",\n \"from_name\": \"\",\n \"api_rate_limit_default\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"app_name\": \"\",\n \"app_name_short\": \"\",\n \"support_email\": \"\",\n \"primary_color\": \"\",\n \"secondary_color\": \"\",\n \"accent_color\": \"\",\n \"logo_url\": \"\",\n \"icon_url\": \"\",\n \"from_email\": \"\",\n \"from_name\": \"\",\n \"api_rate_limit_default\": \"\",\n \"media_bucket_visibility\": \"private\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "organizations", "description": "", "item": [ { "name": "{organization_id}", "description": "", "item": [ { "name": "collections", "description": "", "item": [ { "id": "453ec47f-2076-49e8-9aad-90aa00f176bd", "name": "List collections in an organization", "request": { "name": "List collections in an organization", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of created_at,-created_at,updated_at,-updated_at,name,-name)", "type": "text/plain" }, "key": "sort", "value": "-name" } ], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d8272810-a6d4-4d0e-b239-9cbe9a9be8cf", "name": "Collections.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of created_at,-created_at,updated_at,-updated_at,name,-name)", "type": "text/plain" }, "key": "sort", "value": "-name" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"ce008BB5-6c7F-F3bb-Eeca-5f3F1Bb798AA\",\n \"organization_id\": \"ced7d63A-299F-Eb5c-DeF0-0df7C89B09e7\",\n \"name\": \"\",\n \"description\": \"\",\n \"created_by\": \"7c0CaDE4-B7E9-BE46-A226-BbdFDC28b03d\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"3c6dD1C7-F8bE-5835-b01F-4b1cD50E2Def\",\n \"organization_id\": \"cCfb56EB-1C7B-7fe2-6ef8-b4f0Cd36C2e9\",\n \"name\": \"\",\n \"description\": \"\",\n \"created_by\": \"b5A7378b-d95E-eBE5-afF8-0C71886C47d5\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c0cbcc7-3f67-42de-be0e-6cc03199437e", "name": "Create a collection", "request": { "name": "Create a collection", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "be376083-9a83-4a85-907f-fee2c1d09ff6", "name": "Created.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"a962E15a-63cF-5aEF-e50f-5f0aC691748a\",\n \"organization_id\": \"E68e7F5F-e61f-2f37-C38C-b5A6adB2caca\",\n \"name\": \"\",\n \"description\": \"\",\n \"created_by\": \"3a0BC6AD-ccAc-FAB5-04EE-8c9eFC3B94CF\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{collection_id}", "description": "", "item": [ { "id": "f9eb0aeb-4fa2-4034-a6ba-86da5df9ce5f", "name": "Get a collection", "request": { "name": "Get a collection", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9f8b961e-0889-4127-b4c0-5b36682276f1", "name": "The collection.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"a962E15a-63cF-5aEF-e50f-5f0aC691748a\",\n \"organization_id\": \"E68e7F5F-e61f-2f37-C38C-b5A6adB2caca\",\n \"name\": \"\",\n \"description\": \"\",\n \"created_by\": \"3a0BC6AD-ccAc-FAB5-04EE-8c9eFC3B94CF\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25a360c2-3ed1-43f0-9c4a-4e9f8b55bd36", "name": "Update a collection", "request": { "name": "Update a collection", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2f9ec85e-cee7-4f68-bee1-98a8c7a674ff", "name": "Updated.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"a962E15a-63cF-5aEF-e50f-5f0aC691748a\",\n \"organization_id\": \"E68e7F5F-e61f-2f37-C38C-b5A6adB2caca\",\n \"name\": \"\",\n \"description\": \"\",\n \"created_by\": \"3a0BC6AD-ccAc-FAB5-04EE-8c9eFC3B94CF\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4324f9a9-ce3d-4ff7-81cd-d68fcc7e962b", "name": "Delete a collection", "request": { "name": "Delete a collection", "description": { "content": "Hard-deletes the collection. Its form memberships and user assignments cascade away; derived form access drops immediately.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "86dca570-1bfd-46cb-9e52-aeb8fd29173f", "name": "Deletion confirmation.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"deleted\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "forms", "description": "", "item": [ { "id": "b99d39e8-267b-49a4-bed9-89afd5ff13e5", "name": "List forms in a collection", "request": { "name": "List forms in a collection", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ebfb84d7-7a9a-4f5e-854c-e8230ea3fc91", "name": "Collection forms.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"DC029def-ba7d-Eeea-cFEB-69B1cdA9fC63\",\n \"organization_id\": \"2f547dF7-b2a2-aEA5-6Fea-b2aF4f6CDb37\",\n \"collection_id\": \"FC3EdC2f-3a4d-7ea1-eCDC-4A70FC412314\",\n \"form_id\": \"5Dab4C01-b0FC-3c05-EBAd-37A2BAe8Ab02\",\n \"added_by\": \"a9b3dc7a-334b-79EF-E0d0-48d9EA85EEDf\",\n \"added_at\": \"\"\n },\n {\n \"id\": \"c9695Cfb-Fc3d-678A-c84E-B51CdFCBE5f0\",\n \"organization_id\": \"1A00A47c-09fE-92fE-7fa9-0fBCaca9AD12\",\n \"collection_id\": \"097BDD30-8B4A-c84a-dB5f-8Bc0BD195fbf\",\n \"form_id\": \"aE2267f6-c28E-7e6A-f98B-3b7f1B265cd1\",\n \"added_by\": \"9fbFB6A5-6F4D-fC6A-B220-0Da4e3ee1820\",\n \"added_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4650dce5-de31-4845-9f33-98bd57fa5692", "name": "Add a form to a collection", "request": { "name": "Add a form to a collection", "description": { "content": "Idempotent — re-adding a form already in the collection returns the existing membership.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"form_id\": \"C6dB0Eb6-FEeC-083f-cF69-8C2E6b76a7db\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e868f746-13af-4de6-965d-62d66ad9cefb", "name": "Form added.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"form_id\": \"C6dB0Eb6-FEeC-083f-cF69-8C2E6b76a7db\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"collection_id\": \"\",\n \"form_id\": \"\",\n \"added\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{form_id}", "description": "", "item": [ { "id": "dc982410-1f49-4d81-ac30-1a6625148fa8", "name": "Remove a form from a collection", "request": { "name": "Remove a form from a collection", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "forms", ":form_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "aa2b313a-6258-4421-bc5d-deb5a644d8a3", "name": "Form removed.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "forms", ":form_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"organization_id\": \"\",\n \"collection_id\": \"\",\n \"form_id\": \"\",\n \"removed\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "assignments", "description": "", "item": [ { "id": "efec4b3e-6eba-4466-a8dd-8ba6662b1276", "name": "List user assignments for a collection", "request": { "name": "List user assignments for a collection", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cfba2d72-7541-429a-922a-e41b83fea739", "name": "Assignments.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"5db7A892-02Aa-c80a-08D6-67989894AEae\",\n \"organization_id\": \"6bB0e93b-1Cd7-Ac1B-0fDd-2Db02E4F8178\",\n \"collection_id\": \"dADFfb6f-96BB-A38c-e992-0a5B08A5aBCd\",\n \"user_id\": \"dDbb51Aa-d879-91Bc-A5ac-80Ff2FD747eA\",\n \"can_collect\": \"\",\n \"can_view\": \"none\",\n \"can_edit\": \"none\",\n \"assigned_by\": \"Ac675A47-83da-2fCF-B1E5-b62d4Bfe122F\",\n \"assigned_at\": \"\"\n },\n {\n \"id\": \"11EDCB53-8BF6-C353-cbB7-7fc2Fe130C47\",\n \"organization_id\": \"dffa81C4-773A-Dbdb-Ca87-5e445e2Ee6BE\",\n \"collection_id\": \"D4c30B6F-8Abd-F6e2-0338-3d287Beafb19\",\n \"user_id\": \"5Eae5Db6-5F41-D2fc-B37a-c8D6fCcC9B0f\",\n \"can_collect\": \"\",\n \"can_view\": \"self\",\n \"can_edit\": \"all\",\n \"assigned_by\": \"eB1da9DD-2ed6-a2Aa-F85E-87Add63fD313\",\n \"assigned_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9f01bf21-090e-4102-b9ba-ebf4249b56cb", "name": "Assign a collection to a user", "request": { "name": "Assign a collection to a user", "description": { "content": "Grants the user every form in the collection with the given rights. Idempotent — re-assigning returns the existing assignment. Optional `can_collect`, `can_view`, and `can_edit` override the defaults (true / self / none).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"3F8E361f-b6b5-b800-8F57-1eFfc43faa13\",\n \"can_collect\": \"\",\n \"can_view\": \"self\",\n \"can_edit\": \"self\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1e7e6c60-3ba7-4f38-90a9-dc4f4d241994", "name": "Assigned.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"3F8E361f-b6b5-b800-8F57-1eFfc43faa13\",\n \"can_collect\": \"\",\n \"can_view\": \"self\",\n \"can_edit\": \"self\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"e34631de-200F-ebDa-3fcc-ef34f5AcdA4E\",\n \"organization_id\": \"59f146BF-Faa6-cEAB-B7fe-CE7C7BF8568f\",\n \"collection_id\": \"25ff5E23-2a8a-aa6D-3778-5DaB0C2A6aCf\",\n \"user_id\": \"baF7f88f-bFf4-fe5B-aB73-DF08ABAD5d1d\",\n \"can_collect\": \"\",\n \"can_view\": \"self\",\n \"can_edit\": \"self\",\n \"assigned_by\": \"C455fCcc-3eF3-5dD4-68F1-d140B679FEd7\",\n \"assigned_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{user_id}", "description": "", "item": [ { "id": "4c03fbe2-b969-4519-ae3a-ee9a5202a99a", "name": "Get a user collection assignment", "request": { "name": "Get a user collection assignment", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "assignments", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "69278ea0-a26c-456b-aa9e-daab4a42bfaf", "name": "The assignment.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "assignments", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"e34631de-200F-ebDa-3fcc-ef34f5AcdA4E\",\n \"organization_id\": \"59f146BF-Faa6-cEAB-B7fe-CE7C7BF8568f\",\n \"collection_id\": \"25ff5E23-2a8a-aa6D-3778-5DaB0C2A6aCf\",\n \"user_id\": \"baF7f88f-bFf4-fe5B-aB73-DF08ABAD5d1d\",\n \"can_collect\": \"\",\n \"can_view\": \"self\",\n \"can_edit\": \"self\",\n \"assigned_by\": \"C455fCcc-3eF3-5dD4-68F1-d140B679FEd7\",\n \"assigned_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c27d918-6770-41d3-86fc-4f41d5f82c13", "name": "Update assignment rights", "request": { "name": "Update assignment rights", "description": { "content": "Sets can_collect, can_view, and can_edit for an existing assignment.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "assignments", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"can_collect\": \"\",\n \"can_view\": \"all\",\n \"can_edit\": \"self\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "12b482a3-eb7f-4739-9823-60202ed73425", "name": "Updated assignment.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "assignments", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"can_collect\": \"\",\n \"can_view\": \"all\",\n \"can_edit\": \"self\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"e34631de-200F-ebDa-3fcc-ef34f5AcdA4E\",\n \"organization_id\": \"59f146BF-Faa6-cEAB-B7fe-CE7C7BF8568f\",\n \"collection_id\": \"25ff5E23-2a8a-aa6D-3778-5DaB0C2A6aCf\",\n \"user_id\": \"baF7f88f-bFf4-fe5B-aB73-DF08ABAD5d1d\",\n \"can_collect\": \"\",\n \"can_view\": \"self\",\n \"can_edit\": \"self\",\n \"assigned_by\": \"C455fCcc-3eF3-5dD4-68F1-d140B679FEd7\",\n \"assigned_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "279e1eff-792e-41b3-8d0d-f1b85811fe7d", "name": "Unassign a collection from a user", "request": { "name": "Unassign a collection from a user", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "assignments", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1653ffc8-1d5d-4153-bbe0-12db537b39dd", "name": "Unassigned.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "collections", ":collection_id", "assignments", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"organization_id\": \"\",\n \"collection_id\": \"\",\n \"user_id\": \"\",\n \"unassigned\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "data-sources", "description": "", "item": [ { "id": "32436f03-f1b0-4929-8fe1-4e56b403b0c8", "name": "List data sources", "request": { "name": "List data sources", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1ad26bcd-001b-4e0a-8fe9-c1690a8736c0", "name": "Data sources.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"7dE7CdBE-3cbC-8CE7-8cbc-44Bbfb6A04af\",\n \"organization_id\": \"Bf8855a0-4b5e-4bde-ad6e-b66aBBCaacCb\",\n \"identifier\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"source_type\": \"form_records\",\n \"column_schema\": [\n {\n \"key_0\": 7858\n },\n {\n \"key_0\": false,\n \"key_1\": \"string\"\n }\n ],\n \"sync_to_mobile\": \"\",\n \"schema_version\": \"\",\n \"data_version\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"d3e0A47C-F4CD-763c-6fe3-F88ABBEaBAb0\",\n \"organization_id\": \"BEa69f4a-cDf4-C4e1-2a90-291dFd52BFC8\",\n \"identifier\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"source_type\": \"manual\",\n \"column_schema\": [\n {\n \"key_0\": true,\n \"key_1\": 4636\n },\n {\n \"key_0\": 8574.85119618158\n }\n ],\n \"sync_to_mobile\": \"\",\n \"schema_version\": \"\",\n \"data_version\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42cbc4a1-bbc5-4d33-a8c2-59f9bf8bb68f", "name": "Create a manual data source", "request": { "name": "Create a manual data source", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identifier\": \"c\",\n \"name\": \"\",\n \"column_schema\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"source_type\": \"manual\",\n \"sync_to_mobile\": \"\",\n \"database_config\": {\n \"db_type\": \"mysql\",\n \"host\": \"\",\n \"database\": \"\",\n \"table\": \"\",\n \"primary_key_column\": \"\",\n \"columns\": [\n {\n \"source_column\": \"\",\n \"key\": \"ucyuv692c\",\n \"type\": \"number\"\n }\n ],\n \"port\": \"\",\n \"schema\": \"\",\n \"ssl_mode\": \"disable\",\n \"sync_interval_minutes\": \"\"\n },\n \"credentials\": {\n \"username\": \"\",\n \"password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a2c370f0-3cc0-43f2-8fb6-a10897d3d24a", "name": "Created.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identifier\": \"c\",\n \"name\": \"\",\n \"column_schema\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"type\": \"\"\n }\n ],\n \"description\": \"\",\n \"source_type\": \"manual\",\n \"sync_to_mobile\": \"\",\n \"database_config\": {\n \"db_type\": \"mysql\",\n \"host\": \"\",\n \"database\": \"\",\n \"table\": \"\",\n \"primary_key_column\": \"\",\n \"columns\": [\n {\n \"source_column\": \"\",\n \"key\": \"ucyuv692c\",\n \"type\": \"number\"\n }\n ],\n \"port\": \"\",\n \"schema\": \"\",\n \"ssl_mode\": \"disable\",\n \"sync_interval_minutes\": \"\"\n },\n \"credentials\": {\n \"username\": \"\",\n \"password\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"6d18A114-beE2-656b-2550-4BA9cadDcbC5\",\n \"organization_id\": \"152618C5-e0A2-5FBC-eA6E-6CB0d5EDF4e2\",\n \"identifier\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"source_type\": \"manual\",\n \"column_schema\": [\n {\n \"key_0\": 4208.554263419295,\n \"key_1\": 7925,\n \"key_2\": 6729,\n \"key_3\": 619\n },\n {\n \"key_0\": 4979.353467518559,\n \"key_1\": 270.2715174763259,\n \"key_2\": false\n }\n ],\n \"sync_to_mobile\": \"\",\n \"schema_version\": \"\",\n \"data_version\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{data_source_id}", "description": "", "item": [ { "id": "4f7329c1-ad6a-4f91-be4f-82bd4a999148", "name": "Get a data source", "request": { "name": "Get a data source", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "data_source_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b1a3b35f-5eaf-4d55-ac18-ad025816d474", "name": "The source.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "data_source_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"6d18A114-beE2-656b-2550-4BA9cadDcbC5\",\n \"organization_id\": \"152618C5-e0A2-5FBC-eA6E-6CB0d5EDF4e2\",\n \"identifier\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"source_type\": \"manual\",\n \"column_schema\": [\n {\n \"key_0\": 4208.554263419295,\n \"key_1\": 7925,\n \"key_2\": 6729,\n \"key_3\": 619\n },\n {\n \"key_0\": 4979.353467518559,\n \"key_1\": 270.2715174763259,\n \"key_2\": false\n }\n ],\n \"sync_to_mobile\": \"\",\n \"schema_version\": \"\",\n \"data_version\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43afa6f2-750a-4a94-9993-e1d849e2e757", "name": "Update a data source", "request": { "name": "Update a data source", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "data_source_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"column_schema\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"type\": \"\"\n }\n ],\n \"sync_to_mobile\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9bad7d15-a539-4c8b-adaa-4567884eef3a", "name": "Updated.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "data_source_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"column_schema\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"type\": \"\"\n }\n ],\n \"sync_to_mobile\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"6d18A114-beE2-656b-2550-4BA9cadDcbC5\",\n \"organization_id\": \"152618C5-e0A2-5FBC-eA6E-6CB0d5EDF4e2\",\n \"identifier\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"source_type\": \"manual\",\n \"column_schema\": [\n {\n \"key_0\": 4208.554263419295,\n \"key_1\": 7925,\n \"key_2\": 6729,\n \"key_3\": 619\n },\n {\n \"key_0\": 4979.353467518559,\n \"key_1\": 270.2715174763259,\n \"key_2\": false\n }\n ],\n \"sync_to_mobile\": \"\",\n \"schema_version\": \"\",\n \"data_version\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5463f0e-8664-4fbc-ba93-900e6a925cc5", "name": "Soft-delete a data source", "request": { "name": "Soft-delete a data source", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "data_source_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "92dca657-877e-420a-a2cc-96900308a57b", "name": "Deactivated.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "data_source_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"6d18A114-beE2-656b-2550-4BA9cadDcbC5\",\n \"organization_id\": \"152618C5-e0A2-5FBC-eA6E-6CB0d5EDF4e2\",\n \"identifier\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"source_type\": \"manual\",\n \"column_schema\": [\n {\n \"key_0\": 4208.554263419295,\n \"key_1\": 7925,\n \"key_2\": 6729,\n \"key_3\": 619\n },\n {\n \"key_0\": 4979.353467518559,\n \"key_1\": 270.2715174763259,\n \"key_2\": false\n }\n ],\n \"sync_to_mobile\": \"\",\n \"schema_version\": \"\",\n \"data_version\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "rows", "description": "", "item": [ { "id": "7994f957-9a28-458c-93bd-641b56fba26c", "name": "List rows in a data source", "request": { "name": "List rows in a data source", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id", "rows" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "data_source_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4ddb5b2e-15c8-4f90-afd9-559e20a846b4", "name": "Rows.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id", "rows" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "data_source_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"1DfB7D45-115f-FCBC-7d79-EdD3bdAEcCCd\",\n \"lookup_source_id\": \"5fDcAA6a-B645-8ce2-F9c4-26fBC585feFf\",\n \"organization_id\": \"9c2C208E-eD53-1aeF-A67b-a69e287119F7\",\n \"external_id\": \"\",\n \"data\": {\n \"key_0\": 8169.194415278223\n },\n \"sort_order\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"625AFAf5-ecBb-ff9d-dbe5-fcbedfcAB8FF\",\n \"lookup_source_id\": \"bfF9cb4f-e3EB-E11e-6DC2-5cC1fBF45dCf\",\n \"organization_id\": \"2f0Caf5B-Bd0C-BD3C-6eB9-dAe1a7F6FFf8\",\n \"external_id\": \"\",\n \"data\": {\n \"key_0\": 2884.090275042732,\n \"key_1\": 1640\n },\n \"sort_order\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "473ca3d5-fb8c-4349-ab9b-6c32c10e2bbb", "name": "Bulk insert rows (1-1000)", "request": { "name": "Bulk insert rows (1-1000)", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id", "rows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "data_source_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"rows\": [\n {\n \"data\": {\n \"key_0\": 6120,\n \"key_1\": false\n },\n \"external_id\": \"\",\n \"sort_order\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2f6f252d-216d-43ac-b90a-454fe4fd9036", "name": "Inserted.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id", "rows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "data_source_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"rows\": [\n {\n \"data\": {\n \"key_0\": 6120,\n \"key_1\": false\n },\n \"external_id\": \"\",\n \"sort_order\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"4f9e1bBF-B52b-b2b8-850C-bcbd90ae0Fb2\",\n \"lookup_source_id\": \"04dD881F-481A-CcA4-26EE-9D32F273B67e\",\n \"organization_id\": \"093A8Eb0-8A1c-f0FE-33E5-72477a39050D\",\n \"external_id\": \"\",\n \"data\": {\n \"key_0\": 8332.395570414297,\n \"key_1\": 7953,\n \"key_2\": true\n },\n \"sort_order\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"D015C8ce-aAC2-b5d7-e17e-Be1a6BF7Eb03\",\n \"lookup_source_id\": \"DA5dAdDc-5aE0-E8dd-FaCF-Bf5Dbc66595d\",\n \"organization_id\": \"ea28cba0-eBa8-162E-7Cac-35Cf36C3EAB4\",\n \"external_id\": \"\",\n \"data\": {\n \"key_0\": 1483,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"sort_order\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"count\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{row_id}", "description": "", "item": [ { "id": "854b68af-cee8-4129-a4bb-0b859937c9e5", "name": "Get a row", "request": { "name": "Get a row", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id", "rows", ":row_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "data_source_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "row_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "84e29afb-94de-4f87-86f3-06eb5252cae7", "name": "The row.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id", "rows", ":row_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "data_source_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "row_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"F4e9a7b7-dBDA-9a9b-d60E-DF54d360FBBc\",\n \"lookup_source_id\": \"Ca4B7879-21CC-aE42-bfD4-aC7f150B8bEC\",\n \"organization_id\": \"8C3ADb1a-27AB-fc4d-E4F9-EBadEaEE15E4\",\n \"external_id\": \"\",\n \"data\": {\n \"key_0\": 3402\n },\n \"sort_order\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be77ff7b-fd4b-4d36-82d3-77d79eb419d3", "name": "Update a row", "request": { "name": "Update a row", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id", "rows", ":row_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "data_source_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "row_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"data\": {\n \"key_0\": true\n },\n \"sort_order\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "920518d8-9df1-4d80-ac6f-295459a3ef48", "name": "Updated.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id", "rows", ":row_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "data_source_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "row_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"external_id\": \"\",\n \"data\": {\n \"key_0\": true\n },\n \"sort_order\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"F4e9a7b7-dBDA-9a9b-d60E-DF54d360FBBc\",\n \"lookup_source_id\": \"Ca4B7879-21CC-aE42-bfD4-aC7f150B8bEC\",\n \"organization_id\": \"8C3ADb1a-27AB-fc4d-E4F9-EBadEaEE15E4\",\n \"external_id\": \"\",\n \"data\": {\n \"key_0\": 3402\n },\n \"sort_order\": \"\",\n \"is_active\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7c13102-40fb-4c1d-8069-6adea752cd99", "name": "Soft-delete a row", "request": { "name": "Soft-delete a row", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id", "rows", ":row_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "data_source_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "row_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7516d64e-acbc-436b-8dda-3b53c280261e", "name": "Deleted.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "data-sources", ":data_source_id", "rows", ":row_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "data_source_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "row_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"deleted\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "forms", "description": "", "item": [ { "name": "{form_id}", "description": "", "item": [ { "name": "records", "description": "", "item": [ { "id": "c3aae0bd-8471-46d3-8381-6e2ecb8b38a3", "name": "List records for a form", "request": { "name": "List records for a form", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "records" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of submitted_at,-submitted_at)", "type": "text/plain" }, "key": "sort", "value": "-submitted_at" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "submitted_by", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "92b90f16-d9f1-4349-aa12-48015a32e42b", "name": "Records.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "records" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of submitted_at,-submitted_at)", "type": "text/plain" }, "key": "sort", "value": "-submitted_at" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "submitted_by", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"cc6f5636-DBef-1AB2-842b-55C0cF40F4d5\",\n \"form_id\": \"CEECb45C-8c32-1523-4e1d-Ec820df41BB1\",\n \"form_version\": \"\",\n \"organization_id\": \"DDb27bBB-F3dC-3efD-B0Ba-2ae6E2Ab561a\",\n \"created_by\": \"bE94E21E-E4d1-5787-5aeC-Bf4BECEd5882\",\n \"custodian_user_id\": \"1aa0772A-BBA5-9cDd-B4DF-26B7AcEf8beD\",\n \"field_values\": {\n \"key_0\": false,\n \"key_1\": false\n },\n \"device_info\": null,\n \"submission_location\": {\n \"key_0\": true,\n \"key_1\": false\n },\n \"upload_checksum\": \"\",\n \"submitted_at\": \"\",\n \"created_at\": \"\",\n \"dispatched_at\": \"\",\n \"dispatch_downloaded_at\": \"\"\n },\n {\n \"id\": \"f68d46A4-F1D5-67b2-a7b4-35dABe5fAf2E\",\n \"form_id\": \"0Bbca4c7-Be4e-073a-1c12-fbC68fb67a3B\",\n \"form_version\": \"\",\n \"organization_id\": \"aA3282BC-0bf2-caf4-8ceB-faD8BeAd2B7D\",\n \"created_by\": \"78bD7ECB-A027-e377-f0B3-Db7c3443B0A3\",\n \"custodian_user_id\": \"2Bf9E73d-afAF-CeBe-DA1c-93123d44fbdd\",\n \"field_values\": {\n \"key_0\": false\n },\n \"device_info\": null,\n \"submission_location\": null,\n \"upload_checksum\": \"\",\n \"submitted_at\": \"\",\n \"created_at\": \"\",\n \"dispatched_at\": \"\",\n \"dispatch_downloaded_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be15788b-f670-43a9-8aa3-843f037669a1", "name": "Create a record", "request": { "name": "Create a record", "description": { "content": "created_by must be the auth.users id of a user who is a member of the target organization. form_version defaults to the form's latest published version when omitted. upload_checksum is computed server-side.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"created_by\": \"122AB24F-bbdA-f4dd-cE89-1D3AB3e86D7B\",\n \"field_values\": {\n \"key_0\": true,\n \"key_1\": 3108.2679674485835\n },\n \"form_version\": \"\",\n \"submitted_at\": \"\",\n \"device_info\": {\n \"key_0\": true\n },\n \"submission_location\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 4830.334422182139\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e60b8373-036f-44f2-a53a-917d8c53da98", "name": "Created.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"created_by\": \"122AB24F-bbdA-f4dd-cE89-1D3AB3e86D7B\",\n \"field_values\": {\n \"key_0\": true,\n \"key_1\": 3108.2679674485835\n },\n \"form_version\": \"\",\n \"submitted_at\": \"\",\n \"device_info\": {\n \"key_0\": true\n },\n \"submission_location\": {\n \"key_0\": \"string\",\n \"key_1\": true,\n \"key_2\": 4830.334422182139\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"5F4fd688-C47f-dad6-45c6-35f306983a4d\",\n \"form_id\": \"Abe9B3c6-804e-DEE4-Ab20-E9AedCe74Ce8\",\n \"form_version\": \"\",\n \"organization_id\": \"aE89b0ac-7cCe-Ddef-b829-257683D86b22\",\n \"created_by\": \"141e9834-29CD-629C-d10d-cA471D4b7Bcf\",\n \"custodian_user_id\": \"7a5461B4-B7ae-7c07-1b7e-3f5EF60398AD\",\n \"field_values\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"device_info\": null,\n \"submission_location\": null,\n \"upload_checksum\": \"\",\n \"submitted_at\": \"\",\n \"created_at\": \"\",\n \"dispatched_at\": \"\",\n \"dispatch_downloaded_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{record_id}", "description": "", "item": [ { "id": "3d40523f-9cfb-4abf-aa25-fede50adef67", "name": "Get a record", "request": { "name": "Get a record", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "records", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "record_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1c883518-ae26-47ff-b591-511a429a9fa6", "name": "The record.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "records", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "record_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"5F4fd688-C47f-dad6-45c6-35f306983a4d\",\n \"form_id\": \"Abe9B3c6-804e-DEE4-Ab20-E9AedCe74Ce8\",\n \"form_version\": \"\",\n \"organization_id\": \"aE89b0ac-7cCe-Ddef-b829-257683D86b22\",\n \"created_by\": \"141e9834-29CD-629C-d10d-cA471D4b7Bcf\",\n \"custodian_user_id\": \"7a5461B4-B7ae-7c07-1b7e-3f5EF60398AD\",\n \"field_values\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"device_info\": null,\n \"submission_location\": null,\n \"upload_checksum\": \"\",\n \"submitted_at\": \"\",\n \"created_at\": \"\",\n \"dispatched_at\": \"\",\n \"dispatch_downloaded_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "189ec8ed-1506-494d-b694-d21bbcb0db49", "name": "Update a record", "request": { "name": "Update a record", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "records", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "record_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"field_values\": {\n \"key_0\": 1844.606265439024,\n \"key_1\": 9931.643988652455,\n \"key_2\": 7033,\n \"key_3\": 2623.289836360052\n },\n \"device_info\": {\n \"key_0\": false,\n \"key_1\": 429\n },\n \"submission_location\": {\n \"key_0\": 1817,\n \"key_1\": 5814\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "135f2110-4ee0-4045-ba04-65f4a581791d", "name": "Updated.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "records", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "record_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"field_values\": {\n \"key_0\": 1844.606265439024,\n \"key_1\": 9931.643988652455,\n \"key_2\": 7033,\n \"key_3\": 2623.289836360052\n },\n \"device_info\": {\n \"key_0\": false,\n \"key_1\": 429\n },\n \"submission_location\": {\n \"key_0\": 1817,\n \"key_1\": 5814\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"5F4fd688-C47f-dad6-45c6-35f306983a4d\",\n \"form_id\": \"Abe9B3c6-804e-DEE4-Ab20-E9AedCe74Ce8\",\n \"form_version\": \"\",\n \"organization_id\": \"aE89b0ac-7cCe-Ddef-b829-257683D86b22\",\n \"created_by\": \"141e9834-29CD-629C-d10d-cA471D4b7Bcf\",\n \"custodian_user_id\": \"7a5461B4-B7ae-7c07-1b7e-3f5EF60398AD\",\n \"field_values\": {\n \"key_0\": true,\n \"key_1\": \"string\"\n },\n \"device_info\": null,\n \"submission_location\": null,\n \"upload_checksum\": \"\",\n \"submitted_at\": \"\",\n \"created_at\": \"\",\n \"dispatched_at\": \"\",\n \"dispatch_downloaded_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "71e02997-4f00-4b9d-82bc-d478fa8af195", "name": "Delete a record", "request": { "name": "Delete a record", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "records", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "record_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "66b77c20-44e3-47d1-8d55-8591072b3515", "name": "Deleted.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "records", ":record_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "record_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"deleted\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "177ccc49-2a9b-4696-8613-cf80ae20c3c1", "name": "Get a form", "request": { "name": "Get a form", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cb9e7639-5608-4de0-9829-dc67c83ab28c", "name": "The form.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"a9eFEDe3-56D0-51CF-0FfF-63Fe0dFeD3Ae\",\n \"organization_id\": \"bf4F6CFE-AA1b-B902-1F09-f40FbDEC7A9B\",\n \"name\": \"\",\n \"description\": \"\",\n \"icon\": \"\",\n \"author\": \"\",\n \"form_identifier\": \"\",\n \"fields\": [\n {\n \"key_0\": 3323,\n \"key_1\": 9380\n },\n {\n \"key_0\": \"string\",\n \"key_1\": false\n }\n ],\n \"display_fields\": [\n \"\",\n \"\"\n ],\n \"is_active\": \"\",\n \"last_published_version\": \"\",\n \"last_published_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f97461e-a275-4382-a5e9-17142cc922d5", "name": "Update a draft form", "request": { "name": "Update a draft form", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"form_identifier\": \"jvg\",\n \"description\": \"\",\n \"icon\": \"\",\n \"author\": \"\",\n \"fields\": [\n {\n \"key_0\": 2173.161989000545,\n \"key_1\": false,\n \"key_2\": true,\n \"key_3\": 560\n },\n {\n \"key_0\": 1187\n }\n ],\n \"display_fields\": [\n \"\",\n \"\"\n ],\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "633505c0-4c25-4f69-b3ae-f9e5f789e66a", "name": "Updated.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"form_identifier\": \"jvg\",\n \"description\": \"\",\n \"icon\": \"\",\n \"author\": \"\",\n \"fields\": [\n {\n \"key_0\": 2173.161989000545,\n \"key_1\": false,\n \"key_2\": true,\n \"key_3\": 560\n },\n {\n \"key_0\": 1187\n }\n ],\n \"display_fields\": [\n \"\",\n \"\"\n ],\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"a9eFEDe3-56D0-51CF-0FfF-63Fe0dFeD3Ae\",\n \"organization_id\": \"bf4F6CFE-AA1b-B902-1F09-f40FbDEC7A9B\",\n \"name\": \"\",\n \"description\": \"\",\n \"icon\": \"\",\n \"author\": \"\",\n \"form_identifier\": \"\",\n \"fields\": [\n {\n \"key_0\": 3323,\n \"key_1\": 9380\n },\n {\n \"key_0\": \"string\",\n \"key_1\": false\n }\n ],\n \"display_fields\": [\n \"\",\n \"\"\n ],\n \"is_active\": \"\",\n \"last_published_version\": \"\",\n \"last_published_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90bc07c4-2808-4e3b-bb49-6a4bc0481c3a", "name": "Soft-delete a form", "request": { "name": "Soft-delete a form", "description": { "content": "Sets is_active=false. The hard-delete + cascade flow remains dashboard-only.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4e56bea4-1610-454c-9827-9e0c8bd3a2bd", "name": "Deactivated.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"a9eFEDe3-56D0-51CF-0FfF-63Fe0dFeD3Ae\",\n \"organization_id\": \"bf4F6CFE-AA1b-B902-1F09-f40FbDEC7A9B\",\n \"name\": \"\",\n \"description\": \"\",\n \"icon\": \"\",\n \"author\": \"\",\n \"form_identifier\": \"\",\n \"fields\": [\n {\n \"key_0\": 3323,\n \"key_1\": 9380\n },\n {\n \"key_0\": \"string\",\n \"key_1\": false\n }\n ],\n \"display_fields\": [\n \"\",\n \"\"\n ],\n \"is_active\": \"\",\n \"last_published_version\": \"\",\n \"last_published_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "publish", "description": "", "item": [ { "id": "3a49fe21-9ece-43fe-824b-fdb2efe8e34b", "name": "Publish a new form version", "request": { "name": "Publish a new form version", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"changelog\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9d49b94b-ec2d-4e1e-809e-d896f8633b98", "name": "Published.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"changelog\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"form_id\": \"\",\n \"version\": \"\",\n \"published_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "assign-users", "description": "", "item": [ { "id": "43dd686e-a5d5-45ef-986c-8fc47315ab7a", "name": "Assign or unassign users to a form", "request": { "name": "Assign or unassign users to a form", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "assign-users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"FEeA3fD0-35Cb-7b47-A31b-1DF295FfC725\"\n ],\n \"unassign\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a374cb31-3909-497f-af15-5c010a24ec3a", "name": "Outcome.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms", ":form_id", "assign-users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"FEeA3fD0-35Cb-7b47-A31b-1DF295FfC725\"\n ],\n \"unassign\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"assigned\": [\n \"\",\n \"\"\n ],\n \"unassigned\": [\n \"\",\n \"\"\n ]\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "id": "5cf94420-620b-4c38-a624-7e55722794d6", "name": "List forms in an organization", "request": { "name": "List forms in an organization", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of created_at,-created_at,updated_at,-updated_at,name,-name)", "type": "text/plain" }, "key": "sort", "value": "-name" }, { "disabled": false, "description": { "content": " (This can only be one of true,false)", "type": "text/plain" }, "key": "is_active", "value": "true" }, { "disabled": false, "description": { "content": " (This can only be one of true,false)", "type": "text/plain" }, "key": "published", "value": "true" } ], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0417e5f3-7c64-43bb-bf50-9bd7ee479ff1", "name": "Forms.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of created_at,-created_at,updated_at,-updated_at,name,-name)", "type": "text/plain" }, "key": "sort", "value": "-name" }, { "disabled": false, "description": { "content": " (This can only be one of true,false)", "type": "text/plain" }, "key": "is_active", "value": "true" }, { "disabled": false, "description": { "content": " (This can only be one of true,false)", "type": "text/plain" }, "key": "published", "value": "true" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"657F32fC-F55b-2ccD-B882-68EB0B083DEE\",\n \"organization_id\": \"6D5403dB-aBaa-c22f-124c-cBAD86aa164e\",\n \"name\": \"\",\n \"description\": \"\",\n \"icon\": \"\",\n \"author\": \"\",\n \"form_identifier\": \"\",\n \"fields\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"display_fields\": null,\n \"is_active\": \"\",\n \"last_published_version\": \"\",\n \"last_published_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"8dE8da6E-fA65-fa47-85A0-3Bbd9FE1aE26\",\n \"organization_id\": \"b4C058b6-c3D6-dd1E-D0DF-AbFBD7a17EBF\",\n \"name\": \"\",\n \"description\": \"\",\n \"icon\": \"\",\n \"author\": \"\",\n \"form_identifier\": \"\",\n \"fields\": [\n {\n \"key_0\": 1640,\n \"key_1\": 7474\n },\n {\n \"key_0\": 6895\n }\n ],\n \"display_fields\": null,\n \"is_active\": \"\",\n \"last_published_version\": \"\",\n \"last_published_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0dc277ef-1617-4bb6-9644-753c49a7e355", "name": "Create a draft form", "request": { "name": "Create a draft form", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"form_identifier\": \"qzeeg\",\n \"fields\": [\n {\n \"key_0\": 1777,\n \"key_1\": 3403\n },\n {\n \"key_0\": 8398,\n \"key_1\": \"string\"\n }\n ],\n \"description\": \"\",\n \"icon\": \"\",\n \"author\": \"\",\n \"display_fields\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "66007563-8493-4f0f-b95b-1086a8f7ed0e", "name": "Created.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"form_identifier\": \"qzeeg\",\n \"fields\": [\n {\n \"key_0\": 1777,\n \"key_1\": 3403\n },\n {\n \"key_0\": 8398,\n \"key_1\": \"string\"\n }\n ],\n \"description\": \"\",\n \"icon\": \"\",\n \"author\": \"\",\n \"display_fields\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"a9eFEDe3-56D0-51CF-0FfF-63Fe0dFeD3Ae\",\n \"organization_id\": \"bf4F6CFE-AA1b-B902-1F09-f40FbDEC7A9B\",\n \"name\": \"\",\n \"description\": \"\",\n \"icon\": \"\",\n \"author\": \"\",\n \"form_identifier\": \"\",\n \"fields\": [\n {\n \"key_0\": 3323,\n \"key_1\": 9380\n },\n {\n \"key_0\": \"string\",\n \"key_1\": false\n }\n ],\n \"display_fields\": [\n \"\",\n \"\"\n ],\n \"is_active\": \"\",\n \"last_published_version\": \"\",\n \"last_published_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "reports", "description": "", "item": [ { "id": "0b8492cc-0385-4bc6-b0ea-716c5f24b6b5", "name": "List report templates", "request": { "name": "List report templates", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7715d3b0-f8f3-41e4-b2bd-9e3fedf43205", "name": "Templates.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"aD9BfF8A-Fd7E-2ae3-C92D-d940aCad8AE5\",\n \"organization_id\": \"CCfc7e00-DbF5-26fc-3dA8-CA8BD159760b\",\n \"name\": \"\",\n \"description\": \"\",\n \"template_html\": \"\",\n \"template_css\": \"\",\n \"delivery_mode\": \"embedded\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"output_filename\": \"\",\n \"output_format\": null,\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"ACf92aAa-6ceE-53b0-A7fB-3a8c1AC9E7cC\",\n \"organization_id\": \"7220D28c-5e68-d9Bc-8Bb1-2a8b33dC3E79\",\n \"name\": \"\",\n \"description\": \"\",\n \"template_html\": \"\",\n \"template_css\": \"\",\n \"delivery_mode\": \"embedded\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"output_filename\": \"\",\n \"output_format\": \"pdf\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2e9b8ee-1a2a-40a6-8d84-195c5f387909", "name": "Create a report template", "request": { "name": "Create a report template", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"template_html\": \"\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"description\": \"\",\n \"template_css\": \"\",\n \"delivery_mode\": \"attachment\",\n \"email_body\": \"\",\n \"output_filename\": \"\",\n \"output_format\": \"pdf\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "584fbe5d-ed64-466f-8b75-fe7970d511c8", "name": "Created.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"template_html\": \"\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"description\": \"\",\n \"template_css\": \"\",\n \"delivery_mode\": \"attachment\",\n \"email_body\": \"\",\n \"output_filename\": \"\",\n \"output_format\": \"pdf\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"043AEFeE-E5Ac-bB7B-cddD-A8BD84076F6B\",\n \"organization_id\": \"DB53F1dF-0AEB-636A-fE3a-6Eea8e25dcAd\",\n \"name\": \"\",\n \"description\": \"\",\n \"template_html\": \"\",\n \"template_css\": \"\",\n \"delivery_mode\": \"embedded\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"output_filename\": \"\",\n \"output_format\": \"html\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{report_id}", "description": "", "item": [ { "id": "0f04faf2-8af9-410c-aa45-4162ffa50dbf", "name": "Get a report template", "request": { "name": "Get a report template", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "report_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1fdc32e4-af5f-406b-a501-5cd8c1727110", "name": "Template.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "report_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"043AEFeE-E5Ac-bB7B-cddD-A8BD84076F6B\",\n \"organization_id\": \"DB53F1dF-0AEB-636A-fE3a-6Eea8e25dcAd\",\n \"name\": \"\",\n \"description\": \"\",\n \"template_html\": \"\",\n \"template_css\": \"\",\n \"delivery_mode\": \"embedded\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"output_filename\": \"\",\n \"output_format\": \"html\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "909a97ec-644d-4391-ac10-06931bfaf6a3", "name": "Update a report template", "request": { "name": "Update a report template", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "report_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"template_html\": \"\",\n \"template_css\": \"\",\n \"delivery_mode\": \"attachment\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"output_filename\": \"\",\n \"output_format\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b6675f41-7c4b-4264-9688-73f33b712e10", "name": "Updated.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "report_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"template_html\": \"\",\n \"template_css\": \"\",\n \"delivery_mode\": \"attachment\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"output_filename\": \"\",\n \"output_format\": null\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"043AEFeE-E5Ac-bB7B-cddD-A8BD84076F6B\",\n \"organization_id\": \"DB53F1dF-0AEB-636A-fE3a-6Eea8e25dcAd\",\n \"name\": \"\",\n \"description\": \"\",\n \"template_html\": \"\",\n \"template_css\": \"\",\n \"delivery_mode\": \"embedded\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"email_body\": \"\",\n \"output_filename\": \"\",\n \"output_format\": \"html\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a374795-79aa-4639-95e8-b62683887ec7", "name": "Delete a report template", "request": { "name": "Delete a report template", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "report_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "38a3cd70-702c-4755-ac22-9c4fdcc02b60", "name": "Deleted.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "report_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"deleted\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "merge", "description": "", "item": [ { "id": "0b52846c-6a67-4d05-8142-ed3a979db4c9", "name": "Render + deliver a report", "request": { "name": "Render + deliver a report", "description": { "content": "Proxies the merge to the merge-document edge function. The API key authorises the call; the template's secret_key is used server-side as the upstream bearer. The posted JSON object is exactly what the template's merge fields see — a field `{$name}` reads the `name` key. The render is queued (202) and the finished file is emailed per the template's delivery settings; track it under the template's deliveries.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "report_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8a47cbff-0e31-4aa1-8d23-bc951b188e64", "name": "Queued. The body carries the delivery job id: { \"job_id\": \"…\" }.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "report_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"job_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8bb5605-a39c-4e83-85cd-a37c9b34f85e", "name": "Upstream merge-document call failed.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "report_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"key_0\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Gateway", "code": 502, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "deliveries", "description": "", "item": [ { "id": "5944e8bd-c68b-49e4-9ba9-c1e49361461b", "name": "List delivery jobs", "request": { "name": "List delivery jobs", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "report_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6dab39c5-53a0-4a3c-8206-d6cfc19fd054", "name": "Deliveries.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "report_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"f811a545-56dB-c8f0-4D1d-e9f0dac286F6\",\n \"document_template_id\": \"9EBEb5bb-EBf9-aB35-3373-CafbFfF5BDcd\",\n \"organization_id\": \"FbEE12b3-dD44-3af7-7D6E-d4acEB54d482\",\n \"status\": \"\",\n \"output_filename\": \"\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"retry_count\": \"\",\n \"max_retries\": \"\",\n \"next_retry_at\": \"\",\n \"error_message\": \"\",\n \"delivered_at\": \"\",\n \"output_format\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"F56b17Be-fcB8-d9BC-ECdd-3CeE3ce2eb41\",\n \"document_template_id\": \"08528f78-bEEA-04a9-dee8-38d988a9800F\",\n \"organization_id\": \"7CFeacDF-CCe3-AC81-e9Dd-C531DB4cdCc0\",\n \"status\": \"\",\n \"output_filename\": \"\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"retry_count\": \"\",\n \"max_retries\": \"\",\n \"next_retry_at\": \"\",\n \"error_message\": \"\",\n \"delivered_at\": \"\",\n \"output_format\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{delivery_id}", "description": "", "item": [ { "id": "bae65149-b513-46a9-8448-2cc0ff58d7c1", "name": "Get a delivery", "request": { "name": "Get a delivery", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id", "deliveries", ":delivery_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "report_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "delivery_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "051495e2-2d3d-46f2-abde-4dd2a8c3a13f", "name": "Delivery.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id", "deliveries", ":delivery_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "report_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "delivery_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"Fa5a6EA8-5ea1-cC61-dB4c-3999D195bFc1\",\n \"document_template_id\": \"Ed747Bfe-5A44-F9C7-eBDA-f2c2ab8CbBdf\",\n \"organization_id\": \"a5B8DefD-43CF-Ed4f-726f-Fbd8CEf9Fa3d\",\n \"status\": \"\",\n \"output_filename\": \"\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"retry_count\": \"\",\n \"max_retries\": \"\",\n \"next_retry_at\": \"\",\n \"error_message\": \"\",\n \"delivered_at\": \"\",\n \"output_format\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "retry", "description": "", "item": [ { "id": "9fe78163-f0be-4fc0-bc9b-d1d15bb68361", "name": "Re-queue a failed delivery", "request": { "name": "Re-queue a failed delivery", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id", "deliveries", ":delivery_id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "report_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "delivery_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b8117b3e-6a88-4495-bcf9-8bf91942d8dc", "name": "Re-queued.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "reports", ":report_id", "deliveries", ":delivery_id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "report_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "delivery_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"Fa5a6EA8-5ea1-cC61-dB4c-3999D195bFc1\",\n \"document_template_id\": \"Ed747Bfe-5A44-F9C7-eBDA-f2c2ab8CbBdf\",\n \"organization_id\": \"a5B8DefD-43CF-Ed4f-726f-Fbd8CEf9Fa3d\",\n \"status\": \"\",\n \"output_filename\": \"\",\n \"recipient_email\": \"\",\n \"email_subject\": \"\",\n \"retry_count\": \"\",\n \"max_retries\": \"\",\n \"next_retry_at\": \"\",\n \"error_message\": \"\",\n \"delivered_at\": \"\",\n \"output_format\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] }, { "name": "teams", "description": "", "item": [ { "id": "b569eac6-d376-4749-a312-50d927da30d9", "name": "List teams in an organization", "request": { "name": "List teams in an organization", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of created_at,-created_at,updated_at,-updated_at,name,-name)", "type": "text/plain" }, "key": "sort", "value": "-name" } ], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "da364082-12ee-4cea-a272-9e61261b4126", "name": "Teams.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of created_at,-created_at,updated_at,-updated_at,name,-name)", "type": "text/plain" }, "key": "sort", "value": "-name" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"ce008BB5-6c7F-F3bb-Eeca-5f3F1Bb798AA\",\n \"organization_id\": \"ced7d63A-299F-Eb5c-DeF0-0df7C89B09e7\",\n \"name\": \"\",\n \"description\": \"\",\n \"created_by\": \"7c0CaDE4-B7E9-BE46-A226-BbdFDC28b03d\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"3c6dD1C7-F8bE-5835-b01F-4b1cD50E2Def\",\n \"organization_id\": \"cCfb56EB-1C7B-7fe2-6ef8-b4f0Cd36C2e9\",\n \"name\": \"\",\n \"description\": \"\",\n \"created_by\": \"b5A7378b-d95E-eBE5-afF8-0C71886C47d5\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c6fa7a3-b69a-4d47-af48-aed1798e1a5f", "name": "Create a team", "request": { "name": "Create a team", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "daaf215c-d0dd-480f-9c5e-40a8158d718d", "name": "Created.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"a962E15a-63cF-5aEF-e50f-5f0aC691748a\",\n \"organization_id\": \"E68e7F5F-e61f-2f37-C38C-b5A6adB2caca\",\n \"name\": \"\",\n \"description\": \"\",\n \"created_by\": \"3a0BC6AD-ccAc-FAB5-04EE-8c9eFC3B94CF\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{team_id}", "description": "", "item": [ { "id": "c4ce3ce5-ad94-4b2e-ab8f-b5e1d7f25570", "name": "Get a team", "request": { "name": "Get a team", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0f525b97-cc1c-453a-88ae-9bdf3bc4f930", "name": "The team.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"a962E15a-63cF-5aEF-e50f-5f0aC691748a\",\n \"organization_id\": \"E68e7F5F-e61f-2f37-C38C-b5A6adB2caca\",\n \"name\": \"\",\n \"description\": \"\",\n \"created_by\": \"3a0BC6AD-ccAc-FAB5-04EE-8c9eFC3B94CF\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "114510ef-2b55-4502-a020-7daec9dbf354", "name": "Update a team", "request": { "name": "Update a team", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0b297fb9-c759-4fcb-8cbf-18c346d45c5d", "name": "Updated.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"a962E15a-63cF-5aEF-e50f-5f0aC691748a\",\n \"organization_id\": \"E68e7F5F-e61f-2f37-C38C-b5A6adB2caca\",\n \"name\": \"\",\n \"description\": \"\",\n \"created_by\": \"3a0BC6AD-ccAc-FAB5-04EE-8c9eFC3B94CF\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e31e2a0-0896-4769-83be-6e9ef2a4d710", "name": "Delete a team", "request": { "name": "Delete a team", "description": { "content": "Hard-deletes the team. Its members, form assignments, and collection assignments cascade away; derived form access drops immediately.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2071c0f1-cdee-4471-b249-074cc4b75f94", "name": "Deletion confirmation.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"deleted\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "members", "description": "", "item": [ { "id": "db81ebd3-cc2d-4d2c-9073-373a03fd9d39", "name": "List members of a team", "request": { "name": "List members of a team", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "216dd88e-0fc8-4c38-84d5-746fec71f691", "name": "Team members.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"Ac97CFC5-Ca05-B27c-accC-AE3dBDcED8ce\",\n \"organization_id\": \"FD47dBeE-8E9e-376C-bf11-49ADfB9cFfC7\",\n \"team_id\": \"6AbBB7B1-BdA4-99D4-47aB-3f0f48f5F8b7\",\n \"user_id\": \"fe17fbd4-5EBe-9E91-4C5e-5BcE0BC06De3\",\n \"added_by\": \"abE2cba4-AaE7-120F-9c0E-5dc1Af8a7eCd\",\n \"added_at\": \"\"\n },\n {\n \"id\": \"969E1f5D-7811-C9dA-fFF1-3fdD364e757b\",\n \"organization_id\": \"41b8c612-Abb4-Ca14-6fA3-F7A619EBd39e\",\n \"team_id\": \"2ea2fA1c-1Ac4-88b3-A3db-35D1b75f2cFE\",\n \"user_id\": \"fd3cea73-Cc0B-9381-5baC-D0aBd3eCb0c7\",\n \"added_by\": \"f50CF1CE-7CCC-0708-EFCb-69A4cE92c15b\",\n \"added_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94e7a166-833b-4896-8d70-2c533228f466", "name": "Add a member to a team", "request": { "name": "Add a member to a team", "description": { "content": "Idempotent — re-adding a user already in the team returns the existing membership. The user must be a member of the organization.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"C3a0AE5B-1aEc-8e1c-39fb-e60a55DfB4ee\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c2b0cd03-fe8d-48ba-a7cb-a78e6dfde448", "name": "Member added.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"C3a0AE5B-1aEc-8e1c-39fb-e60a55DfB4ee\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"team_id\": \"\",\n \"user_id\": \"\",\n \"added\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{user_id}", "description": "", "item": [ { "id": "0140dda9-bf95-428c-a820-0753ec25da2b", "name": "Remove a member from a team", "request": { "name": "Remove a member from a team", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "16bfa8d6-908b-43f3-9bee-a6bd090d00cb", "name": "Member removed.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "members", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"organization_id\": \"\",\n \"team_id\": \"\",\n \"user_id\": \"\",\n \"removed\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "forms", "description": "", "item": [ { "id": "9e33726d-9349-49d8-911e-ef54b6eb3881", "name": "List form assignments for a team", "request": { "name": "List form assignments for a team", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3e6020f7-3601-468e-bbc2-68d8d63410c8", "name": "Form assignments.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"E2a5cbD8-1b3B-8061-8Fab-D9fbFDcEDFB9\",\n \"organization_id\": \"Fc7Bf1Bf-c03F-aef5-6E95-Ba2aC49EDf7B\",\n \"team_id\": \"8A142302-6566-aBb9-Acb8-D54ff242EFEE\",\n \"form_id\": \"dd898eCc-4265-123B-7dc5-86EaED9CD6eC\",\n \"can_collect\": \"\",\n \"can_view\": \"none\",\n \"can_edit\": \"none\",\n \"assigned_by\": \"4B0d0557-aBB0-0e3C-B1Bc-cf2caAa1AE2A\",\n \"assigned_at\": \"\"\n },\n {\n \"id\": \"47a60dBf-bffe-dCEF-B65e-D4c3923E3E7f\",\n \"organization_id\": \"08D79b4A-a6c6-9BB0-FA04-9aefA88Ed72B\",\n \"team_id\": \"cF39AC68-F3BF-5e7C-97B0-2040dC90ea2E\",\n \"form_id\": \"741b837A-711C-dd3e-6b90-49A5fcDe2FC8\",\n \"can_collect\": \"\",\n \"can_view\": \"all\",\n \"can_edit\": \"self\",\n \"assigned_by\": \"34Be1De7-b8E4-be8f-72cE-F66e130a6ced\",\n \"assigned_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e8a495f9-8456-44ab-82ff-d07074231a95", "name": "Assign a form to a team", "request": { "name": "Assign a form to a team", "description": { "content": "Grants every member of the team access to the form with the given rights. Idempotent — re-assigning returns the existing assignment. Optional `can_collect`, `can_view`, and `can_edit` override the defaults (true / self / none).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"form_id\": \"ac9Be81F-8B29-669f-BDDA-a8C81cdAdDF3\",\n \"can_collect\": \"\",\n \"can_view\": \"none\",\n \"can_edit\": \"all\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fda1138d-8117-4040-b7e0-3dba7b527ba2", "name": "Assigned.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"form_id\": \"ac9Be81F-8B29-669f-BDDA-a8C81cdAdDF3\",\n \"can_collect\": \"\",\n \"can_view\": \"none\",\n \"can_edit\": \"all\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"9Dd56dDC-78c0-cfE0-F42C-3ac9868C4Cfd\",\n \"organization_id\": \"fc711bbb-6a24-CFef-2C06-14C0cd0Fb7fa\",\n \"team_id\": \"E2e48d53-ee32-FCb4-baFb-e4dd0AAd3d7e\",\n \"form_id\": \"fC1D23cC-969f-5ecd-61f3-bC917FCD4fBf\",\n \"can_collect\": \"\",\n \"can_view\": \"self\",\n \"can_edit\": \"none\",\n \"assigned_by\": \"49Ad96e0-17Bc-D371-Df41-7f22008d74Bf\",\n \"assigned_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{form_id}", "description": "", "item": [ { "id": "66bb4d68-7616-4bda-a3e7-e6cbf39c3d67", "name": "Update team form assignment rights", "request": { "name": "Update team form assignment rights", "description": { "content": "Sets can_collect, can_view, and can_edit for an existing form assignment.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "forms", ":form_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"can_collect\": \"\",\n \"can_view\": \"all\",\n \"can_edit\": \"self\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a0171ab4-cb0d-4f65-a3a3-abbf01e8d5d3", "name": "Updated assignment.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "forms", ":form_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"can_collect\": \"\",\n \"can_view\": \"all\",\n \"can_edit\": \"self\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"9Dd56dDC-78c0-cfE0-F42C-3ac9868C4Cfd\",\n \"organization_id\": \"fc711bbb-6a24-CFef-2C06-14C0cd0Fb7fa\",\n \"team_id\": \"E2e48d53-ee32-FCb4-baFb-e4dd0AAd3d7e\",\n \"form_id\": \"fC1D23cC-969f-5ecd-61f3-bC917FCD4fBf\",\n \"can_collect\": \"\",\n \"can_view\": \"self\",\n \"can_edit\": \"none\",\n \"assigned_by\": \"49Ad96e0-17Bc-D371-Df41-7f22008d74Bf\",\n \"assigned_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a044ab55-f71d-49f1-8429-87eb7a7348d3", "name": "Unassign a form from a team", "request": { "name": "Unassign a form from a team", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "forms", ":form_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "form_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8f8f205d-1c3b-4f96-bf69-48c6179b4c83", "name": "Unassigned.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "forms", ":form_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "form_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"organization_id\": \"\",\n \"team_id\": \"\",\n \"form_id\": \"\",\n \"unassigned\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "collections", "description": "", "item": [ { "id": "9bc3c3f2-45c8-45e8-ad9a-ae53f5e8ff95", "name": "List collection assignments for a team", "request": { "name": "List collection assignments for a team", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cf642084-92b0-4a4c-b51c-e8f78950eea0", "name": "Collection assignments.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"7ACB6E4f-daa6-0fCF-5d82-6Ad87d47fFdb\",\n \"organization_id\": \"b1c01ebA-e6b5-4F80-1636-9a776FBFd660\",\n \"team_id\": \"c41Dd3f7-83c1-bb5a-aeEC-F5dCdAE0EDB3\",\n \"collection_id\": \"E7CE9Af3-5a6e-ad58-272a-7e02c12CdF5c\",\n \"can_collect\": \"\",\n \"can_view\": \"none\",\n \"can_edit\": \"self\",\n \"assigned_by\": \"70d336cE-9CBB-e8bf-CdFC-D06624fC561f\",\n \"assigned_at\": \"\"\n },\n {\n \"id\": \"DcCFbe21-C8Ac-5D3C-10eC-D4Ba1BB2EE0C\",\n \"organization_id\": \"DEB40178-aD1a-6d1e-ebb8-6C546B23249A\",\n \"team_id\": \"22d6D44C-B356-dae8-03D4-6bed36BE6a61\",\n \"collection_id\": \"b180B2ea-a35C-E70c-Bab2-01E2aB75fe4c\",\n \"can_collect\": \"\",\n \"can_view\": \"self\",\n \"can_edit\": \"none\",\n \"assigned_by\": \"B9bD8181-4dFF-581D-c759-FcDEBCd3ecDB\",\n \"assigned_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02962875-ad61-44c7-b992-290ce64e400e", "name": "Assign a collection to a team", "request": { "name": "Assign a collection to a team", "description": { "content": "Grants every member of the team every form in the collection with the given rights. Idempotent — re-assigning returns the existing assignment. Optional `can_collect`, `can_view`, and `can_edit` override the defaults (true / self / none).", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"collection_id\": \"901bfA3b-DAf5-aaC4-c2fc-3B5dD5B0be40\",\n \"can_collect\": \"\",\n \"can_view\": \"none\",\n \"can_edit\": \"self\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "387dc98b-b3a7-4fc8-8382-e00a41dc219e", "name": "Assigned.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "collections" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"collection_id\": \"901bfA3b-DAf5-aaC4-c2fc-3B5dD5B0be40\",\n \"can_collect\": \"\",\n \"can_view\": \"none\",\n \"can_edit\": \"self\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"16D08ECe-3FaD-c2BA-6A98-9A6A6a227C99\",\n \"organization_id\": \"1C1Be196-e717-Bc03-Ee0f-D8df3D980FEa\",\n \"team_id\": \"ACEfdCD3-9EF1-FbdE-A951-2c85aF9BA4ED\",\n \"collection_id\": \"42AFC1E9-8f4B-fdEA-9EFC-6fA36D6B494e\",\n \"can_collect\": \"\",\n \"can_view\": \"self\",\n \"can_edit\": \"self\",\n \"assigned_by\": \"dBfDDecD-eEfB-e86A-80ca-8da65DebbAd7\",\n \"assigned_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{collection_id}", "description": "", "item": [ { "id": "83cca136-bb50-40c6-b50b-965cdc4cf94a", "name": "Update team collection assignment rights", "request": { "name": "Update team collection assignment rights", "description": { "content": "Sets can_collect, can_view, and can_edit for an existing collection assignment.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"can_collect\": \"\",\n \"can_view\": \"all\",\n \"can_edit\": \"self\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a4f5232f-0f9b-4a04-aed6-8ee5a4b58b2e", "name": "Updated assignment.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"can_collect\": \"\",\n \"can_view\": \"all\",\n \"can_edit\": \"self\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"16D08ECe-3FaD-c2BA-6A98-9A6A6a227C99\",\n \"organization_id\": \"1C1Be196-e717-Bc03-Ee0f-D8df3D980FEa\",\n \"team_id\": \"ACEfdCD3-9EF1-FbdE-A951-2c85aF9BA4ED\",\n \"collection_id\": \"42AFC1E9-8f4B-fdEA-9EFC-6fA36D6B494e\",\n \"can_collect\": \"\",\n \"can_view\": \"self\",\n \"can_edit\": \"self\",\n \"assigned_by\": \"dBfDDecD-eEfB-e86A-80ca-8da65DebbAd7\",\n \"assigned_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a862d530-b565-41ba-a062-998430b6b7cd", "name": "Unassign a collection from a team", "request": { "name": "Unassign a collection from a team", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "team_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "collection_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d249b79c-9448-44b1-9103-4ef7282f69dd", "name": "Unassigned.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "teams", ":team_id", "collections", ":collection_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "team_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "collection_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"organization_id\": \"\",\n \"team_id\": \"\",\n \"collection_id\": \"\",\n \"unassigned\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] }, { "name": "users", "description": "", "item": [ { "id": "d217be00-b3c3-47f5-893d-026bfd7580ad", "name": "List organization members", "request": { "name": "List organization members", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3d3c37ec-00ef-4a79-9c68-3ea45aa2023b", "name": "Members.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"user_id\": \"df8aB6F9-ADF1-f7e3-2a4B-27FcBf30bAf6\",\n \"organization_id\": \"68146558-fEea-aDbb-A21b-0bbA7ea4Eabd\",\n \"email\": \"\",\n \"full_name\": \"\",\n \"is_default\": \"\",\n \"is_active\": \"\",\n \"joined_at\": \"\",\n \"invited_at\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ]\n },\n {\n \"user_id\": \"cCD4bcfA-506B-738F-ceC4-f2CCf7d797A2\",\n \"organization_id\": \"Cd991f1D-97FE-1aC1-Eed5-3cbf5e8d2E35\",\n \"email\": \"\",\n \"full_name\": \"\",\n \"is_default\": \"\",\n \"is_active\": \"\",\n \"joined_at\": \"\",\n \"invited_at\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8cd1082c-c5f4-47b8-805c-653e25325815", "name": "Add an existing user to an organization", "request": { "name": "Add an existing user to an organization", "description": { "content": "Adds an existing user (auth.users row) to the org. Invitations by email are not exposed via the API v1 — that flow remains the dashboard.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"1eF5bD88-DA01-1EED-47FD-3dfC27347a03\",\n \"initial_role\": \"data_analyst\",\n \"set_as_default\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "929276d0-e086-496c-b453-1ba9927f46d3", "name": "Member added.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": \"1eF5bD88-DA01-1EED-47FD-3dfC27347a03\",\n \"initial_role\": \"data_analyst\",\n \"set_as_default\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"user_id\": \"6EF3bF1d-51E7-1c07-aFbF-e03ac1A86AB4\",\n \"organization_id\": \"ca97fB5d-692f-2F04-F8a6-a29B8f642942\",\n \"email\": \"\",\n \"full_name\": \"\",\n \"is_default\": \"\",\n \"is_active\": \"\",\n \"joined_at\": \"\",\n \"invited_at\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ]\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{user_id}", "description": "", "item": [ { "id": "ebca8234-4205-492b-9f19-3a2c1474c348", "name": "Get an organization member", "request": { "name": "Get an organization member", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5b2f14b2-3518-4bc8-8553-0e8ff27b435f", "name": "Member.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"user_id\": \"6EF3bF1d-51E7-1c07-aFbF-e03ac1A86AB4\",\n \"organization_id\": \"ca97fB5d-692f-2F04-F8a6-a29B8f642942\",\n \"email\": \"\",\n \"full_name\": \"\",\n \"is_default\": \"\",\n \"is_active\": \"\",\n \"joined_at\": \"\",\n \"invited_at\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ]\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5848cc9e-f3e4-4dd7-8786-ea1cbb43325d", "name": "Update member roles", "request": { "name": "Update member roles", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"roles_to_add\": [\n \"form_admin\",\n \"data_manager\"\n ],\n \"roles_to_revoke\": [\n \"org_admin\",\n \"user_admin\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c031a03b-2805-46f9-b9f8-2b04c6c45f89", "name": "Member after role changes.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"roles_to_add\": [\n \"form_admin\",\n \"data_manager\"\n ],\n \"roles_to_revoke\": [\n \"org_admin\",\n \"user_admin\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"user_id\": \"6EF3bF1d-51E7-1c07-aFbF-e03ac1A86AB4\",\n \"organization_id\": \"ca97fB5d-692f-2F04-F8a6-a29B8f642942\",\n \"email\": \"\",\n \"full_name\": \"\",\n \"is_default\": \"\",\n \"is_active\": \"\",\n \"joined_at\": \"\",\n \"invited_at\": \"\",\n \"roles\": [\n \"\",\n \"\"\n ]\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9291f95e-3c58-40c8-ab3d-5ec3f5c43466", "name": "Remove a member from an organization", "request": { "name": "Remove a member from an organization", "description": { "content": "Removes the organization_members row plus all associated roles and form assignments. Will not remove the last org_admin.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "211314d7-6ba3-4a69-8e32-be29c36a8729", "name": "Removal confirmation.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"user_id\": \"\",\n \"organization_id\": \"\",\n \"removed\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "assign-forms", "description": "", "item": [ { "id": "2ad20158-b9e5-483c-bc85-9cb4b180224b", "name": "Assign (or unassign) forms to a member", "request": { "name": "Assign (or unassign) forms to a member", "description": { "content": "Pass `unassign: true` to remove the listed assignments instead of adding them.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "users", ":user_id", "assign-forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"form_ids\": [\n \"7C364F8C-C4E8-114A-24cD-DdFa29af9fdE\"\n ],\n \"unassign\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1b7cc6f1-a8be-4c41-ac2e-37dbd2c01b59", "name": "Outcome.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "users", ":user_id", "assign-forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"form_ids\": [\n \"7C364F8C-C4E8-114A-24cD-DdFa29af9fdE\"\n ],\n \"unassign\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"assigned\": [\n \"\",\n \"\"\n ],\n \"unassigned\": [\n \"\",\n \"\"\n ]\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "webhooks", "description": "", "item": [ { "id": "7c9b5bd7-5baf-4fb0-b7ff-742460de8484", "name": "List webhook subscriptions", "request": { "name": "List webhook subscriptions", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2e78d4da-dac4-40a8-b375-17ea036385c3", "name": "Webhooks.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"a94eA12A-06d5-b2aD-ccBc-f9F2d60BD6af\",\n \"organization_id\": \"3c7332ff-fC29-0dFB-AcCF-E0FFA874ef13\",\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"form_ids\": [\n \"a274CEb8-fcE8-5E6e-c3cC-1D2e04Bf12DB\",\n \"Fd5F1D4D-14b4-dbF9-43Cb-3E8Db419A49B\"\n ],\n \"is_active\": \"\",\n \"max_retries\": \"\",\n \"retry_delay_seconds\": \"\",\n \"total_deliveries\": \"\",\n \"successful_deliveries\": \"\",\n \"failed_deliveries\": \"\",\n \"last_triggered_at\": \"\",\n \"subscription_type\": \"manual\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"8A3c021C-1cbB-D3F4-D92a-A1b58EFc30D0\",\n \"organization_id\": \"3Ec576cd-CadA-4495-1b6F-68FE83BE266F\",\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"form_ids\": [\n \"AFB85cEF-BeAd-ABc9-cE7A-B3623E7FfeDF\",\n \"bfdE07eE-5fDB-FfeE-ab8D-45d9ffE6c6Bd\"\n ],\n \"is_active\": \"\",\n \"max_retries\": \"\",\n \"retry_delay_seconds\": \"\",\n \"total_deliveries\": \"\",\n \"successful_deliveries\": \"\",\n \"failed_deliveries\": \"\",\n \"last_triggered_at\": \"\",\n \"subscription_type\": \"report\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd6bb9b9-db5a-465a-90ef-e429b24a9873", "name": "Create a webhook subscription", "request": { "name": "Create a webhook subscription", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"collection.form_added\"\n ],\n \"form_ids\": [\n \"f5E5bB6a-bCdB-d95c-A47c-41E2001ceF3D\",\n \"61BCd5fA-7bBf-e8D6-1bBd-EaDeAb39ae50\"\n ],\n \"secret\": \"\",\n \"max_retries\": \"\",\n \"retry_delay_seconds\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c1d36b6e-11e5-4acd-95b6-b7cc4ef9b61b", "name": "Created.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"collection.form_added\"\n ],\n \"form_ids\": [\n \"f5E5bB6a-bCdB-d95c-A47c-41E2001ceF3D\",\n \"61BCd5fA-7bBf-e8D6-1bBd-EaDeAb39ae50\"\n ],\n \"secret\": \"\",\n \"max_retries\": \"\",\n \"retry_delay_seconds\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"A5BC73D7-Ff71-eDfb-a05d-aecFEd7788BC\",\n \"organization_id\": \"0Ab6A606-cBDe-Dbd4-ffeB-198cA2C6dd1C\",\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"form_ids\": [\n \"7A7a06fC-19f8-eFBC-a1ca-aBf64a9fff07\",\n \"0fCcE10B-01Cf-F9A0-E5b6-BbADBb0ECaD7\"\n ],\n \"is_active\": \"\",\n \"max_retries\": \"\",\n \"retry_delay_seconds\": \"\",\n \"total_deliveries\": \"\",\n \"successful_deliveries\": \"\",\n \"failed_deliveries\": \"\",\n \"last_triggered_at\": \"\",\n \"subscription_type\": \"report\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{webhook_id}", "description": "", "item": [ { "id": "5fc9450b-4475-43c8-940a-d47c84d87018", "name": "Get a webhook subscription", "request": { "name": "Get a webhook subscription", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "webhook_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "15d4fafb-d78d-40ed-ac31-fdf6be3570a0", "name": "The subscription.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "webhook_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"A5BC73D7-Ff71-eDfb-a05d-aecFEd7788BC\",\n \"organization_id\": \"0Ab6A606-cBDe-Dbd4-ffeB-198cA2C6dd1C\",\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"form_ids\": [\n \"7A7a06fC-19f8-eFBC-a1ca-aBf64a9fff07\",\n \"0fCcE10B-01Cf-F9A0-E5b6-BbADBb0ECaD7\"\n ],\n \"is_active\": \"\",\n \"max_retries\": \"\",\n \"retry_delay_seconds\": \"\",\n \"total_deliveries\": \"\",\n \"successful_deliveries\": \"\",\n \"failed_deliveries\": \"\",\n \"last_triggered_at\": \"\",\n \"subscription_type\": \"report\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f1b6eafc-5b60-45e8-a3a4-eae62e6bf250", "name": "Update a webhook subscription", "request": { "name": "Update a webhook subscription", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "webhook_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"user.roles_updated\"\n ],\n \"form_ids\": [\n \"359fB685-85ad-2C3e-b174-b1B4e9eDf1be\",\n \"F5ca8dF1-3ABe-bEC0-0245-3AA5eeEfABe1\"\n ],\n \"secret\": \"\",\n \"max_retries\": \"\",\n \"retry_delay_seconds\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "241ae99b-14d4-400e-af61-00efb3eb4dbe", "name": "Updated.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "webhook_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"user.roles_updated\"\n ],\n \"form_ids\": [\n \"359fB685-85ad-2C3e-b174-b1B4e9eDf1be\",\n \"F5ca8dF1-3ABe-bEC0-0245-3AA5eeEfABe1\"\n ],\n \"secret\": \"\",\n \"max_retries\": \"\",\n \"retry_delay_seconds\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"A5BC73D7-Ff71-eDfb-a05d-aecFEd7788BC\",\n \"organization_id\": \"0Ab6A606-cBDe-Dbd4-ffeB-198cA2C6dd1C\",\n \"name\": \"\",\n \"url\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"form_ids\": [\n \"7A7a06fC-19f8-eFBC-a1ca-aBf64a9fff07\",\n \"0fCcE10B-01Cf-F9A0-E5b6-BbADBb0ECaD7\"\n ],\n \"is_active\": \"\",\n \"max_retries\": \"\",\n \"retry_delay_seconds\": \"\",\n \"total_deliveries\": \"\",\n \"successful_deliveries\": \"\",\n \"failed_deliveries\": \"\",\n \"last_triggered_at\": \"\",\n \"subscription_type\": \"report\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "297e5626-9e15-47af-b4b8-fd58fdc81372", "name": "Delete a webhook subscription", "request": { "name": "Delete a webhook subscription", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "webhook_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8a8ee820-ffb4-4e59-b792-cf947b3acc90", "name": "Deleted.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "webhook_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"deleted\": true\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "deliveries", "description": "", "item": [ { "id": "e7e00a9e-7c48-4b7b-81b8-0fdb0d455391", "name": "List webhook deliveries", "request": { "name": "List webhook deliveries", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks", ":webhook_id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "webhook_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "84a2b3c4-c86e-4c09-9c32-c1d3fb4ac429", "name": "Deliveries.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks", ":webhook_id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "status", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "webhook_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"09A7f3C8-4454-cddF-aa0A-6e0bE5784BA5\",\n \"organization_id\": \"4efe48FB-2FCB-5825-b7Dd-eEc92B458FD6\",\n \"event_type\": \"\",\n \"resource_type\": \"\",\n \"resource_id\": \"3C85FdF2-4d5A-ad8F-4B4E-bCd687C557A0\",\n \"payload\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"status\": \"\",\n \"retry_count\": \"\",\n \"next_retry_at\": \"\",\n \"webhook_subscription_id\": \"F76B753a-E9F6-A26C-52C2-ae8d2f4Eea2B\",\n \"delivered_at\": \"\",\n \"response_status\": \"\",\n \"response_body\": \"\",\n \"error_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"fD02aFCE-D0b4-b1E2-98EE-3F0803fAAbFa\",\n \"organization_id\": \"2FF43c0E-1f2C-3295-4006-ED4DEC8117AC\",\n \"event_type\": \"\",\n \"resource_type\": \"\",\n \"resource_id\": \"bA57D90F-aba3-F91c-1C79-512a58Eb8FeD\",\n \"payload\": {\n \"key_0\": 2953,\n \"key_1\": 7716.477754940165\n },\n \"status\": \"\",\n \"retry_count\": \"\",\n \"next_retry_at\": \"\",\n \"webhook_subscription_id\": \"be1eb0Cf-127B-bE8b-69f0-5d80E24D0cBd\",\n \"delivered_at\": \"\",\n \"response_status\": \"\",\n \"response_body\": \"\",\n \"error_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{delivery_id}", "description": "", "item": [ { "id": "8ecda73c-c74e-4380-9a9e-41b0183c87c9", "name": "Get a delivery", "request": { "name": "Get a delivery", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks", ":webhook_id", "deliveries", ":delivery_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "webhook_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "delivery_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7f98dd73-bf5e-453d-999a-78f4201bd247", "name": "Delivery.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks", ":webhook_id", "deliveries", ":delivery_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "webhook_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "delivery_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"D0E81AEf-93A9-deA5-1f2E-bcAE305F3C67\",\n \"organization_id\": \"b3bAeE4d-D1fF-7028-eC21-2D6CdaD9f678\",\n \"event_type\": \"\",\n \"resource_type\": \"\",\n \"resource_id\": \"a4d9f16B-6EAC-E0Cd-bAD2-D4715EfEAE17\",\n \"payload\": {\n \"key_0\": 5740\n },\n \"status\": \"\",\n \"retry_count\": \"\",\n \"next_retry_at\": \"\",\n \"webhook_subscription_id\": \"c998B76A-01ef-501a-dA1F-48ADfc748e6D\",\n \"delivered_at\": \"\",\n \"response_status\": \"\",\n \"response_body\": \"\",\n \"error_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "retry", "description": "", "item": [ { "id": "1a814f15-d630-40f9-ba00-449845250c5d", "name": "Re-queue a failed delivery", "request": { "name": "Re-queue a failed delivery", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks", ":webhook_id", "deliveries", ":delivery_id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "webhook_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "delivery_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7b8b35d8-2bb8-46aa-9b3b-50ba1e18a30f", "name": "Re-queued.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id", "webhooks", ":webhook_id", "deliveries", ":delivery_id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "webhook_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "delivery_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"D0E81AEf-93A9-deA5-1f2E-bcAE305F3C67\",\n \"organization_id\": \"b3bAeE4d-D1fF-7028-eC21-2D6CdaD9f678\",\n \"event_type\": \"\",\n \"resource_type\": \"\",\n \"resource_id\": \"a4d9f16B-6EAC-E0Cd-bAD2-D4715EfEAE17\",\n \"payload\": {\n \"key_0\": 5740\n },\n \"status\": \"\",\n \"retry_count\": \"\",\n \"next_retry_at\": \"\",\n \"webhook_subscription_id\": \"c998B76A-01ef-501a-dA1F-48ADfc748e6D\",\n \"delivered_at\": \"\",\n \"response_status\": \"\",\n \"response_body\": \"\",\n \"error_message\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] }, { "id": "11e89aa4-278b-42d2-a37e-73b51b3329d2", "name": "Get an organization", "request": { "name": "Get an organization", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b96756cb-2a0e-4a75-bc01-abfb9a24e649", "name": "The organization.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"83BfB682-DD73-1cd3-f17B-79b3a9c6D814\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_active\": \"\",\n \"settings\": null,\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40e93b43-f5ca-487d-b7ff-e5ced5cd9332", "name": "Update an organization", "request": { "name": "Update an organization", "description": {}, "url": { "path": [ "api", "v1", "organizations", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"y8sal-8n9cgpjj65m68fjqixofqox27y77pkk9dgvah4oe\",\n \"settings\": {\n \"key_0\": true,\n \"key_1\": 9344,\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "519fa923-089a-4460-9917-33a96640721c", "name": "Updated organization.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"y8sal-8n9cgpjj65m68fjqixofqox27y77pkk9dgvah4oe\",\n \"settings\": {\n \"key_0\": true,\n \"key_1\": 9344,\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"83BfB682-DD73-1cd3-f17B-79b3a9c6D814\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_active\": \"\",\n \"settings\": null,\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "831591d0-ec0c-47b5-b1d4-57ccb1307f0b", "name": "Soft-delete an organization", "request": { "name": "Soft-delete an organization", "description": { "content": "Sets is_active = false. Instance-scoped keys only. The row is retained (records, forms, audit trail) but the organization no longer appears in is_active=true filters.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "organization_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c16d55e2-84fe-432b-b4a1-649cedb95659", "name": "Deactivated organization.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations", ":organization_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "organization_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"83BfB682-DD73-1cd3-f17B-79b3a9c6D814\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_active\": \"\",\n \"settings\": null,\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "a2d57104-f508-4582-8d55-792f8c3eb3ec", "name": "List organizations", "request": { "name": "List organizations", "description": { "content": "Cursor-paginated list. Instance keys see all organizations; org keys see only the organization they are bound to.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of created_at,-created_at,name,-name)", "type": "text/plain" }, "key": "sort", "value": "name" }, { "disabled": false, "description": { "content": " (This can only be one of true,false)", "type": "text/plain" }, "key": "is_active", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b8aebf0e-5254-43ae-83bb-67d842b825bd", "name": "List of organizations.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of created_at,-created_at,name,-name)", "type": "text/plain" }, "key": "sort", "value": "name" }, { "disabled": false, "description": { "content": " (This can only be one of true,false)", "type": "text/plain" }, "key": "is_active", "value": "true" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"1eeFD3D8-d02e-db67-d8c4-B2C8d4FD6EE6\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_active\": \"\",\n \"settings\": null,\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"B7feD59a-4eaF-45B5-3fe7-E9A1d92EBCe4\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_active\": \"\",\n \"settings\": null,\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abd5ccfd-b644-4254-903e-c01f2a99ac91", "name": "Create an organization", "request": { "name": "Create an organization", "description": { "content": "Instance-scoped keys only. Slug auto-generated from the name when not supplied. Idempotency-Key header supported.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"qs8xwemsna9175eevqscwy3vjm8p\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fd3feeeb-c197-498b-9b10-96e2e198dea1", "name": "Organization created.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"qs8xwemsna9175eevqscwy3vjm8p\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"83BfB682-DD73-1cd3-f17B-79b3a9c6D814\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_active\": \"\",\n \"settings\": null,\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ced538aa-2dcb-41c2-8d0c-0dedcf115cac", "name": "Slug already exists.", "originalRequest": { "url": { "path": [ "api", "v1", "organizations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"qs8xwemsna9175eevqscwy3vjm8p\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"conflict\",\n \"message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "users", "description": "", "item": [ { "id": "a0fc94b0-a060-460d-9776-7e6ebd4c2a5f", "name": "List users (instance-wide)", "request": { "name": "List users (instance-wide)", "description": { "content": "Cursor-paginated. Instance-scoped keys only — org-scoped users are available under /api/v1/organizations/{org}/users.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of created_at,-created_at,email,-email)", "type": "text/plain" }, "key": "sort", "value": "email" }, { "disabled": false, "description": { "content": " (This can only be one of true,false)", "type": "text/plain" }, "key": "is_active", "value": "true" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "568d77a8-2b5b-4fd5-a1d6-5916b362b9a6", "name": "List of users.", "originalRequest": { "url": { "path": [ "api", "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "cursor", "value": "" }, { "disabled": false, "description": { "content": " (This can only be one of created_at,-created_at,email,-email)", "type": "text/plain" }, "key": "sort", "value": "email" }, { "disabled": false, "description": { "content": " (This can only be one of true,false)", "type": "text/plain" }, "key": "is_active", "value": "true" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "email", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"D90ca24D-FE8c-5830-Dfcd-A9a7BAeEfe47\",\n \"email\": \"\",\n \"full_name\": \"\",\n \"is_active\": \"\",\n \"is_owner\": \"\",\n \"last_seen_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"EbAF8b26-EB1A-c18e-9Ef8-BeE1E05edfb3\",\n \"email\": \"\",\n \"full_name\": \"\",\n \"is_active\": \"\",\n \"is_owner\": \"\",\n \"last_seen_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"meta\": {\n \"next_cursor\": \"\",\n \"limit\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{user_id}", "description": "", "item": [ { "id": "aeec46cf-f9d1-4be7-a6c0-c6bca44fe317", "name": "Get a user", "request": { "name": "Get a user", "description": {}, "url": { "path": [ "api", "v1", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "66249968-1232-4b0f-8fb2-120bf8cfb054", "name": "The user.", "originalRequest": { "url": { "path": [ "api", "v1", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"eD3ecada-7CAD-Da77-be3F-dF02c3EF5C7d\",\n \"email\": \"\",\n \"full_name\": \"\",\n \"is_active\": \"\",\n \"is_owner\": \"\",\n \"last_seen_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a74a75c2-9e2f-4b31-9914-306aec041378", "name": "Update user profile", "request": { "name": "Update user profile", "description": { "content": "Patches `full_name` and/or `is_active`. `is_owner` is intentionally not exposed via this endpoint — promoting an instance owner has its own dedicated dashboard flow.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"full_name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8357ced9-cdde-46ac-a8a8-47764e948c3d", "name": "Updated user.", "originalRequest": { "url": { "path": [ "api", "v1", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"full_name\": \"\",\n \"is_active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"eD3ecada-7CAD-Da77-be3F-dF02c3EF5C7d\",\n \"email\": \"\",\n \"full_name\": \"\",\n \"is_active\": \"\",\n \"is_owner\": \"\",\n \"last_seen_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd6c3488-4571-4581-83df-598074511443", "name": "Soft-delete a user", "request": { "name": "Soft-delete a user", "description": { "content": "Sets is_active=false. The user retains record-history and org-membership rows; re-activate by PATCHing is_active=true. Hard delete is not exposed via the API.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cad1d3a7-a299-4147-b09c-9c6beda2ea8b", "name": "Deactivated user.", "originalRequest": { "url": { "path": [ "api", "v1", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"eD3ecada-7CAD-Da77-be3F-dF02c3EF5C7d\",\n \"email\": \"\",\n \"full_name\": \"\",\n \"is_active\": \"\",\n \"is_owner\": \"\",\n \"last_seen_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://fieldscroll.app" } ], "info": { "_postman_id": "56fdb762-62b0-44df-81cd-aedc79259fb8", "name": "FieldScroll Customer API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Programmatic access to FieldScroll resources. Authenticate with an API key (Authorization: Bearer fs_live_...). All endpoints return a uniform envelope; errors use the ErrorEnvelope shape. Lists are cursor-paginated.", "type": "text/plain" } } }