{ "info": { "name": "API do Dashboard Mágico (v1.0.0)", "description": "Hey dev, have fun! ✨\n\n> **Documentation index** — fetch the full index at [https://docs.dashboards.kobana.com.br/llms.txt](https://docs.dashboards.kobana.com.br/llms.txt). Use this file to discover every available page before exploring further.\n\n> **Mind the API versions** — you are reading the **v1.0** documentation of the Magic Dashboard API, which covers the organization, its portal users and the dashboard team. Resources like **Payments, Transfers, Statements and Pix Receivables** live in other Kobana APIs — use the product picker in the top menu to switch.\n\n## Format\n\nThe API only accepts `JSON`. Every request must use `Content-Type: application/json`. All responses use `snake_case`.\n\n| Field type | Format |\n| :--- | :--- |\n| **DateTime** | [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format. Examples — Date: `2026-01-24`. Date and time: `2026-01-24T10:07Z` |\n| **UUID** | Resource identifiers as UUID v4 |\n\n## Conventions\n\nConventions used in this documentation:\n\n| Convention | Description |\n| :--- | :--- |\n| **`:variable`** | A variable name that must be replaced in the URL. |\n| **`#{variable}`** | A variable name that must be replaced with values from your account. |\n| **`...`** | Response content truncated for readability. |\n| **`$KOBANA_TOKEN`** | Access token. For command-line testing, export it: `export KOBANA_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxx` then paste the docs commands into your terminal. |\n\n## Return Codes\n\nThe API returns standard HTTP status codes:\n\n| | Code | Description |\n| :--- | :--- | :--- |\n| ✅ | **200 OK** | Successful request with a response body. |\n| ✅ | **201 Created** | Resource created successfully. |\n| ✅ | **204 No Content** | Successful request without a response body. |\n| ❌ | **400 Bad Request** | Invalid request, usually malformed content. |\n| ❌ | **401 Unauthorized** | Missing or invalid access token. |\n| ❌ | **403 Forbidden** | API access blocked or user not authorized. |\n| ❌ | **404 Not Found** | Resource not found. |\n| ❌ | **422 Unprocessable Entity** | Valid request, but the data is not. |\n| ❌ | **429 Too Many Requests** | Rate limit reached. |\n| ❌ | **500 Internal Server Error** | Internal processing error. Check [server status](https://status.kobana.com.br). |\n\n## Request ID\n\nEvery request has an associated identifier in the `Request-Id` response header. This value helps with debugging and auditing — requests and their IDs are available in the system dashboard. Request logs are retained for **30 days**. When opening a support ticket about a specific request, provide the `Request-Id` to speed up the investigation.\n\n## Security\n\nThe Kobana API uses **2048-bit SSL** certificates. Every request must use **HTTPS** — calls on port 80 are redirected to 443.\n\nClients must support `TLSv1.2` or `TLSv1.3` with one of the ciphers: `TLS_AES_128_GCM_SHA256`, `TLS_AES_256_GCM_SHA384`, `TLS_CHACHA20_POLY1305_SHA256`, `ECDHE-RSA-AES128-GCM-SHA256`, `ECDHE-RSA-AES128-SHA256`, `ECDHE-RSA-AES256-GCM-SHA384`, `ECDHE-RSA-CHACHA20-POLY1305`, `ECDHE-RSA-AES256-SHA384`. `TLSv1` and `TLSv1.1` are not supported.\n\n## HTTP Caching\n\nUse HTTP cache headers to reduce load and improve speed. Most responses include `ETag` and/or `Last-Modified` — store these values and send them back on follow-up requests via `If-None-Match` and `If-Modified-Since`. If the resource hasn't changed you'll get `304 Not Modified` — no body, no reprocessing. More info: [HTTP Cache Docs](http://www.mnot.net/cache_docs/).\n\n## Error Handling\n\n5xx errors mean a server failure: **500 Internal Server Error** (application unavailable), **502 Bad Gateway**, **503 Service Unavailable** and **504 Gateway Timeout** (point-in-time infrastructure failures). Your application must catch these and retry the request after a few minutes with backoff. Server status: [https://status.kobana.com.br](https://status.kobana.com.br).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.dashboards.kobana.com.br", "type": "string", "description": "https://api.dashboards.kobana.com.br — Production. Overridden at runtime when `API_V1_PUBLIC_URL` is set.\nhttps://api.dashboards.sandbox.kobana.com.br — Sandbox — isolated testing environment, separate from production." }, { "key": "bearerToken", "value": "", "type": "string", "description": "Access token da Conta Kobana (JWT RS256) usado no header Authorization: Bearer." } ], "item": [ { "name": "Organization", "item": [ { "name": "Get current organization", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/organization", "host": [ "{{baseUrl}}" ], "path": [ "v1", "organization" ] }, "description": "Returns the data of the organization the authenticated token belongs to. There is no `:id` parameter — the organization is always resolved from the API key." }, "response": [] }, { "name": "Update current organization", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/organization", "host": [ "{{baseUrl}}" ], "path": [ "v1", "organization" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"user@example.com\",\n \"phone\": \"\",\n \"addresses\": [\n {}\n ],\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the profile of the authenticated organization. Only the fields below can be modified — identity (`id`, `external_id`, `status`) is not changeable through this endpoint." }, "response": [] }, { "name": "Current token identity", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me" ] }, "description": "Returns who is behind the Bearer token: the person (`user`, `null` for a machine token), the organization, and the token's own scopes, access level and expiry. Use it to check that the credential configured in an integration is valid. It never returns the token, hashes or keys." }, "response": [] } ] }, { "name": "Portal Users", "item": [ { "name": "List portal users", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users?page=1&per_page=20&sort_by=&sort_order=asc&tenant_id=&status=active&email=&external_id=&sso_only=true&created_after=&created_before=&last_login_after=&last_login_before=&person_id=00000000-0000-0000-0000-000000000000&person_document_number=&person_name_contains=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "tenant_id", "value": "", "disabled": true }, { "key": "status", "value": "active", "disabled": true }, { "key": "email", "value": "", "disabled": true }, { "key": "external_id", "value": "", "disabled": true }, { "key": "sso_only", "value": "true", "disabled": true }, { "key": "created_after", "value": "", "disabled": true }, { "key": "created_before", "value": "", "disabled": true }, { "key": "last_login_after", "value": "", "disabled": true }, { "key": "last_login_before", "value": "", "disabled": true }, { "key": "person_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "person_document_number", "value": "", "disabled": true }, { "key": "person_name_contains", "value": "", "disabled": true } ] }, "description": "Returns the workspace's portal users, paginated. Sensitive fields (password, tokens) are never exposed." }, "response": [] }, { "name": "Create (invite) portal user", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users" ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"tenant_id\": \"\",\n \"external_id\": \"\",\n \"sso_only\": false,\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates the user in the workspace with status `pending_invitation` and sends the invitation email. The invitation expires in 7 days." }, "response": [] }, { "name": "Invite portal user (verb)", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users/invite", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users", "invite" ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"tenant_id\": \"\",\n \"external_id\": \"\",\n \"sso_only\": false,\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Equivalent to `POST /portal_users`. Available as a verb route for SDKs that prefer descriptive URLs." }, "response": [] }, { "name": "Get portal user", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "The `{id}` parameter accepts the user's UUID or `external_id`." }, "response": [] }, { "name": "Update portal user", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"tenant_id\": \"\",\n \"external_id\": \"\",\n \"sso_only\": false,\n \"status\": \"active\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates `email`, `tenant_id`, `external_id`, `sso_only`, `status` and `custom_metadata`. Allowed status transitions: `active` ↔ `suspended`." }, "response": [] }, { "name": "Remove portal user", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Pending invitations are permanently removed; other users are suspended." }, "response": [] }, { "name": "Preview portal user email", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users/:id/email-preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users", ":id", "email-preview" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Returns the subject and body of the invitation or verification email that would be sent to the user, without actually sending it. Available only for `pending_invitation` or `pending_verification` users." }, "response": [] }, { "name": "Resend invitation or verification email", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_users/:id/resend", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_users", ":id", "resend" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Resends the invitation email (for `pending_invitation`, rotating the token) or verification email (for `pending_verification`). Other statuses return 400." }, "response": [] }, { "name": "Get portal user mapping", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_user_mappings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_user_mappings" ] }, "description": "The entity that feeds the workspace portal users (`mapping`, `null` when none, with the last sync outcome) and the entities that can be mapped, with their fields." }, "response": [] }, { "name": "Map entity to portal users", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_user_mappings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_user_mappings" ] }, "body": { "mode": "raw", "raw": "{\n \"entity_type_id\": \"00000000-0000-0000-0000-000000000000\",\n \"tenant_id_field_key\": \"\",\n \"email_field_key\": \"\",\n \"name_field_key\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Maps an entity: one portal user per e-mail of its records, with the tenant ID taken from a field. Replaces the previous mapping and syncs right away (returns `stats`); later syncs of the entity keep the users current." }, "response": [] }, { "name": "Remove portal user mapping", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_user_mappings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_user_mappings" ] }, "description": "Stops syncing; users already created stay." }, "response": [] } ] }, { "name": "Account Administration", "item": [ { "name": "List dashboard users", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users?page=1&per_page=20&sort_by=&sort_order=asc&search=&status=all&role=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "status", "value": "all", "disabled": true }, { "key": "role", "value": "", "disabled": true } ] }, "description": "Returns a paginated list of dashboard users (team members) for the current organization." }, "response": [] }, { "name": "Invite dashboard user", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users" ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"name\": \"\",\n \"external_id\": \"\",\n \"role_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"permissions\": [\n \"\"\n ],\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Invites a new member to the organization team. `email` and at least one role in `role_ids` are required. The user receives an email invite and starts with `pending_invitation` status." }, "response": [] }, { "name": "Create or update a dashboard user", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users" ] }, "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"name\": \"\",\n \"external_id\": \"\",\n \"role_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"permissions\": [\n \"\"\n ],\n \"custom_metadata\": {},\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"public_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Looks the user up by `id`, `public_id`, `external_id` or `email` — the last one is unique per organization. If found, updates it; otherwise creates it and returns `201`." }, "response": [] }, { "name": "Get dashboard user", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Update dashboard user", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"picture\": \"\",\n \"status\": \"active\",\n \"permissions\": [\n \"\"\n ],\n \"role_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"external_id\": \"\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the user’s name, picture, status, permissions and/or roles. Only the fields sent are changed." }, "response": [] }, { "name": "Remove dashboard user", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Removes the dashboard user from the organization. Irreversible — the user must be invited again to regain access." }, "response": [] }, { "name": "List team roles", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles?page=1&per_page=20&sort_by=&sort_order=asc&search=&is_active=false&is_system=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "is_active", "value": "false", "disabled": true }, { "key": "is_system", "value": "false", "disabled": true } ] }, "description": "Returns the paginated list of roles configured for the organization team. Includes both system roles (`is_system = true`) and custom roles." }, "response": [] }, { "name": "Create custom role", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"portal_manager\",\n \"description\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"is_active\": false,\n \"external_id\": \"\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a custom role. `slug` must start with a lowercase letter and contain only lowercase letters, digits and `_`." }, "response": [] }, { "name": "Create or update a team role", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"portal_manager\",\n \"description\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"is_active\": false,\n \"external_id\": \"\",\n \"custom_metadata\": {},\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"public_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Looks the role up by `id`, `public_id` or `external_id`. The `slug` carries no unique constraint and therefore does **not** identify a row. If found, updates it; otherwise creates it and returns `201`." }, "response": [] }, { "name": "Get role", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] } }, "response": [] }, { "name": "Update role", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"permissions\": [\n \"\"\n ],\n \"is_active\": false,\n \"external_id\": \"\",\n \"custom_metadata\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the role fields. Only the fields sent are changed. System roles have additional restrictions." }, "response": [] }, { "name": "Remove role", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/team_roles/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "team_roles", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Soft-deletes the role. System roles (`is_system = true`) cannot be removed." }, "response": [] }, { "name": "Get member workspace access", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id/workspaces", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id", "workspaces" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Lists every workspace of the organization, flagging the ones the member reaches — also the list of what can be granted." }, "response": [] }, { "name": "Set member workspace access", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id/workspaces", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id", "workspaces" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"workspace_ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Replaces the member set of workspaces. Nobody changes their own access (400), only an owner changes an owner access, and only an owner grants or revokes a workspace they cannot open themselves (403). A machine token may grant any workspace but never changes an owner access. Removing the last owner of a workspace answers 403." }, "response": [] }, { "name": "Resend member invitation", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/dashboard_users/:id/resend", "host": [ "{{baseUrl}}" ], "path": [ "v1", "dashboard_users", ":id", "resend" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Re-sends the invitation e-mail, with a fresh sign-in link, to a member whose invitation is still pending. Capped at 5 e-mails per hour per recipient (429 above that)." }, "response": [] }, { "name": "List permissions", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/permissions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "permissions" ] }, "description": "Catalog of the dashboard permissions a member or a team role can carry, grouped by resource — the vocabulary of `permissions` on `/dashboard_users` and `/team_roles`." }, "response": [] } ] }, { "name": "Workspaces", "item": [ { "name": "List workspaces", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces?page=1&per_page=20&sort_by=&sort_order=asc&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Lists the workspaces of the organization you can open, with your role in each — the same ones as the dashboard switcher. A machine token sees every workspace of the organization. Does not require `X-Workspace-Id`." }, "response": [] }, { "name": "Create workspace", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates an empty workspace in the organization. The token person becomes its owner. Created by a machine token, the workspace has no owner: the organization owners receive it on their next sign-in, and `PUT /dashboard_users/{id}/workspaces` grants it to other members." }, "response": [] }, { "name": "Import workspace", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces/import", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces", "import" ] }, "body": { "mode": "raw", "raw": "{\n \"data\": {},\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Restores a file from `GET /workspaces/{id}/export` into a NEW workspace owned by the token person. Answers what could not be brought back (`warnings`) so it can be finished by hand. Requires a person token (a machine token gets 403) holding the permissions to create workspaces, configure the portal and create data sources. The entities in the file go through the same checks as when created one by one (keys, expressions, the field limit of the workspace). The body is limited to 2 MB." }, "response": [] }, { "name": "Get workspace", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Returns a workspace you can open. A workspace you hold no grant on answers 404." }, "response": [] }, { "name": "Rename workspace", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Renames the workspace. Only the workspace owners can (403 for a plain member)." }, "response": [] }, { "name": "Delete workspace", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Deletes the workspace (soft delete), for its owners only: the portal goes offline, connectors stop syncing and members lose access. The last workspace of the organization cannot be deleted." }, "response": [] }, { "name": "Get workspace usage", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces/:id/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces", ":id", "usage" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Counts what deleting the workspace would hide — the same summary as the dashboard delete dialog." }, "response": [] }, { "name": "Export workspace", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/workspaces/:id/export", "host": [ "{{baseUrl}}" ], "path": [ "v1", "workspaces", ":id", "export" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Downloads the workspace configuration (portal builder, portal access and settings, user mapping, connectors and entities) as a JSON file, for its owners only. Secrets and data stay out. The response is the file itself, with no `data` envelope; send it as `data` to `POST /workspaces/import`." }, "response": [] } ] }, { "name": "Data Sources", "item": [ { "name": "List data sources", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources?page=1&per_page=20&sort_by=&sort_order=asc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true } ] }, "description": "Data sources of the workspace — OpenAPI APIs, MCP servers and read-only databases — newest first. Secrets are never returned. To create a source, use the route of its kind: `/data_sources/openapi`, `/mcp`, `/database` or `/catalog`." }, "response": [] }, { "name": "List Kobana catalog products", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/catalog", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "catalog" ] }, "description": "Kobana products that can be connected as a data source with just a token. Whole list, unpaginated." }, "response": [] }, { "name": "Connect a Kobana product", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/catalog", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "catalog" ] }, "body": { "mode": "raw", "raw": "{\n \"product\": \"\",\n \"environment\": \"production\",\n \"token\": \"\",\n \"workspace_id\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Saves an OpenAPI source from the product spec shipped with the app and tests the connection." }, "response": [] }, { "name": "Create an OpenAPI data source", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/openapi", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "openapi" ] }, "body": { "mode": "raw", "raw": "{\n \"spec\": \"\",\n \"spec_file_name\": \"\",\n \"certificate\": {\n \"filename\": \"\",\n \"content_base64\": \"\"\n },\n \"name\": \"\",\n \"base_url\": \"\",\n \"auth\": {\n \"kind\": \"none\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"params\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"credentials\": {\n \"token\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"certificate_password\": \"\"\n },\n \"response_format\": \"json\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Saves an API described by an OpenAPI spec, imports its operations and tests the connection. The spec goes as text in `spec`; the mTLS certificate, base64-encoded in `certificate`." }, "response": [] }, { "name": "Analyze an OpenAPI spec", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/openapi/analyze", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "openapi", "analyze" ] }, "body": { "mode": "raw", "raw": "{\n \"spec\": \"\",\n \"spec_file_name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Reads the spec and returns what would be imported — title, servers, security schemes, suggested auth and operations — without saving anything." }, "response": [] }, { "name": "Create an MCP data source", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/mcp", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "mcp" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"url\": \"\",\n \"transport\": \"http\",\n \"headers\": \"\",\n \"oauth\": {\n \"mode\": \"none\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Saves an MCP server. Without OAuth it connects and discovers the tools right away; with OAuth it returns `authorization_url`, which a person signed in to the dashboard must open in a browser to finish." }, "response": [] }, { "name": "Create a database data source", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/database", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "database" ] }, "body": { "mode": "raw", "raw": "{\n \"engine\": \"postgres\",\n \"name\": \"\",\n \"host\": \"\",\n \"port\": 0,\n \"database\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"connection_string\": \"\",\n \"ssl\": false,\n \"ssl_verify\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Saves a read-only database (PostgreSQL, MySQL, MariaDB, SQL Server or MongoDB), connects and catalogs its tables or collections." }, "response": [] }, { "name": "Test a connection before saving", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", "test" ] }, "body": { "mode": "raw", "raw": "{\n \"kind\": \"openapi\",\n \"spec\": \"\",\n \"spec_file_name\": \"\",\n \"certificate\": {\n \"filename\": \"\",\n \"content_base64\": \"\"\n },\n \"name\": \"\",\n \"base_url\": \"\",\n \"auth\": {\n \"kind\": \"none\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"params\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"credentials\": {\n \"token\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"certificate_password\": \"\"\n },\n \"response_format\": \"json\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Tests a connection that is not saved yet. Send `kind` (`openapi`, `mcp`, `database` or `catalog`) and the body of the matching create route. Nothing is persisted." }, "response": [] }, { "name": "Get a data source", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "The data source and its operations (endpoints, tools or tables it can read)." }, "response": [] }, { "name": "Update a data source", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"is_active\": false,\n \"base_url\": \"\",\n \"auth\": {\n \"kind\": \"none\",\n \"headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"params\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"credentials\": {\n \"token\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"certificate_password\": \"\"\n },\n \"certificate\": {\n \"filename\": \"\",\n \"content_base64\": \"\"\n },\n \"probe_operation_key\": \"\",\n \"default_params\": {},\n \"response_format\": \"json\",\n \"url\": \"\",\n \"transport\": \"http\",\n \"headers\": \"\",\n \"oauth\": {\n \"mode\": \"none\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\"\n },\n \"engine\": \"postgres\",\n \"host\": \"\",\n \"port\": 0,\n \"database\": \"\",\n \"username\": \"\",\n \"password\": \"\",\n \"connection_string\": \"\",\n \"ssl\": false,\n \"ssl_verify\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the name, `is_active` and the connection fields of the kind of the source. Blank secret fields keep the stored ones. An OpenAPI source takes a new certificate in `certificate`." }, "response": [] }, { "name": "Delete a data source", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Removes the source, its operations and its sync schedule. Entities fed by it stop syncing. Cannot be undone." }, "response": [] }, { "name": "Test a data source", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "test" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Tests the saved source and records the outcome (status, last error). For an MCP server it also refreshes the tool list." }, "response": [] }, { "name": "Sync a data source", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "sync" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"full\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Queues a sync of every entity fed by the source. The run is asynchronous." }, "response": [] }, { "name": "Schedule the sync of a data source", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/schedule", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "schedule" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"cron\": \"\",\n \"timezone\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets how often the source syncs: `{ cron, timezone }`, or `{ cron: null }` for on demand only. Returns the next runs." }, "response": [] }, { "name": "Replace the spec of a data source", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/spec", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "spec" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"spec\": \"\",\n \"spec_file_name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Replaces the OpenAPI spec and re-syncs the operations: those that keep their key keep their settings; those gone from the spec are removed." }, "response": [] }, { "name": "Authorize an MCP data source", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/authorize", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "authorize" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Restarts the OAuth authorization of an MCP server. Returns `authorization_url` for a person signed in to the dashboard to open in a browser, or `null` plus the connection test when the stored tokens still work." }, "response": [] }, { "name": "List the request log of a data source", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/logs?page=1&per_page=20&sort_by=&sort_order=asc&method=&success=true&search=&date_from=2026-01-01&date_to=2026-01-01", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "logs" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "method", "value": "", "disabled": true }, { "key": "success", "value": "true", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "disabled": true }, { "key": "date_to", "value": "2026-01-01", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Calls the source made (HTTP requests, database queries), newest first, without headers nor bodies." }, "response": [] }, { "name": "Get a request of a data source", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/logs/:log_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "logs", ":log_id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "log_id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "One call, whole: request and response headers and bodies, with secrets masked." }, "response": [] }, { "name": "Enable or disable an operation of a data source", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_sources/:id/operations/:operation_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_sources", ":id", "operations", ":operation_id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "operation_id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Turns one operation of the source on or off (`enabled`). Disabled operations do not feed entities." }, "response": [] } ] }, { "name": "Entities", "item": [ { "name": "List entities", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities" ] }, "description": "Every entity of the workspace, with fields, source and sync state, ordered by name. Not paginated." }, "response": [] }, { "name": "Create entity", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities" ] }, "body": { "mode": "raw", "raw": "{\n \"integration_id\": \"00000000-0000-0000-0000-000000000000\",\n \"operation_id\": \"00000000-0000-0000-0000-000000000000\",\n \"sql\": \"\",\n \"params\": {},\n \"pagination\": {\n \"style\": \"none\",\n \"page_param\": \"\",\n \"offset_param\": \"\",\n \"cursor_param\": \"\",\n \"size_param\": \"\",\n \"limit_param\": \"\",\n \"next_cursor_path\": \"\",\n \"page_size\": 0\n },\n \"sync_filters\": [\n {\n \"target\": \"\",\n \"op\": \"eq\",\n \"value\": {}\n }\n ],\n \"key\": \"\",\n \"name\": \"\",\n \"name_plural\": \"\",\n \"description\": \"\",\n \"identifier_field_key\": \"\",\n \"label_field_key\": \"\",\n \"owner_field_key\": \"\",\n \"owner_match\": \"external_id\",\n \"sync_mode\": \"scheduled\",\n \"freshness_seconds\": 0,\n \"fields\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"data_type\": \"string\",\n \"semantic_role\": \"identifier\",\n \"source_path\": \"\",\n \"expression\": \"\",\n \"format\": \"\",\n \"enum_options\": [\n {}\n ],\n \"visible\": false,\n \"filterable\": false,\n \"sortable\": false\n }\n ],\n \"records_path\": \"\",\n \"sample\": [\n {}\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Registers an entity from a read operation (or SQL query) of the data source with the chosen fields, and queues its first full sync." }, "response": [] }, { "name": "Preview a source", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", "preview" ] }, "body": { "mode": "raw", "raw": "{\n \"integration_id\": \"00000000-0000-0000-0000-000000000000\",\n \"operation_id\": \"00000000-0000-0000-0000-000000000000\",\n \"sql\": \"\",\n \"params\": {},\n \"pagination\": {\n \"style\": \"none\",\n \"page_param\": \"\",\n \"offset_param\": \"\",\n \"cursor_param\": \"\",\n \"size_param\": \"\",\n \"limit_param\": \"\",\n \"next_cursor_path\": \"\",\n \"page_size\": 0\n },\n \"sync_filters\": [\n {\n \"target\": \"\",\n \"op\": \"eq\",\n \"value\": {}\n }\n ],\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Calls the chosen read operation (or runs the SQL query) and returns the sample with the entity inferred from it. Nothing is stored; the call is kept in the connector's request log." }, "response": [] }, { "name": "Create join entity", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/join", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", "join" ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"name\": \"\",\n \"name_plural\": \"\",\n \"description\": \"\",\n \"join\": {\n \"base_entity_id\": \"00000000-0000-0000-0000-000000000000\",\n \"related_entity_id\": \"00000000-0000-0000-0000-000000000000\",\n \"base_field\": \"\",\n \"related_field\": \"\",\n \"type\": \"inner\",\n \"match\": \"exact\"\n },\n \"fields\": [\n {\n \"from\": \"base\",\n \"field_key\": \"\",\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"label_field_key\": \"\",\n \"owner_field_key\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Registers an entity that relates two others (a join) with the fields picked from each, and queues its first sync." }, "response": [] }, { "name": "Preview a relation", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/join/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", "join", "preview" ] }, "body": { "mode": "raw", "raw": "{\n \"base_entity_id\": \"00000000-0000-0000-0000-000000000000\",\n \"related_entity_id\": \"00000000-0000-0000-0000-000000000000\",\n \"base_field\": \"\",\n \"related_field\": \"\",\n \"type\": \"inner\",\n \"match\": \"exact\"\n}", "options": { "raw": { "language": "json" } } }, "description": "How two entities match on the given fields (counts) and the first combined rows, before the relation is saved. Reads stored records only." }, "response": [] }, { "name": "Get entity", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "One entity with its fields, source, sync mode, owner field and sync state." }, "response": [] }, { "name": "Update entity", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"name\": \"\",\n \"name_plural\": \"\",\n \"description\": \"\",\n \"identifier_field_key\": \"\",\n \"label_field_key\": \"\",\n \"owner_field_key\": \"\",\n \"owner_match\": \"external_id\",\n \"sync_mode\": \"scheduled\",\n \"freshness_seconds\": 0,\n \"fields\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"data_type\": \"string\",\n \"semantic_role\": \"identifier\",\n \"source_path\": \"\",\n \"expression\": \"\",\n \"format\": \"\",\n \"enum_options\": [\n {}\n ],\n \"visible\": false,\n \"filterable\": false,\n \"sortable\": false\n }\n ],\n \"pagination\": {\n \"style\": \"none\",\n \"page_param\": \"\",\n \"offset_param\": \"\",\n \"cursor_param\": \"\",\n \"size_param\": \"\",\n \"limit_param\": \"\",\n \"next_cursor_path\": \"\",\n \"page_size\": 0\n },\n \"sync_filters\": [\n {\n \"target\": \"\",\n \"op\": \"eq\",\n \"value\": {}\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Name, key, special fields, the sync's pagination, filters and mode, and the field list (matched by key). When the mapping changes, the records are re-read." }, "response": [] }, { "name": "Delete entity", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Soft-deletes the entity and its fields. Refused (409) while a join entity reads it." }, "response": [] }, { "name": "Update relation", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/join", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "join" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"\",\n \"name\": \"\",\n \"name_plural\": \"\",\n \"description\": \"\",\n \"join\": {\n \"base_entity_id\": \"00000000-0000-0000-0000-000000000000\",\n \"related_entity_id\": \"00000000-0000-0000-0000-000000000000\",\n \"base_field\": \"\",\n \"related_field\": \"\",\n \"type\": \"inner\",\n \"match\": \"exact\"\n },\n \"fields\": [\n {\n \"from\": \"base\",\n \"field_key\": \"\",\n \"key\": \"\",\n \"name\": \"\"\n }\n ],\n \"label_field_key\": \"\",\n \"owner_field_key\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Replaces the relation of a join entity and the fields it brings, then re-reads its records. 422 when the entity is not a join." }, "response": [] }, { "name": "Query records", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/records?limit=50&offset=0&sort=due_date:desc,name&filter={\"status\":\"open\",\"amount\":{\"gte\":100}}&preview_as=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "records" ], "query": [ { "key": "limit", "value": "50", "disabled": true }, { "key": "offset", "value": "0", "disabled": true }, { "key": "sort", "value": "due_date:desc,name", "disabled": true }, { "key": "filter", "value": "{\"status\":\"open\",\"amount\":{\"gte\":100}}", "disabled": true }, { "key": "preview_as", "value": "00000000-0000-0000-0000-000000000000", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "The synced records of the entity, with field filters, sort and `limit`/`offset` paging (the same query the portal blocks run)." }, "response": [] }, { "name": "Clear records", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/records", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "records" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Removes every synced record of the entity and resets its sync state, so the next sync reads the source from scratch." }, "response": [] }, { "name": "Get record", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/records/:record_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "records", ":record_id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "record_id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "One synced record — values by field and the record as the source sent it — with its entity." }, "response": [] }, { "name": "Aggregate records", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/aggregate?op=count&field=&group_by=&filter={\"status\":\"open\",\"amount\":{\"gte\":100}}&preview_as=00000000-0000-0000-0000-000000000000", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "aggregate" ], "query": [ { "key": "op", "value": "count", "disabled": true }, { "key": "field", "value": "", "disabled": true }, { "key": "group_by", "value": "", "disabled": true }, { "key": "filter", "value": "{\"status\":\"open\",\"amount\":{\"gte\":100}}", "disabled": true }, { "key": "preview_as", "value": "00000000-0000-0000-0000-000000000000", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Count, sum, average, min or max over the synced records, optionally grouped by a field — what KPI and chart blocks show." }, "response": [] }, { "name": "Entity usage", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/usage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "usage" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "The portal pages (draft and published) whose blocks read the entity — what breaks if it is removed or its key changes." }, "response": [] }, { "name": "Sync log", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/logs?page=1&per_page=20&method=&success=true&search=&date_from=2026-01-01&date_to=2026-01-31", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "logs" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "method", "value": "", "disabled": true }, { "key": "success", "value": "true", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "date_from", "value": "2026-01-01", "disabled": true }, { "key": "date_to", "value": "2026-01-31", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "The calls the entity's sync made to its connector, newest first: the connector's request log narrowed to the entity." }, "response": [] }, { "name": "Get sync call", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/logs/:log_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "logs", ":log_id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "log_id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "One call of the entity's sync, whole (secrets masked)." }, "response": [] }, { "name": "Sync entity", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/sync?full=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "sync" ], "query": [ { "key": "full", "value": "true", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Queues a sync of the entity and answers 202 with its ID; follow it at `GET /entities/{id}/sync`. An `on_access` entity has no entity-wide sync (422): use `POST /entities/{id}/tenant_syncs`." }, "response": [] }, { "name": "Sync state", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/sync", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "sync" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Where the entity's sync stands: status, last error, last syncs, record count and stats." }, "response": [] }, { "name": "Tenant syncs", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/tenant_syncs?page=1&per_page=20&status=queued&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "tenant_syncs" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "status", "value": "queued", "disabled": true }, { "key": "search", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "On an `on_access` entity: where each tenant's sync stands, most recently accessed first." }, "response": [] }, { "name": "Sync one tenant", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/entities/:id/tenant_syncs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "entities", ":id", "tenant_syncs" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"tenant_id\": \"\",\n \"full\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Queues one tenant's sync of an `on_access` entity now. 404 when no portal user carries that tenant ID; 422 when the entity is not `on_access`." }, "response": [] } ] }, { "name": "Portal Builder", "item": [ { "name": "Get the portal builder", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder" ] }, "description": "Returns the workspace's portal as the builder sees it: portal identity, the draft (pages in menu order, each badged against the live version, `revision` and `dirty`), the live version number, the published versions, the theme and the SEO defaults. Read `revision` here before saving the draft." }, "response": [] }, { "name": "Save the portal draft", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/draft", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "draft" ] }, "body": { "mode": "raw", "raw": "{\n \"revision\": 0,\n \"pages\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"title\": \"\",\n \"seo\": {\n \"description\": \"\",\n \"keywords\": \"\",\n \"robots\": \"\",\n \"canonical\": \"\",\n \"og_title\": \"\",\n \"og_description\": \"\",\n \"og_image\": \"\",\n \"og_image_url\": \"\",\n \"og_image_meta\": \"\"\n },\n \"show_in_menu\": false,\n \"content\": {}\n }\n ],\n \"editor_state\": {},\n \"theme\": {\n \"light\": {},\n \"dark\": {},\n \"radius\": \"0.5rem\"\n },\n \"seo_defaults\": {\n \"description\": \"\",\n \"keywords\": \"\",\n \"robots\": \"\",\n \"og_title\": \"\",\n \"og_description\": \"\",\n \"og_image\": \"\",\n \"og_image_url\": \"\",\n \"og_image_meta\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Replaces the whole draft — pages in menu order, editor state and, optionally, theme and SEO defaults — guarded by the `revision` you last read. A stale `revision` answers 409 and changes nothing. Nothing goes live: to publish, use `POST /portal_builder/publish`." }, "response": [] }, { "name": "Publish the portal", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/publish", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "publish" ] }, "body": { "mode": "raw", "raw": "{\n \"revision\": 0,\n \"pages\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"path\": \"\",\n \"title\": \"\",\n \"seo\": {\n \"description\": \"\",\n \"keywords\": \"\",\n \"robots\": \"\",\n \"canonical\": \"\",\n \"og_title\": \"\",\n \"og_description\": \"\",\n \"og_image\": \"\",\n \"og_image_url\": \"\",\n \"og_image_meta\": \"\"\n },\n \"show_in_menu\": false,\n \"content\": {}\n }\n ],\n \"editor_state\": {},\n \"theme\": {\n \"light\": {},\n \"dark\": {},\n \"radius\": \"0.5rem\"\n },\n \"seo_defaults\": {\n \"description\": \"\",\n \"keywords\": \"\",\n \"robots\": \"\",\n \"og_title\": \"\",\n \"og_description\": \"\",\n \"og_image\": \"\",\n \"og_image_url\": \"\",\n \"og_image_meta\": \"\"\n },\n \"note\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Saves the draft as sent (same body as the draft save, plus an optional `note`) and freezes it into the next version, in one transaction: portal visitors see it right away. A form field whose regular expression could hang validation answers 422 `UNSAFE_FIELD_PATTERN`." }, "response": [] }, { "name": "Get a published version", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/versions/:number", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "versions", ":number" ], "variable": [ { "key": "number", "value": "3" } ] }, "description": "Returns a published version of the portal, by number, with the pages it froze." }, "response": [] }, { "name": "Roll back to a version", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/versions/:number/rollback", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "versions", ":number", "rollback" ], "variable": [ { "key": "number", "value": "3" } ] }, "description": "Puts that version back on the air as the next number — portal visitors see it right away. Returns the new version and the builder as it now stands." }, "response": [] }, { "name": "Seal a block secret", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/secrets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "secrets" ] }, "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"url\": \"https://hooks.example.com/in\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Encrypts a value a block keeps in the page JSON (a webhook header such as `Authorization`). Returns `secret:`, bound to this workspace and to the origin of `url` (required), which only the server opens to send the request to that origin. Nothing is stored: save the returned value in the block with the draft." }, "response": [] }, { "name": "Upload an og:image", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/og_image", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "og_image" ] }, "body": { "mode": "raw", "raw": "{\n \"filename\": \"cover.png\",\n \"content_type\": \"image/png\",\n \"content_base64\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Uploads a page's (or the SEO defaults') og:image — the picture link previews show — and returns its public URL, to store in `seo.og_image_url` (or `seo_defaults.og_image_url`) with the next draft save. PNG, JPEG or WebP, base64-encoded; up to 2 MB of image, but the whole request body is capped at 2 MB (about 1.5 MB of image once encoded)." }, "response": [] }, { "name": "Test a draft form", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/form_submissions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "form_submissions" ] }, "body": { "mode": "raw", "raw": "{\n \"form_id\": \"\",\n \"form_title\": \"\",\n \"page_path\": \"\",\n \"fields\": [\n {\n \"label\": \"\",\n \"name\": \"\",\n \"type\": \"text\",\n \"required\": false,\n \"pattern\": \"\"\n }\n ],\n \"action\": {\n \"type\": \"email\",\n \"email_to\": \"\",\n \"email_subject\": \"\",\n \"email_template\": \"\",\n \"webhook_endpoint_id\": \"\"\n },\n \"values\": {},\n \"submitter\": {\n \"name\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Runs a Form block's action the way the builder's preview does: the configured e-mail really goes out (or the chosen webhook really fires), marked `preview: true`. The form configuration comes in the body. The test e-mail goes only to the e-mail of the token's operator (a token without one cannot test the e-mail action). Capped at 20 runs a minute per operator, 60 a minute and 500 a day per organization, sharing the budget with the dashboard preview." }, "response": [] }, { "name": "Test a draft action button", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_builder/action_runs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_builder", "action_runs" ] }, "body": { "mode": "raw", "raw": "{\n \"block_id\": \"\",\n \"label\": \"\",\n \"page_path\": \"\",\n \"request\": {\n \"method\": \"POST\",\n \"url\": \"\",\n \"headers\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ],\n \"body\": \"\"\n },\n \"submitter\": {\n \"name\": \"\",\n \"email\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Runs an Action button's webhook the way the builder's preview does: the request really goes out, marked `preview: true`, and the answer carries the HTTP status the target replied with. Headers may carry `secret:` values sealed by `POST /portal_builder/secrets`, which open only for the origin they were sealed for. Capped at 20 runs a minute per operator, 60 a minute and 500 a day per organization." }, "response": [] } ] }, { "name": "Portal Settings", "item": [ { "name": "Get portal settings", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings" ] }, "description": "Returns the workspace portal's configuration: branding, page language, colors, address, login and SSO options, notifications and sender, and site settings (security headers, SEO, trackers, chat and custom code)." }, "response": [] }, { "name": "Update portal settings", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings" ] }, "body": { "mode": "raw", "raw": "{\n \"company_name\": \"\",\n \"title\": \"\",\n \"subtitle\": \"\",\n \"html_lang\": \"pt-BR\",\n \"light_colors\": {\n \"primary\": \"222 47% 11%\"\n },\n \"signup_slug\": \"\",\n \"enable_login\": false,\n \"enable_email_login\": false,\n \"allow_password_change\": false,\n \"sso_enabled\": false,\n \"sso_public_key\": \"\",\n \"sso_algorithm\": \"RS256\",\n \"sso_issuer\": \"\",\n \"notification_type_statuses\": {\n \"account_suspended\": \"ACTIVE\",\n \"account_activated\": \"ACTIVE\",\n \"portal_invitation\": \"ACTIVE\",\n \"welcome\": \"ACTIVE\"\n },\n \"notification_bcc_emails\": [\n {\n \"label\": \"\",\n \"address\": \"user@example.com\"\n }\n ],\n \"notification_sender_name\": \"\",\n \"notification_sender_email\": \"\",\n \"notification_reply_to_email\": \"\",\n \"hsts_include_subdomains\": false,\n \"hsts_preload\": false,\n \"secure_frame_headers\": false,\n \"seo_indexing_enabled\": false,\n \"seo_robots_txt\": \"\",\n \"seo_sitemap_enabled\": false,\n \"seo_google_site_verification\": \"\",\n \"seo_canonical_url\": \"\",\n \"tracking_integrations\": {},\n \"chat_integrations\": {},\n \"custom_code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the workspace portal's configuration. Partial: only the fields sent change. Returns the full configuration." }, "response": [] }, { "name": "Upload portal image", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings/logo", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings", "logo" ] }, "body": { "mode": "raw", "raw": "{\n \"filename\": \"logo.png\",\n \"content_type\": \"image/png\",\n \"content_base64\": \"\",\n \"variant\": \"logo\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Uploads the portal's logo, dark-background logo or favicon, as base64 in the JSON body. Replaces the previous image." }, "response": [] }, { "name": "Delete portal image", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings/logo?variant=logo", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings", "logo" ], "query": [ { "key": "variant", "value": "logo", "disabled": true } ] }, "description": "Removes the logo, dark-background logo or favicon; the portal falls back to its default." }, "response": [] }, { "name": "Set portal address", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings/domain", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings", "domain" ] }, "body": { "mode": "raw", "raw": "{\n \"slug\": \"acme\",\n \"domain\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Sets the portal's platform address, `https://{slug}.{domain}`, or removes it when both are `null`." }, "response": [] }, { "name": "Check address availability", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings/domain/check_slug?slug=acme&domain=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings", "domain", "check_slug" ], "query": [ { "key": "slug", "value": "acme", "disabled": false }, { "key": "domain", "value": "", "disabled": false } ] }, "description": "Tells whether `slug.domain` is free for this workspace's portal (its own current address counts as free)." }, "response": [] }, { "name": "Verify notification sender", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_settings/sender_identity", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_settings", "sender_identity" ] }, "description": "Requests or checks the sender verification on AWS SES. When the address was never submitted to SES or its verification failed, SES e-mails it a confirmation link; otherwise the current state is polled." }, "response": [] } ] }, { "name": "Portal Custom Domains", "item": [ { "name": "List custom domains", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_custom_domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_custom_domains" ] }, "description": "Lists the custom domains of the workspace's portal (the whole set, unpaginated). Empty where custom domains are not supported." }, "response": [] }, { "name": "Add custom domain", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_custom_domains", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_custom_domains" ] }, "body": { "mode": "raw", "raw": "{\n \"hostname\": \"portal.example.com\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Registers a custom domain as `pending_verification`, without touching AWS, and returns the DNS records to publish. Then call `POST /portal_custom_domains/{id}/verify`. Registering is only a claim: the domain goes to the first portal that publishes its verification TXT (the other unproven claims are released), and an unproven claim expires after 7 days. A portal holds at most 10 domains. Platform domains (`kobana.com.br`, `kobana.tech` and the shared portal domains) are refused. 403 where custom domains are not available." }, "response": [] }, { "name": "Delete custom domain", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_custom_domains/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_custom_domains", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Removes the custom domain and tears down its CloudFront tenant and certificate when provisioned. The portal stops answering on that hostname." }, "response": [] }, { "name": "Verify and provision custom domain", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_custom_domains/:id/verify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_custom_domains", ":id", "verify" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "While pending, checks the DNS and provisions the domain on AWS (certificate and CloudFront tenant); once provisioned, refreshes its status. Returns the domain with its new `status`." }, "response": [] }, { "name": "Check custom domain DNS", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_custom_domains/:id/dns_status", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_custom_domains", ":id", "dns_status" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Read-only lookup of the required CNAMEs, record by record, without changing anything on AWS." }, "response": [] } ] }, { "name": "Portal OIDC Providers", "item": [ { "name": "List OIDC providers", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_oauth_providers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_oauth_providers" ] }, "description": "Lists the OpenID Connect providers portal users can sign in with (the whole set, unpaginated)." }, "response": [] }, { "name": "Add OIDC provider", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_oauth_providers", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_oauth_providers" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"button_label\": \"\",\n \"issuer_url\": \"https://example.com\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\",\n \"email_claim\": \"\",\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Adds an OpenID Connect provider to the portal login." }, "response": [] }, { "name": "Update OIDC provider", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_oauth_providers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_oauth_providers", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"button_label\": \"\",\n \"issuer_url\": \"https://example.com\",\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"scopes\": \"\",\n \"email_claim\": \"\",\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates an OpenID Connect provider. Partial: only the fields sent change." }, "response": [] }, { "name": "Delete OIDC provider", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_oauth_providers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_oauth_providers", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Removes the provider; its button leaves the login page and nobody can sign in through it anymore." }, "response": [] }, { "name": "Test OIDC issuer", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/portal_oauth_providers/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "portal_oauth_providers", "test" ] }, "body": { "mode": "raw", "raw": "{\n \"issuer_url\": \"https://example.com\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Fetches the issuer's discovery document and reports its endpoints, to validate the URL before saving. A discovery failure is a 200 with `ok: false`." }, "response": [] } ] }, { "name": "Webhooks", "item": [ { "name": "List webhook endpoints", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks?page=1&per_page=20&sort_by=&sort_order=asc&status=active&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "active", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Lists the webhook endpoints of the workspace, newest first, each with its delivery count." }, "response": [] }, { "name": "Create a webhook endpoint", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhooks\",\n \"events\": [\n \"api_key.db.created\"\n ],\n \"description\": \"\",\n \"auth_type\": \"none\",\n \"auth_config\": {\n \"token\": \"token-123\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates an active endpoint in the workspace. The response carries the signing `secret` — it only appears here (and on rotation)." }, "response": [] }, { "name": "Get a webhook endpoint", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Returns one webhook endpoint of the workspace. Its deliveries are at `GET /webhooks/{id}/deliveries`." }, "response": [] }, { "name": "Update a webhook endpoint", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"active\": false,\n \"auth_type\": \"none\",\n \"auth_config\": {\n \"token\": \"token-123\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Changes the URL, description, subscribed events, `active` or the authentication. Absent fields are left as they are." }, "response": [] }, { "name": "Delete a webhook endpoint", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Deletes the endpoint for good, together with its delivery log. Events stop being sent immediately." }, "response": [] }, { "name": "Send a test webhook", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id", "test" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Sends a signed `test.webhook` event to the endpoint URL now and records it in the delivery log. Answers 200 with `success: false` when the endpoint answers non-2xx or cannot be reached, and 422 when the URL points to a blocked (private network) address." }, "response": [] }, { "name": "Rotate the webhook secret", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id/rotate_secret", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id", "rotate_secret" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Generates a new signing secret. The previous one stops working immediately; the new `secret` only appears in this response." }, "response": [] }, { "name": "List the deliveries of a webhook", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id/deliveries?page=1&per_page=20&sort_by=&sort_order=asc&status=pending", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id", "deliveries" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "pending", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Delivery log of one endpoint, newest first." }, "response": [] }, { "name": "Retry a webhook delivery", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/:id/deliveries/:delivery_id/retry", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", ":id", "deliveries", ":delivery_id", "retry" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" }, { "key": "delivery_id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Puts the delivery back to `pending` and queues it to be sent again. Sending is asynchronous: follow the outcome in the delivery log." }, "response": [] }, { "name": "List webhook deliveries", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_deliveries?page=1&per_page=20&sort_by=&sort_order=asc&status=pending&webhook_id=00000000-0000-0000-0000-000000000000&date_from=&date_to=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_deliveries" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "pending", "disabled": true }, { "key": "webhook_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "Deliveries of every endpoint of the workspace, newest first, with the event type and an endpoint summary." }, "response": [] }, { "name": "Get a webhook delivery", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/webhook_deliveries/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhook_deliveries", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Returns one delivery: the (redacted) request, the response, attempts and the target endpoint." }, "response": [] } ] }, { "name": "Events", "item": [ { "name": "List events", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/events?page=1&per_page=20&sort_by=&sort_order=asc&type=&resource_type=&resource_id=00000000-0000-0000-0000-000000000000&date_from=&date_to=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "events" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "type", "value": "", "disabled": true }, { "key": "resource_type", "value": "", "disabled": true }, { "key": "resource_id", "value": "00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "Event log of the workspace and of the organization, newest first. Events are evidence: they cannot be changed or deleted." }, "response": [] }, { "name": "Get an event", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/events/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "events", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Returns one event with its full payload." }, "response": [] } ] }, { "name": "Audit Logs", "item": [ { "name": "List audit logs", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/audit_logs?page=1&per_page=20&sort_by=&sort_order=asc&user_id=&action=&resource_type=&resource_id=&search=&date_from=&date_to=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "audit_logs" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "user_id", "value": "", "disabled": true }, { "key": "action", "value": "", "disabled": true }, { "key": "resource_type", "value": "", "disabled": true }, { "key": "resource_id", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true }, { "key": "date_from", "value": "", "disabled": true }, { "key": "date_to", "value": "", "disabled": true } ] }, "description": "Audit trail of the workspace and of the organization, newest first. The trail cannot be changed." }, "response": [] }, { "name": "Audit activity summary", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/audit_logs/summary?hours=24", "host": [ "{{baseUrl}}" ], "path": [ "v1", "audit_logs", "summary" ], "query": [ { "key": "hours", "value": "24", "disabled": true } ] }, "description": "Activity of the last `hours` hours: total entries, the 10 most frequent actions and the 20 most recent entries. Requires the audit export permission." }, "response": [] }, { "name": "Get an audit log", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/audit_logs/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "audit_logs", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Returns one audit entry with its previous and new values." }, "response": [] } ] }, { "name": "Email Templates", "item": [ { "name": "List email templates", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates?type=api_key_expiring&is_active=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates" ], "query": [ { "key": "type", "value": "api_key_expiring", "disabled": true }, { "key": "is_active", "value": "true", "disabled": true } ] }, "description": "Lists the organization's own email templates, ordered by type and name. Returns the whole set, unpaginated." }, "response": [] }, { "name": "Create email template", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"api_key_expiring\",\n \"subject\": \"\",\n \"html_body\": \"\",\n \"text_body\": \"\",\n \"bcc\": [\n \"\"\n ],\n \"variables\": [\n \"\"\n ],\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a template for a notification type. It is a draft unless `is_active` is `true` — then the previous active template of the type becomes a draft." }, "response": [] }, { "name": "Reset templates to defaults", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/init_defaults", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", "init_defaults" ] }, "description": "Creates or resets the template of every notification type to the shipped default and activates it. Overwrites the content of the organization's existing templates." }, "response": [] }, { "name": "Get email template", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Returns a template of the organization or a platform default." }, "response": [] }, { "name": "Update email template", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"subject\": \"\",\n \"html_body\": \"\",\n \"text_body\": \"\",\n \"bcc\": [\n \"\"\n ],\n \"variables\": [\n \"\"\n ],\n \"is_active\": false,\n \"public_id\": \"00000000-0000-0000-0000-000000000000\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a template of the organization. Only the fields sent change. Platform defaults cannot be changed (404)." }, "response": [] }, { "name": "Delete email template", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Permanently deletes an inactive template of the organization. The active template of a type cannot be deleted (422): activate another one first." }, "response": [] }, { "name": "Duplicate email template", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/:id/duplicate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", ":id", "duplicate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"new_name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Copies a template as an inactive draft." }, "response": [] }, { "name": "Preview email template", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/:id/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", ":id", "preview" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Renders the template with sample data, inside the organization's layout. Nothing is sent." }, "response": [] }, { "name": "Render template with variables", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_templates/:id/preview", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_templates", ":id", "preview" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"variables\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Renders the template with the `variables` sent, without a layout. Nothing is sent." }, "response": [] } ] }, { "name": "Email Layouts", "item": [ { "name": "List email layouts", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_layouts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_layouts" ] }, "description": "Lists the organization's email layouts, default first. Returns the whole set, unpaginated." }, "response": [] }, { "name": "Create email layout", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_layouts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_layouts" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"html_body\": \"\",\n \"is_default\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a layout. The HTML must contain the `{{content}}` placeholder." }, "response": [] }, { "name": "Create default layout", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_layouts/init_defaults", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_layouts", "init_defaults" ] }, "description": "Makes sure the organization has a default layout: returns the current one or creates the built-in one. Never overwrites a layout." }, "response": [] }, { "name": "Get email layout", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_layouts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_layouts", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Returns a layout of the organization." }, "response": [] }, { "name": "Update email layout", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_layouts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_layouts", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"html_body\": \"\",\n \"is_default\": false,\n \"is_active\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates the name, HTML (which must keep `{{content}}`), default or active flag. Only the fields sent change." }, "response": [] }, { "name": "Delete email layout", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/email_layouts/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "email_layouts", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Permanently deletes a layout. Emails fall back to the default layout (or the built-in one)." }, "response": [] } ] }, { "name": "Notifications", "item": [ { "name": "List notifications", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/notifications?page=1&per_page=20&sort_by=&sort_order=asc&type=api_key_expiring&channel=email&status=pending&created_after=&created_before=&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "type", "value": "api_key_expiring", "disabled": true }, { "key": "channel", "value": "email", "disabled": true }, { "key": "status", "value": "pending", "disabled": true }, { "key": "created_after", "value": "", "disabled": true }, { "key": "created_before", "value": "", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "Lists the notifications of the workspace and the organization-wide ones, newest first." }, "response": [] }, { "name": "Create notification", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/notifications", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications" ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"api_key_expiring\",\n \"recipient\": \"\",\n \"channel\": \"email\",\n \"portal_user_id\": \"00000000-0000-0000-0000-000000000000\",\n \"resource_type\": \"\",\n \"resource_id\": \"00000000-0000-0000-0000-000000000000\",\n \"scheduled_for\": \"2026-01-01T00:00:00Z\",\n \"variables\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Renders the active template of the type with the variables, stores the notification and sends it right away — the response carries the outcome (`sent`, or `failed` with `failure_reason`). With a future `scheduled_for` it stays `pending` until it is due. Every creation counts toward the per-recipient manual-send limit (429)." }, "response": [] }, { "name": "Notification statistics", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/notifications/stats?days=30", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", "stats" ], "query": [ { "key": "days", "value": "30", "disabled": true } ] }, "description": "Counts by status, type and channel of the notifications created in the last `days` days, with the delivery and read rates." }, "response": [] }, { "name": "Send notification", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/notifications/:id/send", "host": [ "{{baseUrl}}" ], "path": [ "v1", "notifications", ":id", "send" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Sends a stored notification now: the first send of a `pending` (scheduled) or `skipped` one, or a resend of a `sent`, `delivered`, `read` or `failed` one. Every call sends the email again and counts toward the per-recipient manual-send limit (429)." }, "response": [] } ] }, { "name": "API Keys", "item": [ { "name": "List API keys", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys?page=1&per_page=20&sort_by=&sort_order=asc&status=active", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "status", "value": "active", "disabled": true } ] }, "description": "Lists the organization API keys (`kb_…`), without the secret. These keys no longer authenticate the API v1 nor the MCP — both take access tokens issued by the Kobana authorization server; the records remain the organization key inventory (lifecycle, expiry reminders and `api_key.*` webhooks). Organization-level: ignores `X-Workspace-Id`." }, "response": [] }, { "name": "Create API key", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"source\": \"api\",\n \"notification_emails\": [\n \"\"\n ],\n \"expires_at\": \"2026-01-01T00:00:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates an active key, valid for one year unless `expires_at` says otherwise. The secret (`key`) is returned ONCE in this response — only its hash is stored. Requires a person who reaches every workspace (organization owner or granted on each one), as in the dashboard." }, "response": [] }, { "name": "Get API key", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Returns one organization key — metadata and lifecycle stamps, never the secret." }, "response": [] }, { "name": "Update API key", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"source\": \"api\",\n \"notification_emails\": [\n \"\"\n ],\n \"expires_at\": \"2026-01-01T00:00:00Z\",\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Edits name, description, source, notification e-mails and expiry, and/or enables ⇄ disables the key with `enabled`. A revoked key is terminal (409)." }, "response": [] }, { "name": "Remove revoked API key", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Removes an ALREADY REVOKED key from the list (soft delete; history is kept). An active or disabled key must be revoked first (409)." }, "response": [] }, { "name": "Revoke API key", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys/:id/revoke", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys", ":id", "revoke" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Permanently revokes the key — it cannot be re-enabled. 409 when it is already revoked." }, "response": [] }, { "name": "Rotate API key", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/api_keys/:id/rotate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "api_keys", ":id", "rotate" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"grace_days\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "Issues a successor key (same name and settings) and keeps the previous one working for `grace_days` days (default 7, max 30). Only an active key rotates (409). The new secret is returned ONCE." }, "response": [] } ] }, { "name": "Exports", "item": [ { "name": "List exports", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/exports?page=1&per_page=20&sort_by=&sort_order=asc&resource_type=&status=pending", "host": [ "{{baseUrl}}" ], "path": [ "v1", "exports" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "resource_type", "value": "", "disabled": true }, { "key": "status", "value": "pending", "disabled": true } ] }, "description": "Lists the export requests of the workspace." }, "response": [] }, { "name": "Request export", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/exports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "exports" ] }, "body": { "mode": "raw", "raw": "{\n \"resource_type\": \"portal_users\",\n \"format\": \"csv\",\n \"filters\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Queues an export of the workspace portal users as CSV, XLSX or JSON. Asynchronous: answers 202 with the `pending` export; poll `GET /exports/{id}` until `completed` and download from `/download`. The file expires after 7 days." }, "response": [] }, { "name": "Get export", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/exports/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "exports", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Status and metadata of one export request." }, "response": [] }, { "name": "Download export file", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/exports/:id/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "exports", ":id", "download" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Returns the file of a completed export (the dashboard redirects to a signed URL; the API serves the bytes). 404 while it is not ready." }, "response": [] } ] }, { "name": "Imports", "item": [ { "name": "List imports", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/imports?page=1&per_page=20&sort_by=&sort_order=asc&resource_type=&status=pending", "host": [ "{{baseUrl}}" ], "path": [ "v1", "imports" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "resource_type", "value": "", "disabled": true }, { "key": "status", "value": "pending", "disabled": true } ] }, "description": "Lists the import requests of the workspace, with success and error counters." }, "response": [] }, { "name": "Import CSV", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/imports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "imports" ] }, "body": { "mode": "raw", "raw": "{\n \"resource_type\": \"portal_users\",\n \"file_name\": \"\",\n \"content_type\": \"\",\n \"content_base64\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Sends a base64 CSV and queues the import of portal users into the workspace. The dashboard uploads the file first; the API takes it in the body (2 MB request limit). Follows the organization setting \"allow creating portal users\" (403 when off). Asynchronous: 202; poll `GET /imports/{id}`." }, "response": [] }, { "name": "Get import", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/imports/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "imports", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Status, counters and per-row errors of an import. An import still `pending` 2 minutes after the request is shown as `failed` (stalled queue); the read does not change the record." }, "response": [] } ] }, { "name": "Backups", "item": [ { "name": "List backups", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups?page=1&per_page=20&sort_by=&sort_order=asc&type=backup&status=pending", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "type", "value": "backup", "disabled": true }, { "key": "status", "value": "pending", "disabled": true } ] }, "description": "Lists the organization backups and restores (metadata only) and whether a new backup may be requested now (`backup_allowed`, `next_backup_at` — one every 12 hours in production). Organization-level." }, "response": [] }, { "name": "Request backup", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups" ] }, "description": "Queues a full backup (ZIP) of the organization, every workspace included. Asynchronous: 202; poll `GET /backups/{id}`." }, "response": [] }, { "name": "Restore backup", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups/restore", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups", "restore" ] }, "body": { "mode": "raw", "raw": "{\n \"backup_id\": \"00000000-0000-0000-0000-000000000000\",\n \"file_name\": \"\",\n \"content_base64\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "DESTRUCTIVE: restores a backup into the workspace of the call (`X-Workspace-Id`), rewriting portal users matched by e-mail/public id. Send `backup_id` (a completed backup of this organization — its file is copied) OR `file_name` (`.zip`) + `content_base64` (bounded by the 2 MB request limit). Requires `settings.update` and access to every workspace. Asynchronous: 202; follow it on `GET /backups/{id}` and cancel with `/cancel`." }, "response": [] }, { "name": "Get backup", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Status and progress of a backup or restore. An in-progress restore whose queue job is gone is marked `failed`." }, "response": [] }, { "name": "Delete backup", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Deletes the record and its file from storage. Permanent." }, "response": [] }, { "name": "Cancel restore", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups", ":id", "cancel" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Stops a pending or running restore. What was already restored stays. 422 for a backup or a restore that already ended." }, "response": [] }, { "name": "Download backup", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/backups/:id/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "backups", ":id", "download" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Returns the backup ZIP. Requires `backups.export` and, for a person token, being an organization owner or holding access to every workspace — the backup holds all of them. Audited." }, "response": [] } ] }, { "name": "Data Purge", "item": [ { "name": "Count purgeable data", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_purges", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_purges" ] }, "description": "How many rows each purgeable resource (`portal_users`, `people`, `usage_history`) holds across every workspace. Requires `data.purge` (organization owners only by default) and access to every workspace." }, "response": [] }, { "name": "Purge organization data", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_purges", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_purges" ] }, "body": { "mode": "raw", "raw": "{\n \"resources\": [\n \"portal_users\"\n ],\n \"confirm\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "IRREVERSIBLE: permanently deletes the chosen resources in EVERY workspace of the organization. In the dashboard the operation is confirmed with a code sent by e-mail. That is why a token that names a person (a personal or OAuth token, or a call through the MCP) gets 403: the person purges from the dashboard. Only machine tokens can purge over the API, and only when the token carries the dedicated `dashboards/data_purges:write` scope — granted explicitly: no other scope implies it (not `write`, `all`, `dashboards/all` or `dashboards/admin:write`); without it, 403 `insufficient_scope`. Their confirmation is `confirm`, which must repeat the organization id (from `GET /organization`) — a retried or mis-targeted call cannot pass by accident. Requires `data.purge` (organization owners only by default) and access to every workspace. Asynchronous: 202 with `job_id`." }, "response": [] }, { "name": "Get purge job", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/data_purges/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "data_purges", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "description": "Progress and result of a purge job. A job of another organization: 404." }, "response": [] } ] }, { "name": "Maintenance", "item": [ { "name": "Upper-case contact names", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/maintenance/uppercase_names", "host": [ "{{baseUrl}}" ], "path": [ "v1", "maintenance", "uppercase_names" ] }, "description": "Upper-cases the name of every contact linked to a portal user of the workspace. Not reversible (the previous spelling is not kept)." }, "response": [] } ] }, { "name": "Settings", "item": [ { "name": "Get organization settings", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "settings" ] }, "description": "Name, support e-mail, timezone and the records options of the organization. Organization-level." }, "response": [] }, { "name": "Update organization settings", "request": { "method": "PUT", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "settings" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"support_email\": \"user@example.com\",\n \"timezone\": \"\",\n \"crm_uppercase_names\": false,\n \"crm_allow_edit_public_id\": false,\n \"crm_allow_edit_document\": false,\n \"crm_allow_create_customers\": false,\n \"crm_allow_create_portal_users\": false,\n \"crm_allow_edit_portal_user_email\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "Partially changes the settings: send only what changes. Unknown fields are refused (400)." }, "response": [] } ] }, { "name": "Usage", "item": [ { "name": "Get platform usage", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/usage?start_date=2026-01-15&end_date=2026-01-15", "host": [ "{{baseUrl}}" ], "path": [ "v1", "usage" ], "query": [ { "key": "start_date", "value": "2026-01-15", "disabled": true }, { "key": "end_date", "value": "2026-01-15", "disabled": true } ] }, "description": "For each metric (members, customers, portal users, integrations…), the daily series in the range, the latest value and the peak. Default: current month; at most 12 months back. Organization-level." }, "response": [] } ] }, { "name": "AI Usage", "item": [ { "name": "Get AI usage", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/ai_usage?start_date=2026-01-15&end_date=2026-01-15&days=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", "ai_usage" ], "query": [ { "key": "start_date", "value": "2026-01-15", "disabled": true }, { "key": "end_date", "value": "2026-01-15", "disabled": true }, { "key": "days", "value": "0", "disabled": true } ] }, "description": "AI consumption, price only (cost and margin never leave): totals, daily breakdown and latest turns of the workspace of the call, plus the month to date, grants, limits, credit balance and whether the next turn is allowed — those for the whole organization, as the limit and the credit are shared. Default period: current month (America/Sao_Paulo), at most 366 days." }, "response": [] } ] }, { "name": "Rate Limits", "item": [ { "name": "Get rate limits", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/rate_limits", "host": [ "{{baseUrl}}" ], "path": [ "v1", "rate_limits" ] }, "description": "The rate limits in force for the organization, whether they are custom (set by the Kobana team) and the platform defaults. Read-only." }, "response": [] } ] }, { "name": "Assets", "item": [ { "name": "List assets", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets?page=1&per_page=20&sort_by=&sort_order=asc&kind=image&visibility=public&search=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets" ], "query": [ { "key": "page", "value": "1", "disabled": true }, { "key": "per_page", "value": "20", "disabled": true }, { "key": "sort_by", "value": "", "disabled": true }, { "key": "sort_order", "value": "asc", "disabled": true }, { "key": "kind", "value": "image", "disabled": true }, { "key": "visibility", "value": "public", "disabled": true }, { "key": "search", "value": "", "disabled": true } ] }, "description": "The file library of the workspace — images and documents the portal shows or offers for download. Sortable by `created_at` (default), `name` or `size_bytes`." }, "response": [] }, { "name": "Create asset", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"key\": \"\",\n \"content_base64\": \"\",\n \"content_type\": \"\",\n \"alt_text\": \"\",\n \"visibility\": \"public\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Records a file in the library, one of two ways: the `key` of a file already sent through the URL of `POST /assets/presign`, or the content itself in `content_base64`. The file starts `restricted` unless `visibility` says otherwise. Fires the `asset.created` webhook." }, "response": [] }, { "name": "Get an upload URL", "request": { "method": "POST", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets/presign", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", "presign" ] }, "body": { "mode": "raw", "raw": "{\n \"filename\": \"\",\n \"content_type\": \"\",\n \"size\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "A short-lived signed URL to send the file straight to storage with `PUT` — the way for files over the 2 MB body limit. After the `PUT`, record the file at `POST /assets` with the returned `key`." }, "response": [] }, { "name": "Get asset", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "One file of the library, with its link, visibility, type and size." }, "response": [] }, { "name": "Update asset", "request": { "method": "PATCH", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"alt_text\": \"\",\n \"visibility\": \"public\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Renames the file, changes its alternative text or its visibility. Making it public opens its storage URL to anyone; `restricted` or `private` closes it." }, "response": [] }, { "name": "Delete asset", "request": { "method": "DELETE", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", ":id" ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "Removes the file from the library. The stored file stays in storage, so links already published do not break. Fires the `asset.deleted` webhook." }, "response": [] }, { "name": "Download asset", "request": { "method": "GET", "header": [ { "key": "User-Agent", "value": "Kevin Mitnick ", "type": "text" }, { "key": "X-Idempotency-Key", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source", "value": "api", "type": "text" }, { "key": "X-Workspace-Id", "value": "00000000-0000-0000-0000-000000000000", "type": "text" }, { "key": "X-Request-Source-Other", "value": "Zapier", "type": "text" } ], "url": { "raw": "{{baseUrl}}/v1/assets/:id/download?inline=true", "host": [ "{{baseUrl}}" ], "path": [ "v1", "assets", ":id", "download" ], "query": [ { "key": "inline", "value": "true", "disabled": true } ], "variable": [ { "key": "id", "value": "00000000-0000-0000-0000-000000000000" } ] }, "description": "The file content, whatever its visibility, with its own `Content-Type`." }, "response": [] } ] } ] }