This page is generated from @zupflow/contract (API version 0.1.0), the same source the server, the SDK and the Console are checked against. Download the full OpenAPI document.
Send a bearer token on every request. An API key (zf_test_… in Sandbox, zf_live_… in Production) acts in its organization and environment, and sees nothing of the other environment. Keep keys on your backend, never in a browser.
A Console session also sends Zupflow-Organization to say which organization it acts in.
curl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
Every response is an envelope: data on success, error on failure, and meta for paging. Branch on error.code, never on error.message. A validation error names the fields that failed in error.fields.
IDs are prefixed and opaque (ws_…, run_…). A malformed ID, an ID of another type, or one in another organization answers 404, exactly like a missing one.
{
"data": null,
"meta": null,
"error": {
"code": "validation_failed",
"message": "The request body is invalid.",
"fields": { "slug": "Use lowercase letters, digits and dashes." }
}
}Lists are paged on the server. Pass limit (1 to 100, default 25) and, for the next page, the cursor from meta.pagination.next_cursor. When next_cursor is null, you have every item. The SDK's list methods page for you.
curl "https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/workspaces?limit=25&cursor=eyJpZCI6IjAzNEgifQ" \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
Every POST accepts an Idempotency-Key. Sending the same key and request again replays the first response, so a retry after a timeout never creates two runs. The same key with a different request answers 422; one still in flight answers 409. Keys are kept for 24 hours. The SDK sets one for you.
Secrets (API keys, webhook signing secrets) appear once, in the response that creates them. A replay of that request answers 409 rather than showing the secret again.
curl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents/agt_034HXHH2LZFzvoaSAhfGVC/runs \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: 6f1c0f2e-run-acct_1042-42" \ -H "Content-Type: application/json" \ -d '{ "input": "What is due this week?" }'
local, or oidc with the issuer and client IDPublicgetSignInSettings
200 with data: SignInSettings
/v1/sign-in-settingscurl https://zupflow.example.com/v1/sign-in-settings
{
"data": {
"mode": "local"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}/v1/mecurl https://zupflow.example.com/v1/me \ -H "Authorization: Bearer $CONSOLE_TOKEN"
{
"data": {
"user": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
},
"organizations": [
{
"id": "org_034WrceamQGAwHgTod2dHN",
"name": "Acme Corp",
"slug": "acme",
"role": "owner",
"created_at": null,
"setup": null
}
]
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}INVITATION_LIST_LIMIT (50), leaving out any expired more than EXPIRED_INVITATION_SHOWN_DAYS (30) days ago. 403 email_unverified when the sign-in doesn't vouch for the user's address now (backend only: the mock doesn't simulate verification)Console sessionlistInvitations
200 with data: Invitation[]
/v1/me/invitationscurl https://zupflow.example.com/v1/me/invitations \ -H "Authorization: Bearer $CONSOLE_TOKEN"
{
"data": [
{
"id": "mem_0340gXOnK5IPTQna7u9cyT",
"organization": {
"id": "org_034WrceamQGAwHgTod2dHN",
"name": "Acme Corp",
"slug": "acme"
},
"role": "owner",
"invited_by": {
"name": "Acme Corp",
"email": "ada@example.com"
},
"status": "pending",
"invited_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}404; an accepted one 409 invitation_accepted; an expired one 422 invitation_expired; 403 email_unverified as for the list (backend only)Console sessionacceptInvitation
invitationMemberIdrequired200 with data: Organization
/v1/me/invitations/{invitation}/acceptcurl -X POST https://zupflow.example.com/v1/me/invitations/mem_0340gXOnK5IPTQna7u9cyT/accept \ -H "Authorization: Bearer $CONSOLE_TOKEN" \ -H "Idempotency-Key: $(uuidgen)"
{
"data": {
"id": "org_034WrceamQGAwHgTod2dHN",
"name": "Acme Corp",
"slug": "acme",
"role": "owner",
"created_at": "2026-10-04T21:04:11.000Z",
"setup": {
"has_app": true,
"has_ready_configuration": true,
"has_workspace": true,
"has_api_key": true,
"has_installation": true,
"has_agent": true,
"has_run": true
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}404; an accepted one 409 invitation_accepted; 403 email_unverified as for the list (backend only)Console sessiondeclineInvitation
invitationMemberIdrequired204 with an empty body
/v1/me/invitations/{invitation}/declinecurl -X POST https://zupflow.example.com/v1/me/invitations/mem_0340gXOnK5IPTQna7u9cyT/decline \ -H "Authorization: Bearer $CONSOLE_TOKEN" \ -H "Idempotency-Key: $(uuidgen)"
Console sessioncreateOrganization
namestringrequiredslugstringrequired201 with data: Organization
/v1/organizationscurl -X POST https://zupflow.example.com/v1/organizations \ -H "Authorization: Bearer $CONSOLE_TOKEN" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp", "slug": "acme" }'
{
"data": {
"id": "org_034WrceamQGAwHgTod2dHN",
"name": "Acme Corp",
"slug": "acme",
"role": "owner",
"created_at": "2026-10-04T21:04:11.000Z",
"setup": {
"has_app": true,
"has_ready_configuration": true,
"has_workspace": true,
"has_api_key": true,
"has_installation": true,
"has_agent": true,
"has_run": true
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessiongetOrganization
orgOrganizationIdrequired200 with data: Organization
/v1/organizations/{org}curl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN \ -H "Authorization: Bearer $CONSOLE_TOKEN"
{
"data": {
"id": "org_034WrceamQGAwHgTod2dHN",
"name": "Acme Corp",
"slug": "acme",
"role": "owner",
"created_at": "2026-10-04T21:04:11.000Z",
"setup": {
"has_app": true,
"has_ready_configuration": true,
"has_workspace": true,
"has_api_key": true,
"has_installation": true,
"has_agent": true,
"has_run": true
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionupdateOrganization
orgOrganizationIdrequirednamestringslugstring200 with data: Organization
/v1/organizations/{org}curl -X PATCH https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN \ -H "Authorization: Bearer $CONSOLE_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp", "slug": "acme" }'
{
"data": {
"id": "org_034WrceamQGAwHgTod2dHN",
"name": "Acme Corp",
"slug": "acme",
"role": "owner",
"created_at": "2026-10-04T21:04:11.000Z",
"setup": {
"has_app": true,
"has_ready_configuration": true,
"has_workspace": true,
"has_api_key": true,
"has_installation": true,
"has_agent": true,
"has_run": true
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetUsage
orgOrganizationIdrequiredenvironmentEnvironmentrequireddaysinteger200 with data: UsageReport
/v1/organizations/{org}/usagecurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/usage \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"environment": "sandbox",
"days": [
{
"date": "date",
"runs": 1,
"failed_runs": 1,
"tool_calls": 1,
"input_tokens": 1,
"output_tokens": 1,
"cache_read_input_tokens": 1,
"cache_write_input_tokens": 1
}
],
"totals": {
"runs": 1,
"failed_runs": 1,
"tool_calls": 1,
"input_tokens": 1,
"output_tokens": 1,
"cache_read_input_tokens": 1,
"cache_write_input_tokens": 1
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionlistMembers
orgOrganizationIdrequired200 with data: Member[]
/v1/organizations/{org}/memberscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/members \ -H "Authorization: Bearer $CONSOLE_TOKEN"
{
"data": [
{
"id": "mem_0340gXOnK5IPTQna7u9cyT",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"user": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
},
"role": "owner",
"status": "active",
"invited_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z",
"joined_at": "2026-10-04T21:04:11.000Z",
"last_active_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessioninviteMember
orgOrganizationIdrequiredemailstringrequiredrole"owner" | "admin" | "developer" | "viewer"required201 with data: Member
/v1/organizations/{org}/memberscurl -X POST https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/members \ -H "Authorization: Bearer $CONSOLE_TOKEN" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "email": "ada@example.com", "role": "owner" }'
{
"data": {
"id": "mem_0340gXOnK5IPTQna7u9cyT",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"user": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
},
"role": "owner",
"status": "active",
"invited_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z",
"joined_at": "2026-10-04T21:04:11.000Z",
"last_active_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionupdateMember
orgOrganizationIdrequiredmemberMemberIdrequiredrole"owner" | "admin" | "developer" | "viewer"required200 with data: Member
/v1/organizations/{org}/members/{member}curl -X PATCH https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/members/mem_0340gXOnK5IPTQna7u9cyT \ -H "Authorization: Bearer $CONSOLE_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "role": "owner" }'
{
"data": {
"id": "mem_0340gXOnK5IPTQna7u9cyT",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"user": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
},
"role": "owner",
"status": "active",
"invited_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z",
"joined_at": "2026-10-04T21:04:11.000Z",
"last_active_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionremoveMember
orgOrganizationIdrequiredmemberMemberIdrequiredstatus"invited"invited: withdraw an invitation only. One accepted in the meantime is left alone, and answers 409 invitation_accepted.204 with an empty body
/v1/organizations/{org}/members/{member}curl -X DELETE https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/members/mem_0340gXOnK5IPTQna7u9cyT \ -H "Authorization: Bearer $CONSOLE_TOKEN"
Console sessionAPI keylistOrganizationRuns
orgOrganizationIdrequiredenvironmentEnvironmentworkspace_idWorkspaceIdstatus"queued" | "running" | "waiting_for_approval" | "completed" | …cursorstringlimitinteger200 with data: OrganizationRun[]
/v1/organizations/{org}/runscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/runs \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "run_034NRN3tk3efa42EcmTqpS",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"agent_name": "agent name",
"session_id": "ses_034cKnpq00MQYN3AkZWtMd",
"trigger": "api",
"channel": {
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"conversation_id": "conv_034UNYVNxd3k7BFPdmTECW",
"thread_key": "thread key",
"origin_message_id": "chmsg_034UNYVNxdRCAxtYiHCvOx",
"reason": "direct_message",
"silent_reason": "silent reason"
},
"status": "queued",
"input": "What's due this week?",
"output": "output",
"usage": {
"input_tokens": 1,
"output_tokens": 1,
"cache_read_input_tokens": 1,
"cache_write_input_tokens": 1,
"tool_calls": 1
},
"error": {
"code": "code",
"message": "message"
},
"created_at": "2026-10-04T21:04:11.000Z",
"started_at": "2026-10-04T21:04:11.000Z",
"finished_at": "2026-10-04T21:04:11.000Z",
"workspace": {
"id": "ws_034a8swzUzvsQ2inuZzZfA",
"name": "Acme Corp",
"slug": "acme",
"environment": null
}
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}422 model_not_configuredConsole sessionAPI keystartRun
wsWorkspaceIdrequiredagentAgentIdrequiredinputstringrequired201 with data: Run
/v1/workspaces/{ws}/agents/{agent}/runscurl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents/agt_034ywLOuKYCjR5w5Q59KRz/runs \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "input": "What'\''s due this week?" }'
{
"data": {
"id": "run_034NRN3tk3efa42EcmTqpS",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"agent_name": "agent name",
"session_id": "ses_034cKnpq00MQYN3AkZWtMd",
"trigger": "api",
"channel": {
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"conversation_id": "conv_034UNYVNxd3k7BFPdmTECW",
"thread_key": "thread key",
"origin_message_id": "chmsg_034UNYVNxdRCAxtYiHCvOx",
"reason": "direct_message",
"silent_reason": "silent reason"
},
"status": "queued",
"input": "What's due this week?",
"output": "output",
"usage": {
"input_tokens": 1,
"output_tokens": 1,
"cache_read_input_tokens": 1,
"cache_write_input_tokens": 1,
"tool_calls": 1
},
"error": {
"code": "code",
"message": "message"
},
"created_at": "2026-10-04T21:04:11.000Z",
"started_at": "2026-10-04T21:04:11.000Z",
"finished_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistRuns
wsWorkspaceIdrequiredagent_idAgentIdstatus"queued" | "running" | "waiting_for_approval" | "completed" | …cursorstringlimitinteger200 with data: Run[]
/v1/workspaces/{ws}/runscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/runs \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "run_034NRN3tk3efa42EcmTqpS",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"agent_name": "agent name",
"session_id": "ses_034cKnpq00MQYN3AkZWtMd",
"trigger": "api",
"channel": {
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"conversation_id": "conv_034UNYVNxd3k7BFPdmTECW",
"thread_key": "thread key",
"origin_message_id": "chmsg_034UNYVNxdRCAxtYiHCvOx",
"reason": "direct_message",
"silent_reason": "silent reason"
},
"status": "queued",
"input": "What's due this week?",
"output": "output",
"usage": {
"input_tokens": 1,
"output_tokens": 1,
"cache_read_input_tokens": 1,
"cache_write_input_tokens": 1,
"tool_calls": 1
},
"error": {
"code": "code",
"message": "message"
},
"created_at": "2026-10-04T21:04:11.000Z",
"started_at": "2026-10-04T21:04:11.000Z",
"finished_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetRun
wsWorkspaceIdrequiredrunRunIdrequired200 with data: Run
/v1/workspaces/{ws}/runs/{run}curl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/runs/run_034NRN3tk3efa42EcmTqpS \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "run_034NRN3tk3efa42EcmTqpS",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"agent_name": "agent name",
"session_id": "ses_034cKnpq00MQYN3AkZWtMd",
"trigger": "api",
"channel": {
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"conversation_id": "conv_034UNYVNxd3k7BFPdmTECW",
"thread_key": "thread key",
"origin_message_id": "chmsg_034UNYVNxdRCAxtYiHCvOx",
"reason": "direct_message",
"silent_reason": "silent reason"
},
"status": "queued",
"input": "What's due this week?",
"output": "output",
"usage": {
"input_tokens": 1,
"output_tokens": 1,
"cache_read_input_tokens": 1,
"cache_write_input_tokens": 1,
"tool_calls": 1
},
"error": {
"code": "code",
"message": "message"
},
"created_at": "2026-10-04T21:04:11.000Z",
"started_at": "2026-10-04T21:04:11.000Z",
"finished_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistRunEvents
wsWorkspaceIdrequiredrunRunIdrequiredafterinteger200 with data: RunEvent[]
/v1/workspaces/{ws}/runs/{run}/eventscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/runs/run_034NRN3tk3efa42EcmTqpS/events \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "rev_034NRN5TbBGHquQycqE0V2",
"run_id": "run_034NRN3tk3efa42EcmTqpS",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"sequence": 1,
"created_at": "2026-10-04T21:04:11.000Z",
"type": "run.queued",
"data": {}
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keycancelRun
wsWorkspaceIdrequiredrunRunIdrequired200 with data: Run
/v1/workspaces/{ws}/runs/{run}/cancelcurl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/runs/run_034NRN3tk3efa42EcmTqpS/cancel \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)"
{
"data": {
"id": "run_034NRN3tk3efa42EcmTqpS",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"agent_name": "agent name",
"session_id": "ses_034cKnpq00MQYN3AkZWtMd",
"trigger": "api",
"channel": {
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"conversation_id": "conv_034UNYVNxd3k7BFPdmTECW",
"thread_key": "thread key",
"origin_message_id": "chmsg_034UNYVNxdRCAxtYiHCvOx",
"reason": "direct_message",
"silent_reason": "silent reason"
},
"status": "queued",
"input": "What's due this week?",
"output": "output",
"usage": {
"input_tokens": 1,
"output_tokens": 1,
"cache_read_input_tokens": 1,
"cache_write_input_tokens": 1,
"tool_calls": 1
},
"error": {
"code": "code",
"message": "message"
},
"created_at": "2026-10-04T21:04:11.000Z",
"started_at": "2026-10-04T21:04:11.000Z",
"finished_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}API keyresolveApproval
wsWorkspaceIdrequiredrunRunIdrequiredcall_idToolCallIdrequireddecision"approved" | "denied"requiredreasonstring200 with data: Run
/v1/workspaces/{ws}/runs/{run}/approvalscurl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/runs/run_034NRN3tk3efa42EcmTqpS/approvals \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "call_id": "call_034ptAVGI4F0rFleDY0wrs", "decision": "approved" }'
{
"data": {
"id": "run_034NRN3tk3efa42EcmTqpS",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"agent_name": "agent name",
"session_id": "ses_034cKnpq00MQYN3AkZWtMd",
"trigger": "api",
"channel": {
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"conversation_id": "conv_034UNYVNxd3k7BFPdmTECW",
"thread_key": "thread key",
"origin_message_id": "chmsg_034UNYVNxdRCAxtYiHCvOx",
"reason": "direct_message",
"silent_reason": "silent reason"
},
"status": "queued",
"input": "What's due this week?",
"output": "output",
"usage": {
"input_tokens": 1,
"output_tokens": 1,
"cache_read_input_tokens": 1,
"cache_write_input_tokens": 1,
"tool_calls": 1
},
"error": {
"code": "code",
"message": "message"
},
"created_at": "2026-10-04T21:04:11.000Z",
"started_at": "2026-10-04T21:04:11.000Z",
"finished_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionlistAuditEvents
orgOrganizationIdrequiredworkspace_idWorkspaceIdcursorstringlimitinteger200 with data: AuditEvent[]
/v1/organizations/{org}/audit-eventscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/audit-events \ -H "Authorization: Bearer $CONSOLE_TOKEN"
{
"data": [
{
"id": "aud_034yYKI6ssgOVE90WsIYKo",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"workspace": {
"id": "ws_034a8swzUzvsQ2inuZzZfA",
"name": "Acme Corp",
"slug": "acme",
"environment": null
},
"environment": "sandbox",
"actor": {
"type": "user",
"id": "id",
"name": "Acme Corp"
},
"action": "action",
"target": {
"type": "type",
"id": "id",
"name": "Acme Corp"
},
"created_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistWorkspaces
orgOrganizationIdrequiredenvironmentEnvironmentqstringsort"name" | "activity"cursorstringlimitinteger200 with data: Workspace[]
/v1/organizations/{org}/workspacescurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/workspaces \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "ws_034a8swzUzvsQ2inuZzZfA",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"name": "Acme Corp",
"slug": "acme",
"environment": "sandbox",
"external_id": "cus_1042",
"created_at": "2026-10-04T21:04:11.000Z",
"stats": {
"agents": 1,
"installations": 1,
"runs_last_24h": 1
}
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keycreateWorkspace
orgOrganizationIdrequirednamestringrequiredslugstringrequiredenvironmentEnvironmentrequiredexternal_idstring | nullrequired201 with data: Workspace
/v1/organizations/{org}/workspacescurl -X POST https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/workspaces \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp", "slug": "acme", "environment": "sandbox", "external_id": "cus_1042" }'
{
"data": {
"id": "ws_034a8swzUzvsQ2inuZzZfA",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"name": "Acme Corp",
"slug": "acme",
"environment": "sandbox",
"external_id": "cus_1042",
"created_at": "2026-10-04T21:04:11.000Z",
"stats": {
"agents": 1,
"installations": 1,
"runs_last_24h": 1
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetWorkspace
wsWorkspaceIdrequired200 with data: Workspace
/v1/workspaces/{ws}curl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "ws_034a8swzUzvsQ2inuZzZfA",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"name": "Acme Corp",
"slug": "acme",
"environment": "sandbox",
"external_id": "cus_1042",
"created_at": "2026-10-04T21:04:11.000Z",
"stats": {
"agents": 1,
"installations": 1,
"runs_last_24h": 1
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateWorkspace
wsWorkspaceIdrequirednamestringexternal_idstring | null200 with data: Workspace
/v1/workspaces/{ws}curl -X PATCH https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp", "external_id": "cus_1042" }'
{
"data": {
"id": "ws_034a8swzUzvsQ2inuZzZfA",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"name": "Acme Corp",
"slug": "acme",
"environment": "sandbox",
"external_id": "cus_1042",
"created_at": "2026-10-04T21:04:11.000Z",
"stats": {
"agents": 1,
"installations": 1,
"runs_last_24h": 1
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keydeleteWorkspace
wsWorkspaceIdrequired204 with an empty body
/v1/workspaces/{ws}curl -X DELETE https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
Console sessionAPI keylistOrganizationApps
orgOrganizationIdrequired200 with data: App[]
/v1/organizations/{org}/appscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/apps \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"owner_workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"owner_scope": "organization",
"kind": "mcp",
"name": "Acme Corp",
"key": "linear",
"description": "Lists the issues assigned to you.",
"icon": {
"glyph": "glyph",
"color": "color"
},
"auth": {
"type": null,
"authorize_url": null,
"token_url": null,
"issuer": null,
"available_scopes": null,
"pkce": null,
"identity_url": null
},
"tools": [
{
"name": null,
"title": null,
"description": null,
"effect": null
}
],
"version": 1,
"configurations": [
{
"environment": null,
"status": null,
"version": null,
"updated_at": null
}
],
"installation_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keycreateOrganizationApp
orgOrganizationIdrequiredkind"mcp"requirednamestringrequiredkeystringrequireddescriptionstringrequiredauth_type"oauth2" | "mcp_oauth" | "token"required201 with data: App
/v1/organizations/{org}/appscurl -X POST https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/apps \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "kind": "mcp", "name": "Acme Corp", "key": "linear", "description": "Lists the issues assigned to you.", "auth_type": "oauth2" }'
{
"data": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"owner_workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"owner_scope": "organization",
"kind": "mcp",
"name": "Acme Corp",
"key": "linear",
"description": "Lists the issues assigned to you.",
"icon": {
"glyph": "glyph",
"color": "color"
},
"auth": {
"type": "oauth2",
"authorize_url": "https://example.com/asset",
"token_url": "https://example.com/asset",
"issuer": "issuer",
"available_scopes": [],
"pkce": true,
"identity_url": "https://example.com/asset"
},
"tools": [
{
"name": "Acme Corp",
"title": "Plan my week",
"description": "Lists the issues assigned to you.",
"effect": "read"
}
],
"version": 1,
"configurations": [
{
"environment": null,
"status": "unconfigured",
"version": 1,
"updated_at": null
}
],
"installation_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetOrganizationApp
orgOrganizationIdrequiredappAppIdrequired200 with data: App
/v1/organizations/{org}/apps/{app}curl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/apps/app_034yLNzn9tcN2FM4UEOmrQ \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"owner_workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"owner_scope": "organization",
"kind": "mcp",
"name": "Acme Corp",
"key": "linear",
"description": "Lists the issues assigned to you.",
"icon": {
"glyph": "glyph",
"color": "color"
},
"auth": {
"type": "oauth2",
"authorize_url": "https://example.com/asset",
"token_url": "https://example.com/asset",
"issuer": "issuer",
"available_scopes": [],
"pkce": true,
"identity_url": "https://example.com/asset"
},
"tools": [
{
"name": "Acme Corp",
"title": "Plan my week",
"description": "Lists the issues assigned to you.",
"effect": "read"
}
],
"version": 1,
"configurations": [
{
"environment": null,
"status": "unconfigured",
"version": 1,
"updated_at": null
}
],
"installation_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateOrganizationApp
orgOrganizationIdrequiredappAppIdrequirednamestringdescriptionstringauthAuthTemplate200 with data: App
/v1/organizations/{org}/apps/{app}curl -X PATCH https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/apps/app_034yLNzn9tcN2FM4UEOmrQ \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp", "description": "Lists the issues assigned to you." }'
{
"data": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"owner_workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"owner_scope": "organization",
"kind": "mcp",
"name": "Acme Corp",
"key": "linear",
"description": "Lists the issues assigned to you.",
"icon": {
"glyph": "glyph",
"color": "color"
},
"auth": {
"type": "oauth2",
"authorize_url": "https://example.com/asset",
"token_url": "https://example.com/asset",
"issuer": "issuer",
"available_scopes": [],
"pkce": true,
"identity_url": "https://example.com/asset"
},
"tools": [
{
"name": "Acme Corp",
"title": "Plan my week",
"description": "Lists the issues assigned to you.",
"effect": "read"
}
],
"version": 1,
"configurations": [
{
"environment": null,
"status": "unconfigured",
"version": 1,
"updated_at": null
}
],
"installation_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetOrganizationAppConfiguration
orgOrganizationIdrequiredappAppIdrequiredenvEnvironmentrequired200 with data: ClientConfiguration
/v1/organizations/{org}/apps/{app}/environments/{env}/configurationcurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/apps/app_034yLNzn9tcN2FM4UEOmrQ/environments/sandbox/configuration \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"app_id": "app_034yLNzn9tcN2FM4UEOmrQ",
"environment": "sandbox",
"status": "unconfigured",
"version": 1,
"mcp": {
"server_url": "https://example.com/asset",
"transport": "streamable_http"
},
"oauth": {
"client_id": "client id",
"client_secret": {
"set": true,
"last4": "last4",
"updated_at": null
},
"redirect_uri": "redirect uri",
"scopes": [
"scopes"
]
},
"missing": [
"missing"
],
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateOrganizationAppConfiguration
orgOrganizationIdrequiredappAppIdrequiredenvEnvironmentrequiredmcp_server_urlstring | nulloauth_client_idstring | nulloauth_client_secretstringoauth_scopesstring[]200 with data: ClientConfiguration
/v1/organizations/{org}/apps/{app}/environments/{env}/configurationcurl -X PUT https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/apps/app_034yLNzn9tcN2FM4UEOmrQ/environments/sandbox/configuration \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "mcp_server_url": "https://example.com/asset", "oauth_client_id": "oauth client id" }'
{
"data": {
"app_id": "app_034yLNzn9tcN2FM4UEOmrQ",
"environment": "sandbox",
"status": "unconfigured",
"version": 1,
"mcp": {
"server_url": "https://example.com/asset",
"transport": "streamable_http"
},
"oauth": {
"client_id": "client id",
"client_secret": {
"set": true,
"last4": "last4",
"updated_at": null
},
"redirect_uri": "redirect uri",
"scopes": [
"scopes"
]
},
"missing": [
"missing"
],
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistOrganizationAppInstallations
orgOrganizationIdrequiredappAppIdrequiredenvironmentEnvironmentcursorstringlimitinteger200 with data: AppInstallationRef[]
/v1/organizations/{org}/apps/{app}/installationscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/apps/app_034yLNzn9tcN2FM4UEOmrQ/installations \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"installation": {
"id": "inst_0342dcXGvZf3hgl01YboFc",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"app": null,
"short_id": null,
"label": "label",
"status": "connected",
"configuration_version": 1,
"connection": null,
"grant_count": 3,
"created_at": null,
"updated_at": null
},
"workspace": {
"id": "ws_034a8swzUzvsQ2inuZzZfA",
"name": "Acme Corp",
"slug": "acme",
"environment": null
}
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistWorkspaceApps
wsWorkspaceIdrequired200 with data: App[]
/v1/workspaces/{ws}/appscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/apps \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"owner_workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"owner_scope": "organization",
"kind": "mcp",
"name": "Acme Corp",
"key": "linear",
"description": "Lists the issues assigned to you.",
"icon": {
"glyph": "glyph",
"color": "color"
},
"auth": {
"type": null,
"authorize_url": null,
"token_url": null,
"issuer": null,
"available_scopes": null,
"pkce": null,
"identity_url": null
},
"tools": [
{
"name": null,
"title": null,
"description": null,
"effect": null
}
],
"version": 1,
"configurations": [
{
"environment": null,
"status": null,
"version": null,
"updated_at": null
}
],
"installation_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keycreateWorkspaceApp
wsWorkspaceIdrequiredkind"mcp"requirednamestringrequiredkeystringrequireddescriptionstringrequiredauth_type"oauth2" | "mcp_oauth" | "token"required201 with data: App
/v1/workspaces/{ws}/appscurl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/apps \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "kind": "mcp", "name": "Acme Corp", "key": "linear", "description": "Lists the issues assigned to you.", "auth_type": "oauth2" }'
{
"data": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"owner_workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"owner_scope": "organization",
"kind": "mcp",
"name": "Acme Corp",
"key": "linear",
"description": "Lists the issues assigned to you.",
"icon": {
"glyph": "glyph",
"color": "color"
},
"auth": {
"type": "oauth2",
"authorize_url": "https://example.com/asset",
"token_url": "https://example.com/asset",
"issuer": "issuer",
"available_scopes": [],
"pkce": true,
"identity_url": "https://example.com/asset"
},
"tools": [
{
"name": "Acme Corp",
"title": "Plan my week",
"description": "Lists the issues assigned to you.",
"effect": "read"
}
],
"version": 1,
"configurations": [
{
"environment": null,
"status": "unconfigured",
"version": 1,
"updated_at": null
}
],
"installation_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetWorkspaceApp
wsWorkspaceIdrequiredappAppIdrequired200 with data: App
/v1/workspaces/{ws}/apps/{app}curl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/apps/app_034yLNzn9tcN2FM4UEOmrQ \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"owner_workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"owner_scope": "organization",
"kind": "mcp",
"name": "Acme Corp",
"key": "linear",
"description": "Lists the issues assigned to you.",
"icon": {
"glyph": "glyph",
"color": "color"
},
"auth": {
"type": "oauth2",
"authorize_url": "https://example.com/asset",
"token_url": "https://example.com/asset",
"issuer": "issuer",
"available_scopes": [],
"pkce": true,
"identity_url": "https://example.com/asset"
},
"tools": [
{
"name": "Acme Corp",
"title": "Plan my week",
"description": "Lists the issues assigned to you.",
"effect": "read"
}
],
"version": 1,
"configurations": [
{
"environment": null,
"status": "unconfigured",
"version": 1,
"updated_at": null
}
],
"installation_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateWorkspaceApp
wsWorkspaceIdrequiredappAppIdrequirednamestringdescriptionstringauthAuthTemplate200 with data: App
/v1/workspaces/{ws}/apps/{app}curl -X PATCH https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/apps/app_034yLNzn9tcN2FM4UEOmrQ \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp", "description": "Lists the issues assigned to you." }'
{
"data": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"owner_workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"owner_scope": "organization",
"kind": "mcp",
"name": "Acme Corp",
"key": "linear",
"description": "Lists the issues assigned to you.",
"icon": {
"glyph": "glyph",
"color": "color"
},
"auth": {
"type": "oauth2",
"authorize_url": "https://example.com/asset",
"token_url": "https://example.com/asset",
"issuer": "issuer",
"available_scopes": [],
"pkce": true,
"identity_url": "https://example.com/asset"
},
"tools": [
{
"name": "Acme Corp",
"title": "Plan my week",
"description": "Lists the issues assigned to you.",
"effect": "read"
}
],
"version": 1,
"configurations": [
{
"environment": null,
"status": "unconfigured",
"version": 1,
"updated_at": null
}
],
"installation_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetWorkspaceAppConfiguration
wsWorkspaceIdrequiredappAppIdrequired200 with data: ClientConfiguration
/v1/workspaces/{ws}/apps/{app}/configurationcurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/apps/app_034yLNzn9tcN2FM4UEOmrQ/configuration \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"app_id": "app_034yLNzn9tcN2FM4UEOmrQ",
"environment": "sandbox",
"status": "unconfigured",
"version": 1,
"mcp": {
"server_url": "https://example.com/asset",
"transport": "streamable_http"
},
"oauth": {
"client_id": "client id",
"client_secret": {
"set": true,
"last4": "last4",
"updated_at": null
},
"redirect_uri": "redirect uri",
"scopes": [
"scopes"
]
},
"missing": [
"missing"
],
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateWorkspaceAppConfiguration
wsWorkspaceIdrequiredappAppIdrequiredmcp_server_urlstring | nulloauth_client_idstring | nulloauth_client_secretstringoauth_scopesstring[]200 with data: ClientConfiguration
/v1/workspaces/{ws}/apps/{app}/configurationcurl -X PUT https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/apps/app_034yLNzn9tcN2FM4UEOmrQ/configuration \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "mcp_server_url": "https://example.com/asset", "oauth_client_id": "oauth client id" }'
{
"data": {
"app_id": "app_034yLNzn9tcN2FM4UEOmrQ",
"environment": "sandbox",
"status": "unconfigured",
"version": 1,
"mcp": {
"server_url": "https://example.com/asset",
"transport": "streamable_http"
},
"oauth": {
"client_id": "client id",
"client_secret": {
"set": true,
"last4": "last4",
"updated_at": null
},
"redirect_uri": "redirect uri",
"scopes": [
"scopes"
]
},
"missing": [
"missing"
],
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistAvailableApps
wsWorkspaceIdrequired200 with data: AvailableApp[]
/v1/workspaces/{ws}/available-appscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/available-apps \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"app": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"owner_workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"owner_scope": "organization",
"kind": "mcp",
"name": "Acme Corp",
"key": null,
"description": "Lists the issues assigned to you.",
"icon": null,
"auth": null,
"tools": [],
"version": 1,
"configurations": [],
"installation_count": 3,
"created_at": null,
"updated_at": null
},
"configuration": {
"environment": null,
"status": "unconfigured",
"version": 1,
"updated_at": null
}
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetToolPolicy
orgOrganizationIdrequired200 with data: ToolPolicy
/v1/organizations/{org}/tool-policycurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/tool-policy \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"mode": "manual",
"new_tool_level": "approve",
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionupdateToolPolicy
orgOrganizationIdrequiredmode"manual"requirednew_tool_level"approve" | "deny"required200 with data: ToolPolicy
/v1/organizations/{org}/tool-policycurl -X PUT https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/tool-policy \ -H "Authorization: Bearer $CONSOLE_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "mode": "manual", "new_tool_level": "approve" }'
{
"data": {
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"mode": "manual",
"new_tool_level": "approve",
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistAppToolLevels
orgOrganizationIdrequiredappAppIdrequiredcursorstringlimitinteger200 with data: AppToolLevel[]
/v1/organizations/{org}/apps/{app}/tool-levelscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/apps/app_034yLNzn9tcN2FM4UEOmrQ/tool-levels \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"app_id": "app_034yLNzn9tcN2FM4UEOmrQ",
"tool": "list_issues",
"level": "allow",
"confirmed": true,
"destructive": true,
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionupdateAppToolLevels
orgOrganizationIdrequiredappAppIdrequiredlevelsobject[]required200 with data: AppToolLevel[]
/v1/organizations/{org}/apps/{app}/tool-levelscurl -X PATCH https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/apps/app_034yLNzn9tcN2FM4UEOmrQ/tool-levels \ -H "Authorization: Bearer $CONSOLE_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "levels": [ { "tool": "list_issues", "level": "allow" } ] }'
{
"data": [
{
"app_id": "app_034yLNzn9tcN2FM4UEOmrQ",
"tool": "list_issues",
"level": "allow",
"confirmed": true,
"destructive": true,
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistInstallations
wsWorkspaceIdrequired200 with data: Installation[]
/v1/workspaces/{ws}/installationscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/installations \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "inst_0342dcXGvZf3hgl01YboFc",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"app": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"name": "Acme Corp",
"key": null,
"owner_scope": "organization",
"icon": null,
"auth_type": "oauth2"
},
"short_id": "k7qmxa",
"label": "label",
"status": "connected",
"configuration_version": 1,
"connection": {
"account": null,
"granted_scopes": [],
"credential_version": 1,
"connected_at": null,
"expires_at": null
},
"grant_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetInstallation
wsWorkspaceIdrequiredinstInstallationIdrequired200 with data: Installation
/v1/workspaces/{ws}/installations/{inst}curl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/installations/inst_0342dcXGvZf3hgl01YboFc \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "inst_0342dcXGvZf3hgl01YboFc",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"app": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"name": "Acme Corp",
"key": "linear",
"owner_scope": "organization",
"icon": {
"glyph": null,
"color": null
},
"auth_type": "oauth2"
},
"short_id": "k7qmxa",
"label": "label",
"status": "connected",
"configuration_version": 1,
"connection": {
"account": {
"external_id": null,
"display_name": null,
"email": null
},
"granted_scopes": [
"granted scopes"
],
"credential_version": 1,
"connected_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z"
},
"grant_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateInstallation
wsWorkspaceIdrequiredinstInstallationIdrequiredlabelstringrequired200 with data: Installation
/v1/workspaces/{ws}/installations/{inst}curl -X PATCH https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/installations/inst_0342dcXGvZf3hgl01YboFc \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "label": "label" }'
{
"data": {
"id": "inst_0342dcXGvZf3hgl01YboFc",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"app": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"name": "Acme Corp",
"key": "linear",
"owner_scope": "organization",
"icon": {
"glyph": null,
"color": null
},
"auth_type": "oauth2"
},
"short_id": "k7qmxa",
"label": "label",
"status": "connected",
"configuration_version": 1,
"connection": {
"account": {
"external_id": null,
"display_name": null,
"email": null
},
"granted_scopes": [
"granted scopes"
],
"credential_version": 1,
"connected_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z"
},
"grant_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keydeleteInstallation
wsWorkspaceIdrequiredinstInstallationIdrequired204 with an empty body
/v1/workspaces/{ws}/installations/{inst}curl -X DELETE https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/installations/inst_0342dcXGvZf3hgl01YboFc \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
Console sessionAPI keydisconnectInstallation
wsWorkspaceIdrequiredinstInstallationIdrequired200 with data: Installation
/v1/workspaces/{ws}/installations/{inst}/disconnectcurl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/installations/inst_0342dcXGvZf3hgl01YboFc/disconnect \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)"
{
"data": {
"id": "inst_0342dcXGvZf3hgl01YboFc",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"app": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"name": "Acme Corp",
"key": "linear",
"owner_scope": "organization",
"icon": {
"glyph": null,
"color": null
},
"auth_type": "oauth2"
},
"short_id": "k7qmxa",
"label": "label",
"status": "connected",
"configuration_version": 1,
"connection": {
"account": {
"external_id": null,
"display_name": null,
"email": null
},
"granted_scopes": [
"granted scopes"
],
"credential_version": 1,
"connected_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z"
},
"grant_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistInstallationTools
wsWorkspaceIdrequiredinstInstallationIdrequiredcursorstringlimitinteger200 with data: InstallationTool[]
/v1/workspaces/{ws}/installations/{inst}/toolscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/installations/inst_0342dcXGvZf3hgl01YboFc/tools \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"name": "Acme Corp",
"effect": "read",
"status": "current",
"pinned": {
"title": "Plan my week",
"description": "Lists the issues assigned to you.",
"input_schema": {},
"output_schema": {},
"annotations": {}
},
"pinned_hash": "pinned hash",
"latest": {
"title": "Plan my week",
"description": "Lists the issues assigned to you.",
"input_schema": {},
"output_schema": {},
"annotations": {}
},
"latest_hash": "latest hash",
"first_seen_at": "2026-10-04T21:04:11.000Z",
"seen_at": "2026-10-04T21:04:11.000Z",
"changed_at": "2026-10-04T21:04:11.000Z",
"gone_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyrefreshInstallationTools
wsWorkspaceIdrequiredinstInstallationIdrequired200 with data: Installation
/v1/workspaces/{ws}/installations/{inst}/refresh-toolscurl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/installations/inst_0342dcXGvZf3hgl01YboFc/refresh-tools \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)"
{
"data": {
"id": "inst_0342dcXGvZf3hgl01YboFc",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"app": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"name": "Acme Corp",
"key": "linear",
"owner_scope": "organization",
"icon": {
"glyph": null,
"color": null
},
"auth_type": "oauth2"
},
"short_id": "k7qmxa",
"label": "label",
"status": "connected",
"configuration_version": 1,
"connection": {
"account": {
"external_id": null,
"display_name": null,
"email": null
},
"granted_scopes": [
"granted scopes"
],
"credential_version": 1,
"connected_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z"
},
"grant_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyacceptToolChange
wsWorkspaceIdrequiredinstInstallationIdrequirednamestringrequiredlatest_hashstringrequired200 with data: InstallationTool
/v1/workspaces/{ws}/installations/{inst}/accept-tool-changecurl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/installations/inst_0342dcXGvZf3hgl01YboFc/accept-tool-change \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp", "latest_hash": "latest hash" }'
{
"data": {
"name": "Acme Corp",
"effect": "read",
"status": "current",
"pinned": {
"title": "Plan my week",
"description": "Lists the issues assigned to you.",
"input_schema": {},
"output_schema": {},
"annotations": {}
},
"pinned_hash": "pinned hash",
"latest": {
"title": "Plan my week",
"description": "Lists the issues assigned to you.",
"input_schema": {},
"output_schema": {},
"annotations": {}
},
"latest_hash": "latest hash",
"first_seen_at": "2026-10-04T21:04:11.000Z",
"seen_at": "2026-10-04T21:04:11.000Z",
"changed_at": "2026-10-04T21:04:11.000Z",
"gone_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistConnectSessions
wsWorkspaceIdrequired200 with data: ConnectSession[]
/v1/workspaces/{ws}/connect-sessionscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/connect-sessions \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "cs_034U88ZkASIVJkEla9Uh7j",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"environment": "sandbox",
"app": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"name": "Acme Corp",
"key": null,
"owner_scope": "organization",
"icon": null,
"auth_type": "oauth2"
},
"target": {
"kind": "channel_app_manager",
"provider": null,
"manager": "chmgr_034UNYVNxdX7o7BFB4Y0u2"
},
"intent": "create",
"installation_id": "inst_0342dcXGvZf3hgl01YboFc",
"label": "label",
"status": "pending",
"return_url": "https://example.com/settings/integrations",
"created_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z",
"completed_at": "2026-10-04T21:04:11.000Z",
"failure_code": "failure code",
"auth": {
"type": null,
"authorize_url": null,
"token_url": null,
"issuer": null,
"available_scopes": null,
"pkce": null,
"identity_url": null
},
"requested_scopes": [
"requested scopes"
],
"expected_account": {
"external_id": "cus_1042",
"display_name": "display name",
"email": "ada@example.com"
}
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyShows a secret oncecreateConnectSession
wsWorkspaceIdrequired201 with data: CreatedConnectSession
/v1/workspaces/{ws}/connect-sessionscurl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/connect-sessions \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)"
{
"data": {
"id": "cs_034U88ZkASIVJkEla9Uh7j",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"environment": "sandbox",
"app": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"name": "Acme Corp",
"key": "linear",
"owner_scope": "organization",
"icon": {
"glyph": null,
"color": null
},
"auth_type": "oauth2"
},
"target": {
"kind": "channel_app_manager",
"provider": "slack",
"manager": "chmgr_034UNYVNxdX7o7BFB4Y0u2"
},
"intent": "create",
"installation_id": "inst_0342dcXGvZf3hgl01YboFc",
"label": "label",
"status": "pending",
"return_url": "https://example.com/settings/integrations",
"created_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z",
"completed_at": "2026-10-04T21:04:11.000Z",
"failure_code": "failure code",
"auth": {
"type": "oauth2",
"authorize_url": "https://example.com/asset",
"token_url": "https://example.com/asset",
"issuer": "issuer",
"available_scopes": [],
"pkce": true,
"identity_url": "https://example.com/asset"
},
"requested_scopes": [
"requested scopes"
],
"expected_account": {
"external_id": "cus_1042",
"display_name": "display name",
"email": "ada@example.com"
},
"url": "https://example.com/zupflow/webhooks"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetConnectSession
wsWorkspaceIdrequiredsessionConnectSessionIdrequired200 with data: ConnectSession
/v1/workspaces/{ws}/connect-sessions/{session}curl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/connect-sessions/cs_034U88ZkASIVJkEla9Uh7j \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "cs_034U88ZkASIVJkEla9Uh7j",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"environment": "sandbox",
"app": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"name": "Acme Corp",
"key": "linear",
"owner_scope": "organization",
"icon": {
"glyph": null,
"color": null
},
"auth_type": "oauth2"
},
"target": {
"kind": "channel_app_manager",
"provider": "slack",
"manager": "chmgr_034UNYVNxdX7o7BFB4Y0u2"
},
"intent": "create",
"installation_id": "inst_0342dcXGvZf3hgl01YboFc",
"label": "label",
"status": "pending",
"return_url": "https://example.com/settings/integrations",
"created_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z",
"completed_at": "2026-10-04T21:04:11.000Z",
"failure_code": "failure code",
"auth": {
"type": "oauth2",
"authorize_url": "https://example.com/asset",
"token_url": "https://example.com/asset",
"issuer": "issuer",
"available_scopes": [],
"pkce": true,
"identity_url": "https://example.com/asset"
},
"requested_scopes": [
"requested scopes"
],
"expected_account": {
"external_id": "cus_1042",
"display_name": "display name",
"email": "ada@example.com"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Connect referencegetHostedConnect
referencestringrequiredurl. Possession authorizes the page.200 with data: ConnectSession
/v1/connect/sessions/{reference}curl https://zupflow.example.com/v1/connect/sessions/reference
{
"data": {
"id": "cs_034U88ZkASIVJkEla9Uh7j",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"environment": "sandbox",
"app": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"name": "Acme Corp",
"key": "linear",
"owner_scope": "organization",
"icon": {
"glyph": null,
"color": null
},
"auth_type": "oauth2"
},
"target": {
"kind": "channel_app_manager",
"provider": "slack",
"manager": "chmgr_034UNYVNxdX7o7BFB4Y0u2"
},
"intent": "create",
"installation_id": "inst_0342dcXGvZf3hgl01YboFc",
"label": "label",
"status": "pending",
"return_url": "https://example.com/settings/integrations",
"created_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z",
"completed_at": "2026-10-04T21:04:11.000Z",
"failure_code": "failure code",
"auth": {
"type": "oauth2",
"authorize_url": "https://example.com/asset",
"token_url": "https://example.com/asset",
"issuer": "issuer",
"available_scopes": [],
"pkce": true,
"identity_url": "https://example.com/asset"
},
"requested_scopes": [
"requested scopes"
],
"expected_account": {
"external_id": "cus_1042",
"display_name": "display name",
"email": "ada@example.com"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Connect referencesubmitConnectCredentials
referencestringrequiredurl. Possession authorizes the page.valuesobjectrequired200 with data: ConnectResult
/v1/connect/sessions/{reference}/credentialscurl -X POST https://zupflow.example.com/v1/connect/sessions/reference/credentials \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "values": {} }'
{
"data": {
"session": {
"id": "cs_034U88ZkASIVJkEla9Uh7j",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"environment": null,
"app": null,
"target": null,
"intent": "create",
"installation_id": "inst_0342dcXGvZf3hgl01YboFc",
"label": "label",
"status": "pending",
"return_url": "https://example.com/settings/integrations",
"created_at": null,
"expires_at": null,
"completed_at": null,
"failure_code": "failure code",
"auth": null,
"requested_scopes": [],
"expected_account": null
},
"installation": {
"id": "inst_0342dcXGvZf3hgl01YboFc",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"app": null,
"short_id": null,
"label": "label",
"status": "connected",
"configuration_version": 1,
"connection": null,
"grant_count": 3,
"created_at": null,
"updated_at": null
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Connect referenceShows a secret onceauthorizeConnect
referencestringrequiredurl. Possession authorizes the page.200 with data: AuthorizeConnectResult
/v1/connect/sessions/{reference}/authorizecurl -X POST https://zupflow.example.com/v1/connect/sessions/reference/authorize \ -H "Idempotency-Key: $(uuidgen)"
{
"data": {
"authorization_url": "https://example.com/asset"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Connect referencecancelConnect
referencestringrequiredurl. Possession authorizes the page.200 with data: ConnectSession
/v1/connect/sessions/{reference}/cancelcurl -X POST https://zupflow.example.com/v1/connect/sessions/reference/cancel \ -H "Idempotency-Key: $(uuidgen)"
{
"data": {
"id": "cs_034U88ZkASIVJkEla9Uh7j",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"environment": "sandbox",
"app": {
"id": "app_034yLNzn9tcN2FM4UEOmrQ",
"name": "Acme Corp",
"key": "linear",
"owner_scope": "organization",
"icon": {
"glyph": null,
"color": null
},
"auth_type": "oauth2"
},
"target": {
"kind": "channel_app_manager",
"provider": "slack",
"manager": "chmgr_034UNYVNxdX7o7BFB4Y0u2"
},
"intent": "create",
"installation_id": "inst_0342dcXGvZf3hgl01YboFc",
"label": "label",
"status": "pending",
"return_url": "https://example.com/settings/integrations",
"created_at": "2026-10-04T21:04:11.000Z",
"expires_at": "2026-10-04T21:04:11.000Z",
"completed_at": "2026-10-04T21:04:11.000Z",
"failure_code": "failure code",
"auth": {
"type": "oauth2",
"authorize_url": "https://example.com/asset",
"token_url": "https://example.com/asset",
"issuer": "issuer",
"available_scopes": [],
"pkce": true,
"identity_url": "https://example.com/asset"
},
"requested_scopes": [
"requested scopes"
],
"expected_account": {
"external_id": "cus_1042",
"display_name": "display name",
"email": "ada@example.com"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetConnectSettings
orgOrganizationIdrequiredenvEnvironmentrequired200 with data: ConnectSettings
/v1/organizations/{org}/connect-settings/{env}curl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/connect-settings/sandbox \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"environment": "sandbox",
"return_urls": [
"return urls"
],
"allowed_origins": [
"allowed origins"
],
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateConnectSettings
orgOrganizationIdrequiredenvEnvironmentrequiredreturn_urlsstring[]requiredallowed_originsstring[]required200 with data: ConnectSettings
/v1/organizations/{org}/connect-settings/{env}curl -X PUT https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/connect-settings/sandbox \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "return_urls": [ "return urls" ], "allowed_origins": [ "allowed origins" ] }'
{
"data": {
"environment": "sandbox",
"return_urls": [
"return urls"
],
"allowed_origins": [
"allowed origins"
],
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistAgents
wsWorkspaceIdrequired200 with data: Agent[]
/v1/workspaces/{ws}/agentscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "agt_034ywLOuKYCjR5w5Q59KRz",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"name": "Acme Corp",
"description": "Lists the issues assigned to you.",
"model_id": "mdl_03408SQyGoiPsdqfQHVF9j",
"instructions": "You help the team plan and track their work.",
"status": "active",
"grant_count": 3,
"runs_last_24h": 1,
"last_run_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keycreateAgent
wsWorkspaceIdrequirednamestringrequireddescriptionstringrequiredmodel_idModelId | nullinstructionsstringrequired201 with data: Agent
/v1/workspaces/{ws}/agentscurl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp", "description": "Lists the issues assigned to you.", "instructions": "You help the team plan and track their work." }'
{
"data": {
"id": "agt_034ywLOuKYCjR5w5Q59KRz",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"name": "Acme Corp",
"description": "Lists the issues assigned to you.",
"model_id": "mdl_03408SQyGoiPsdqfQHVF9j",
"instructions": "You help the team plan and track their work.",
"status": "active",
"grant_count": 3,
"runs_last_24h": 1,
"last_run_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetAgent
wsWorkspaceIdrequiredagentAgentIdrequired200 with data: Agent
/v1/workspaces/{ws}/agents/{agent}curl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents/agt_034ywLOuKYCjR5w5Q59KRz \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "agt_034ywLOuKYCjR5w5Q59KRz",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"name": "Acme Corp",
"description": "Lists the issues assigned to you.",
"model_id": "mdl_03408SQyGoiPsdqfQHVF9j",
"instructions": "You help the team plan and track their work.",
"status": "active",
"grant_count": 3,
"runs_last_24h": 1,
"last_run_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateAgent
wsWorkspaceIdrequiredagentAgentIdrequirednamestringdescriptionstringmodel_idModelId | nullinstructionsstringstatus"active" | "paused"200 with data: Agent
/v1/workspaces/{ws}/agents/{agent}curl -X PATCH https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents/agt_034ywLOuKYCjR5w5Q59KRz \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp", "description": "Lists the issues assigned to you." }'
{
"data": {
"id": "agt_034ywLOuKYCjR5w5Q59KRz",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"name": "Acme Corp",
"description": "Lists the issues assigned to you.",
"model_id": "mdl_03408SQyGoiPsdqfQHVF9j",
"instructions": "You help the team plan and track their work.",
"status": "active",
"grant_count": 3,
"runs_last_24h": 1,
"last_run_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keydeleteAgent
wsWorkspaceIdrequiredagentAgentIdrequired204 with an empty body
/v1/workspaces/{ws}/agents/{agent}curl -X DELETE https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents/agt_034ywLOuKYCjR5w5Q59KRz \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
Console sessionAPI keylistGrants
wsWorkspaceIdrequiredagentAgentIdrequired200 with data: Grant[]
/v1/workspaces/{ws}/agents/{agent}/grantscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents/agt_034ywLOuKYCjR5w5Q59KRz/grants \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "grt_034SjUfhLzDVN3eZq1Ctck",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"installation_id": "inst_0342dcXGvZf3hgl01YboFc",
"tools": [
"tools"
],
"approval_required": [
"approval required"
],
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keycreateGrant
wsWorkspaceIdrequiredagentAgentIdrequiredinstallation_idInstallationIdrequiredtoolsstring[]requiredapproval_requiredstring[]required201 with data: Grant
/v1/workspaces/{ws}/agents/{agent}/grantscurl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents/agt_034ywLOuKYCjR5w5Q59KRz/grants \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "installation_id": "inst_0342dcXGvZf3hgl01YboFc", "tools": [ "tools" ], "approval_required": [ "approval required" ] }'
{
"data": {
"id": "grt_034SjUfhLzDVN3eZq1Ctck",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"installation_id": "inst_0342dcXGvZf3hgl01YboFc",
"tools": [
"tools"
],
"approval_required": [
"approval required"
],
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateGrant
wsWorkspaceIdrequiredagentAgentIdrequiredgrantGrantIdrequiredtoolsstring[]requiredapproval_requiredstring[]required200 with data: Grant
/v1/workspaces/{ws}/agents/{agent}/grants/{grant}curl -X PATCH https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents/agt_034ywLOuKYCjR5w5Q59KRz/grants/grt_034SjUfhLzDVN3eZq1Ctck \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "tools": [ "tools" ], "approval_required": [ "approval required" ] }'
{
"data": {
"id": "grt_034SjUfhLzDVN3eZq1Ctck",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"installation_id": "inst_0342dcXGvZf3hgl01YboFc",
"tools": [
"tools"
],
"approval_required": [
"approval required"
],
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keydeleteGrant
wsWorkspaceIdrequiredagentAgentIdrequiredgrantGrantIdrequired204 with an empty body
/v1/workspaces/{ws}/agents/{agent}/grants/{grant}curl -X DELETE https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents/agt_034ywLOuKYCjR5w5Q59KRz/grants/grt_034SjUfhLzDVN3eZq1Ctck \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
Console sessionAPI keylistAgentChannels
wsWorkspaceIdrequiredagentAgentIdrequired200 with data: AgentChannel[]
/v1/workspaces/{ws}/agents/{agent}/channelscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents/agt_034ywLOuKYCjR5w5Q59KRz/channels \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "agch_034ywLOukecaJAd2lugFUK",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"tools": [
"tools"
],
"approval_required": [
"approval required"
],
"audience": "origin",
"audience_conversations": [
"conv_034UNYVNxd3k7BFPdmTECW"
],
"persona": {
"name": "Acme Corp",
"avatar_url": "https://example.com/asset"
},
"answers_dms": true,
"answers_mentions": true,
"thread_follow_up": "off",
"agent_messages": "ignore",
"max_agent_hops": 1,
"mid_run": "steer",
"senders": "anyone",
"sender_list": [
"sender list"
],
"allow_automated": true,
"allow_external": true,
"reply_with_output": true,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyputAgentChannel
wsWorkspaceIdrequiredagentAgentIdrequiredchannel_connectionChannelConnectionIdrequiredtoolsstring[]requiredapproval_requiredstring[]requiredaudience"origin" | "listed" | "anywhere"requiredaudience_conversationsChannelConversationId[]requiredpersonaobject | nullrequiredanswers_dmsbooleanrequiredanswers_mentionsbooleanrequiredthread_follow_up"off" | "when_last_addressed" | "always"requiredagent_messages"ignore" | "mentions"requiredmax_agent_hopsintegerrequiredmid_run"steer" | "collect"requiredsenders"anyone" | "listed"requiredsender_liststring[]requiredallow_automatedbooleanrequiredallow_externalbooleanrequiredreply_with_outputbooleanrequired200 with data: AgentChannel
/v1/workspaces/{ws}/agents/{agent}/channels/{channel_connection}curl -X PUT https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents/agt_034ywLOuKYCjR5w5Q59KRz/channels/chcon_034UNYVNxd3k7NFOVSWyAe \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "tools": [ "tools" ], "approval_required": [ "approval required" ], "audience": "origin", "audience_conversations": [ "conv_034UNYVNxd3k7BFPdmTECW" ], "persona": { "name": "Acme Corp", "avatar_url": "https://example.com/asset" }, "answers_dms": true, "answers_mentions": true, "thread_follow_up": "off", "agent_messages": "ignore", "max_agent_hops": 1, "mid_run": "steer", "senders": "anyone", "sender_list": [ "sender list" ], "allow_automated": true, "allow_external": true, "reply_with_output": true }'
{
"data": {
"id": "agch_034ywLOukecaJAd2lugFUK",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"tools": [
"tools"
],
"approval_required": [
"approval required"
],
"audience": "origin",
"audience_conversations": [
"conv_034UNYVNxd3k7BFPdmTECW"
],
"persona": {
"name": "Acme Corp",
"avatar_url": "https://example.com/asset"
},
"answers_dms": true,
"answers_mentions": true,
"thread_follow_up": "off",
"agent_messages": "ignore",
"max_agent_hops": 1,
"mid_run": "steer",
"senders": "anyone",
"sender_list": [
"sender list"
],
"allow_automated": true,
"allow_external": true,
"reply_with_output": true,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keydeleteAgentChannel
wsWorkspaceIdrequiredagentAgentIdrequiredchannel_connectionChannelConnectionIdrequired204 with an empty body
/v1/workspaces/{ws}/agents/{agent}/channels/{channel_connection}curl -X DELETE https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/agents/agt_034ywLOuKYCjR5w5Q59KRz/channels/chcon_034UNYVNxd3k7NFOVSWyAe \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
Console sessionAPI keylistModelConnections
orgOrganizationIdrequiredenvironmentEnvironment422 environment_mismatch.200 with data: ModelConnection[]
/v1/organizations/{org}/model-connectionscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/model-connections \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "mcn_03408SQyg36Q8n8Bfr13fY",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"kind": "openai",
"label": "label",
"api_key": {
"set": true,
"last4": "last4",
"updated_at": null
},
"key_version": 1,
"status": "active",
"model_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}422 invalid_api_key; 501 model_providers_not_configured when the deployment reaches no model providers)Console sessionAPI keycreateModelConnection
orgOrganizationIdrequiredenvironmentEnvironmentrequiredkindModelProviderKindrequiredlabelstringrequiredapi_keystringrequired201 with data: ModelConnection
/v1/organizations/{org}/model-connectionscurl -X POST https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/model-connections \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "environment": "sandbox", "kind": "openai", "label": "label", "api_key": "api key" }'
{
"data": {
"id": "mcn_03408SQyg36Q8n8Bfr13fY",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"kind": "openai",
"label": "label",
"api_key": {
"set": true,
"last4": "last4",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"key_version": 1,
"status": "active",
"model_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetModelConnection
orgOrganizationIdrequiredconnectionModelConnectionIdrequired200 with data: ModelConnection
/v1/organizations/{org}/model-connections/{connection}curl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/model-connections/mcn_03408SQyg36Q8n8Bfr13fY \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "mcn_03408SQyg36Q8n8Bfr13fY",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"kind": "openai",
"label": "label",
"api_key": {
"set": true,
"last4": "last4",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"key_version": 1,
"status": "active",
"model_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateModelConnection
orgOrganizationIdrequiredconnectionModelConnectionIdrequiredlabelstringrequired200 with data: ModelConnection
/v1/organizations/{org}/model-connections/{connection}curl -X PATCH https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/model-connections/mcn_03408SQyg36Q8n8Bfr13fY \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "label": "label" }'
{
"data": {
"id": "mcn_03408SQyg36Q8n8Bfr13fY",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"kind": "openai",
"label": "label",
"api_key": {
"set": true,
"last4": "last4",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"key_version": 1,
"status": "active",
"model_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}409 model_in_use, naming them)Console sessionAPI keydeleteModelConnection
orgOrganizationIdrequiredconnectionModelConnectionIdrequired204 with an empty body
/v1/organizations/{org}/model-connections/{connection}curl -X DELETE https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/model-connections/mcn_03408SQyg36Q8n8Bfr13fY \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
422 invalid_api_key, keeping the old one; 501 model_providers_not_configured when the deployment reaches no model providers). 409 key_changed when another request replaced the key meanwhile: nothing changes, and the connection shows the newer keyConsole sessionAPI keyreplaceModelConnectionKey
orgOrganizationIdrequiredconnectionModelConnectionIdrequiredapi_keystringrequired200 with data: ModelConnection
/v1/organizations/{org}/model-connections/{connection}/api-keycurl -X PUT https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/model-connections/mcn_03408SQyg36Q8n8Bfr13fY/api-key \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "api_key": "api key" }'
{
"data": {
"id": "mcn_03408SQyg36Q8n8Bfr13fY",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"kind": "openai",
"label": "label",
"api_key": {
"set": true,
"last4": "last4",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"key_version": 1,
"status": "active",
"model_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}422 invalid_api_key when the provider refuses the key; 501 model_providers_not_configured when the deployment reaches no model providersConsole sessionAPI keylistProviderModels
orgOrganizationIdrequiredconnectionModelConnectionIdrequiredcursorstringlimitintegerqstring200 with data: ProviderModel[]
/v1/organizations/{org}/model-connections/{connection}/provider-modelscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/model-connections/mcn_03408SQyg36Q8n8Bfr13fY/provider-models \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"provider_model_id": "provider model id",
"name": "Acme Corp",
"author": "author",
"context_window": 1,
"supports_tools": true,
"pricing": {
"input_per_million_usd": 1,
"output_per_million_usd": 1
},
"added_model_id": "mdl_03408SQyGoiPsdqfQHVF9j"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistModels
orgOrganizationIdrequiredcursorstringlimitintegerenvironmentEnvironment422 environment_mismatch.connection_idModelConnectionIdqstring200 with data: Model[]
/v1/organizations/{org}/modelscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/models \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "mdl_03408SQyGoiPsdqfQHVF9j",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"route": {
"connection_id": "mcn_03408SQyg36Q8n8Bfr13fY",
"kind": null,
"label": "label"
},
"provider_model_id": "provider model id",
"name": "Acme Corp",
"author": "author",
"context_window": 1,
"supports_tools": true,
"status": "available",
"is_default": true,
"agent_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keycreateModel
orgOrganizationIdrequiredconnection_idModelConnectionIdrequiredprovider_model_idstringrequirednamestring201 with data: Model
/v1/organizations/{org}/modelscurl -X POST https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/models \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "connection_id": "mcn_03408SQyg36Q8n8Bfr13fY", "provider_model_id": "provider model id" }'
{
"data": {
"id": "mdl_03408SQyGoiPsdqfQHVF9j",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"route": {
"connection_id": "mcn_03408SQyg36Q8n8Bfr13fY",
"kind": "openai",
"label": "label"
},
"provider_model_id": "provider model id",
"name": "Acme Corp",
"author": "author",
"context_window": 1,
"supports_tools": true,
"status": "available",
"is_default": true,
"agent_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetModel
orgOrganizationIdrequiredmodelModelIdrequired200 with data: Model
/v1/organizations/{org}/models/{model}curl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/models/mdl_03408SQyGoiPsdqfQHVF9j \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "mdl_03408SQyGoiPsdqfQHVF9j",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"route": {
"connection_id": "mcn_03408SQyg36Q8n8Bfr13fY",
"kind": "openai",
"label": "label"
},
"provider_model_id": "provider model id",
"name": "Acme Corp",
"author": "author",
"context_window": 1,
"supports_tools": true,
"status": "available",
"is_default": true,
"agent_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateModel
orgOrganizationIdrequiredmodelModelIdrequirednamestringrequired200 with data: Model
/v1/organizations/{org}/models/{model}curl -X PATCH https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/models/mdl_03408SQyGoiPsdqfQHVF9j \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp" }'
{
"data": {
"id": "mdl_03408SQyGoiPsdqfQHVF9j",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"route": {
"connection_id": "mcn_03408SQyg36Q8n8Bfr13fY",
"kind": "openai",
"label": "label"
},
"provider_model_id": "provider model id",
"name": "Acme Corp",
"author": "author",
"context_window": 1,
"supports_tools": true,
"status": "available",
"is_default": true,
"agent_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}409 model_in_use, naming them)Console sessionAPI keydeleteModel
orgOrganizationIdrequiredmodelModelIdrequired204 with an empty body
/v1/organizations/{org}/models/{model}curl -X DELETE https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/models/mdl_03408SQyGoiPsdqfQHVF9j \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
Console sessionAPI keygetDefaultModel
orgOrganizationIdrequiredenvEnvironmentrequired200 with data: DefaultModel
/v1/organizations/{org}/default-models/{env}curl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/default-models/sandbox \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"environment": "sandbox",
"model": {
"id": "mdl_03408SQyGoiPsdqfQHVF9j",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"route": {
"connection_id": null,
"kind": null,
"label": null
},
"provider_model_id": "provider model id",
"name": "Acme Corp",
"author": "author",
"context_window": 1,
"supports_tools": true,
"status": "available",
"is_default": true,
"agent_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateDefaultModel
orgOrganizationIdrequiredenvEnvironmentrequiredmodel_idModelId | nullrequired200 with data: DefaultModel
/v1/organizations/{org}/default-models/{env}curl -X PUT https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/default-models/sandbox \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model_id": "mdl_03408SQyGoiPsdqfQHVF9j" }'
{
"data": {
"environment": "sandbox",
"model": {
"id": "mdl_03408SQyGoiPsdqfQHVF9j",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"route": {
"connection_id": null,
"kind": null,
"label": null
},
"provider_model_id": "provider model id",
"name": "Acme Corp",
"author": "author",
"context_window": 1,
"supports_tools": true,
"status": "available",
"is_default": true,
"agent_count": 3,
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionlistApiKeys
orgOrganizationIdrequired200 with data: ApiKey[]
/v1/organizations/{org}/api-keyscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/api-keys \ -H "Authorization: Bearer $CONSOLE_TOKEN"
{
"data": [
{
"id": "key_034yLYwVHYXQfyatXcnofQ",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"name": "Acme Corp",
"prefix": "prefix",
"last4": "last4",
"created_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
},
"created_at": "2026-10-04T21:04:11.000Z",
"last_used_at": "2026-10-04T21:04:11.000Z",
"revoked_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionShows a secret oncecreateApiKey
orgOrganizationIdrequirednamestringrequiredenvironmentEnvironmentrequired201 with data: CreatedApiKey
/v1/organizations/{org}/api-keyscurl -X POST https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/api-keys \ -H "Authorization: Bearer $CONSOLE_TOKEN" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Corp", "environment": "sandbox" }'
{
"data": {
"key": {
"id": "key_034yLYwVHYXQfyatXcnofQ",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"name": "Acme Corp",
"prefix": "prefix",
"last4": "last4",
"created_by": {
"id": null,
"name": null,
"email": null,
"avatar_url": null
},
"created_at": "2026-10-04T21:04:11.000Z",
"last_used_at": "2026-10-04T21:04:11.000Z",
"revoked_at": "2026-10-04T21:04:11.000Z"
},
"secret": "secret"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionrevokeApiKey
orgOrganizationIdrequiredkeyApiKeyIdrequired200 with data: ApiKey
/v1/organizations/{org}/api-keys/{key}/revokecurl -X POST https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/api-keys/key_034yLYwVHYXQfyatXcnofQ/revoke \ -H "Authorization: Bearer $CONSOLE_TOKEN" \ -H "Idempotency-Key: $(uuidgen)"
{
"data": {
"id": "key_034yLYwVHYXQfyatXcnofQ",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"name": "Acme Corp",
"prefix": "prefix",
"last4": "last4",
"created_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
},
"created_at": "2026-10-04T21:04:11.000Z",
"last_used_at": "2026-10-04T21:04:11.000Z",
"revoked_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistWebhooks
orgOrganizationIdrequired200 with data: WebhookEndpoint[]
/v1/organizations/{org}/webhookscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/webhooks \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "we_034aaypc8ldh0aAtyCQsOd",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"url": "https://example.com/zupflow/webhooks",
"description": "Lists the issues assigned to you.",
"events": [
"installation.connected"
],
"enabled": true,
"signing_secret_last4": "signing secret last4",
"previous_signing_secret_expires_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z",
"last_delivery": {
"status_code": 1,
"delivered_at": null
}
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyShows a secret oncecreateWebhook
orgOrganizationIdrequiredenvironmentEnvironmentrequiredurlstringrequireddescriptionstringrequiredevents"installation.connected" | "installation.reconnect_required" | "installation.disconnected" | "connect_session.completed" | …[]required201 with data: CreatedWebhookEndpoint
/v1/organizations/{org}/webhookscurl -X POST https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/webhooks \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "environment": "sandbox", "url": "https://example.com/zupflow/webhooks", "description": "Lists the issues assigned to you.", "events": [ "installation.connected" ] }'
{
"data": {
"endpoint": {
"id": "we_034aaypc8ldh0aAtyCQsOd",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"url": "https://example.com/zupflow/webhooks",
"description": "Lists the issues assigned to you.",
"events": [
"installation.connected"
],
"enabled": true,
"signing_secret_last4": "signing secret last4",
"previous_signing_secret_expires_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z",
"last_delivery": {
"status_code": null,
"delivered_at": null
}
},
"signing_secret": "signing secret"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateWebhook
orgOrganizationIdrequiredhookWebhookEndpointIdrequiredurlstringdescriptionstringevents"installation.connected" | "installation.reconnect_required" | "installation.disconnected" | "connect_session.completed" | …[]enabledboolean200 with data: WebhookEndpoint
/v1/organizations/{org}/webhooks/{hook}curl -X PATCH https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/webhooks/we_034aaypc8ldh0aAtyCQsOd \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "url": "https://example.com/zupflow/webhooks", "description": "Lists the issues assigned to you." }'
{
"data": {
"id": "we_034aaypc8ldh0aAtyCQsOd",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"url": "https://example.com/zupflow/webhooks",
"description": "Lists the issues assigned to you.",
"events": [
"installation.connected"
],
"enabled": true,
"signing_secret_last4": "signing secret last4",
"previous_signing_secret_expires_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z",
"last_delivery": {
"status_code": 1,
"delivered_at": "2026-10-04T21:04:11.000Z"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keydeleteWebhook
orgOrganizationIdrequiredhookWebhookEndpointIdrequired204 with an empty body
/v1/organizations/{org}/webhooks/{hook}curl -X DELETE https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/webhooks/we_034aaypc8ldh0aAtyCQsOd \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
409 rotation_in_progress, even with a fresh idempotency key. Replaying a successful key is 409 idempotency_key_completed and never returns the secret again. A missing or foreign endpoint is 404. Records webhook.secret_rolled against the existing webhook endpoint, with no workspace and the endpoint's environment.Console sessionAPI keyShows a secret oncerollWebhookSecret
orgOrganizationIdrequiredhookWebhookEndpointIdrequired200 with data: CreatedWebhookEndpoint
/v1/organizations/{org}/webhooks/{hook}/roll-secretcurl -X POST https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/webhooks/we_034aaypc8ldh0aAtyCQsOd/roll-secret \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)"
{
"data": {
"endpoint": {
"id": "we_034aaypc8ldh0aAtyCQsOd",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"environment": "sandbox",
"url": "https://example.com/zupflow/webhooks",
"description": "Lists the issues assigned to you.",
"events": [
"installation.connected"
],
"enabled": true,
"signing_secret_last4": "signing secret last4",
"previous_signing_secret_expires_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z",
"last_delivery": {
"status_code": null,
"delivered_at": null
}
},
"signing_secret": "signing secret"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}400 validation_failed.Console sessionAPI keylistWebhookDeliveries
orgOrganizationIdrequiredhookWebhookEndpointIdrequiredcursorstringlimitintegerworkspace_idWorkspaceIdstate"pending" | "succeeded" | "failed" | "skipped"event_type"installation.connected" | "installation.reconnect_required" | "installation.disconnected" | "connect_session.completed" | …200 with data: WebhookDeliverySummary[]
/v1/organizations/{org}/webhooks/{hook}/deliveriescurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/webhooks/we_034aaypc8ldh0aAtyCQsOd/deliveries \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "whd_034aaypc8ls1iTqrkdnjhu",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"endpoint_id": "we_034aaypc8ldh0aAtyCQsOd",
"event_id": "evt_034aaypc8lddlN2hmXT90h",
"environment": "sandbox",
"event_type": "installation.connected",
"event_created_at": "2026-10-04T21:04:11.000Z",
"workspace": {
"id": "ws_034a8swzUzvsQ2inuZzZfA",
"external_id": "cus_1042"
},
"state": "pending",
"attempts": 1,
"last_status_code": 100,
"last_error": "status",
"last_attempt_at": "2026-10-04T21:04:11.000Z",
"next_attempt_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}404. Older deliveries may have incomplete attempt history; response bodies, request headers and signatures are never returned.Console sessionAPI keygetWebhookDelivery
orgOrganizationIdrequiredhookWebhookEndpointIdrequireddeliveryWebhookDeliveryIdrequired200 with data: WebhookDeliveryDetail
/v1/organizations/{org}/webhooks/{hook}/deliveries/{delivery}curl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/webhooks/we_034aaypc8ldh0aAtyCQsOd/deliveries/whd_034aaypc8ls1iTqrkdnjhu \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "whd_034aaypc8ls1iTqrkdnjhu",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"endpoint_id": "we_034aaypc8ldh0aAtyCQsOd",
"event_id": "evt_034aaypc8lddlN2hmXT90h",
"environment": "sandbox",
"event_type": "installation.connected",
"event_created_at": "2026-10-04T21:04:11.000Z",
"workspace": {
"id": "ws_034a8swzUzvsQ2inuZzZfA",
"external_id": "cus_1042"
},
"state": "pending",
"attempts": 1,
"last_status_code": 100,
"last_error": "status",
"last_attempt_at": "2026-10-04T21:04:11.000Z",
"next_attempt_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z",
"event": {
"id": "evt_034aaypc8lddlN2hmXT90h",
"created_at": null,
"environment": null,
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"type": "installation.connected",
"workspace": null,
"data": {
"object": null,
"id": null,
"app_id": null,
"status": null
}
},
"attempt_history_complete": true
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}400 validation_failed. Historical summary-only attempts are not fabricated.Console sessionAPI keylistWebhookDeliveryAttempts
orgOrganizationIdrequiredhookWebhookEndpointIdrequireddeliveryWebhookDeliveryIdrequiredcursorstringlimitinteger200 with data: WebhookDeliveryAttempt[]
/v1/organizations/{org}/webhooks/{hook}/deliveries/{delivery}/attemptscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/webhooks/we_034aaypc8ldh0aAtyCQsOd/deliveries/whd_034aaypc8ls1iTqrkdnjhu/attempts \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"number": 1,
"status_code": 100,
"error_class": "status",
"attempted_at": "2026-10-04T21:04:11.000Z",
"duration_ms": 1
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}409 delivery_pending, a disabled endpoint 409 webhook_disabled, and one no longer subscribed 409 webhook_not_subscribed; webhook.test is exempt from subscriptions. A missing, foreign or wrong-endpoint delivery is 404. Normal POST idempotency applies. Records webhook.delivery_resent against the new webhook_delivery, attributed to the event's workspace and environment.Console sessionAPI keyresendWebhookDelivery
orgOrganizationIdrequiredhookWebhookEndpointIdrequireddeliveryWebhookDeliveryIdrequired201 with data: WebhookDeliverySummary
/v1/organizations/{org}/webhooks/{hook}/deliveries/{delivery}/resendcurl -X POST https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/webhooks/we_034aaypc8ldh0aAtyCQsOd/deliveries/whd_034aaypc8ls1iTqrkdnjhu/resend \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)"
{
"data": {
"id": "whd_034aaypc8ls1iTqrkdnjhu",
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"endpoint_id": "we_034aaypc8ldh0aAtyCQsOd",
"event_id": "evt_034aaypc8lddlN2hmXT90h",
"environment": "sandbox",
"event_type": "installation.connected",
"event_created_at": "2026-10-04T21:04:11.000Z",
"workspace": {
"id": "ws_034a8swzUzvsQ2inuZzZfA",
"external_id": "cus_1042"
},
"state": "pending",
"attempts": 1,
"last_status_code": 100,
"last_error": "status",
"last_attempt_at": "2026-10-04T21:04:11.000Z",
"next_attempt_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keytestWebhook
orgOrganizationIdrequiredhookWebhookEndpointIdrequired200 with data: WebhookDelivery
/v1/organizations/{org}/webhooks/{hook}/testcurl -X POST https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/webhooks/we_034aaypc8ldh0aAtyCQsOd/test \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)"
{
"data": {
"status_code": 1,
"delivered_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistChannelAppManagers
wsWorkspaceIdrequiredcursorstringlimitinteger200 with data: ChannelAppManager[]
/v1/workspaces/{ws}/channel-app-managerscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-app-managers \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "chmgr_034UNYVNxdX7o7BFB4Y0u2",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"provider": "slack",
"method": "configuration_token",
"team": {
"id": "id",
"name": "Acme Corp"
},
"status": "active",
"configuration_token": {
"set": true,
"last4": "last4",
"updated_at": null
},
"token_expires_at": "2026-10-04T21:04:11.000Z",
"app_count": 3,
"created_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
},
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}403 console_read_only_in_production). A token the provider refuses is 422 invalid_configuration_tokenConsole sessionAPI keycreateChannelAppManager
wsWorkspaceIdrequiredproviderChannelProviderrequiredmethod"configuration_token"requiredconfiguration_tokenstringrequiredrefresh_tokenstringrequired201 with data: ChannelAppManager
/v1/workspaces/{ws}/channel-app-managerscurl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-app-managers \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "provider": "slack", "method": "configuration_token", "configuration_token": "configuration token", "refresh_token": "refresh token" }'
{
"data": {
"id": "chmgr_034UNYVNxdX7o7BFB4Y0u2",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"provider": "slack",
"method": "configuration_token",
"team": {
"id": "id",
"name": "Acme Corp"
},
"status": "active",
"configuration_token": {
"set": true,
"last4": "last4",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"token_expires_at": "2026-10-04T21:04:11.000Z",
"app_count": 3,
"created_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
},
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetChannelAppManager
wsWorkspaceIdrequiredmanagerChannelAppManagerIdrequired200 with data: ChannelAppManager
/v1/workspaces/{ws}/channel-app-managers/{manager}curl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-app-managers/chmgr_034UNYVNxdX7o7BFB4Y0u2 \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "chmgr_034UNYVNxdX7o7BFB4Y0u2",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"provider": "slack",
"method": "configuration_token",
"team": {
"id": "id",
"name": "Acme Corp"
},
"status": "active",
"configuration_token": {
"set": true,
"last4": "last4",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"token_expires_at": "2026-10-04T21:04:11.000Z",
"app_count": 3,
"created_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
},
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}active again. Developers and API keys; the Console can't in ProductionConsole sessionAPI keyupdateChannelAppManager
wsWorkspaceIdrequiredmanagerChannelAppManagerIdrequiredconfiguration_tokenstringrequiredrefresh_tokenstringrequired200 with data: ChannelAppManager
/v1/workspaces/{ws}/channel-app-managers/{manager}curl -X PATCH https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-app-managers/chmgr_034UNYVNxdX7o7BFB4Y0u2 \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "configuration_token": "configuration token", "refresh_token": "refresh token" }'
{
"data": {
"id": "chmgr_034UNYVNxdX7o7BFB4Y0u2",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"provider": "slack",
"method": "configuration_token",
"team": {
"id": "id",
"name": "Acme Corp"
},
"status": "active",
"configuration_token": {
"set": true,
"last4": "last4",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"token_expires_at": "2026-10-04T21:04:11.000Z",
"app_count": 3,
"created_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
},
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}409 in_useConsole sessionAPI keydeleteChannelAppManager
wsWorkspaceIdrequiredmanagerChannelAppManagerIdrequired204 with an empty body
/v1/workspaces/{ws}/channel-app-managers/{manager}curl -X DELETE https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-app-managers/chmgr_034UNYVNxdX7o7BFB4Y0u2 \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
Console sessionAPI keylistChannelApps
wsWorkspaceIdrequiredcursorstringlimitintegeragent_idAgentIdmanager_idChannelAppManagerId200 with data: ChannelApp[]
/v1/workspaces/{ws}/channel-appscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-apps \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "chapp_034UNYVNxdX7o9Sp4Z0kCa",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"manager_id": "chmgr_034UNYVNxdX7o7BFB4Y0u2",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"provider": "slack",
"external_app_id": "external app id",
"status": "creating",
"last_error": "last error",
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}202 with the app creating; a job makes it with the provider. Developers and API keys; the Console can't in ProductionConsole sessionAPI keycreateChannelApp
wsWorkspaceIdrequiredagent_idAgentIdrequiredmanager_idChannelAppManagerIdrequired202 with data: ChannelApp
/v1/workspaces/{ws}/channel-appscurl -X POST https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-apps \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "agent_id": "agt_034ywLOuKYCjR5w5Q59KRz", "manager_id": "chmgr_034UNYVNxdX7o7BFB4Y0u2" }'
{
"data": {
"id": "chapp_034UNYVNxdX7o9Sp4Z0kCa",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"manager_id": "chmgr_034UNYVNxdX7o7BFB4Y0u2",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"provider": "slack",
"external_app_id": "external app id",
"status": "creating",
"last_error": "last error",
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}404Console sessionAPI keygetChannelApp
wsWorkspaceIdrequiredappChannelAppIdrequired200 with data: ChannelApp
/v1/workspaces/{ws}/channel-apps/{app}curl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-apps/chapp_034UNYVNxdX7o9Sp4Z0kCa \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "chapp_034UNYVNxdX7o9Sp4Z0kCa",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"manager_id": "chmgr_034UNYVNxdX7o7BFB4Y0u2",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"provider": "slack",
"external_app_id": "external app id",
"status": "creating",
"last_error": "last error",
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keydeleteChannelApp
wsWorkspaceIdrequiredappChannelAppIdrequired204 with an empty body
/v1/workspaces/{ws}/channel-apps/{app}curl -X DELETE https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-apps/chapp_034UNYVNxdX7o9Sp4Z0kCa \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
Console sessionAPI keylistChannelConnections
wsWorkspaceIdrequiredcursorstringlimitintegeragent_idAgentId200 with data: ChannelConnection[]
/v1/workspaces/{ws}/channel-connectionscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-connections \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"provider": "slack",
"app_id": "chapp_034UNYVNxdX7o9Sp4Z0kCa",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"short_id": "k7qmxa",
"label": "label",
"handler": "mention",
"status": "connected",
"team": {
"id": "id",
"name": "Acme Corp",
"enterprise_id": "enterprise id"
},
"identity": {
"external_id": "cus_1042",
"handle": "handle"
},
"granted_scopes": [
"granted scopes"
],
"connected_at": "2026-10-04T21:04:11.000Z",
"last_event_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetChannelConnection
wsWorkspaceIdrequiredchannel_connectionChannelConnectionIdrequired200 with data: ChannelConnection
/v1/workspaces/{ws}/channel-connections/{channel_connection}curl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-connections/chcon_034UNYVNxd3k7NFOVSWyAe \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"provider": "slack",
"app_id": "chapp_034UNYVNxdX7o9Sp4Z0kCa",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"short_id": "k7qmxa",
"label": "label",
"handler": "mention",
"status": "connected",
"team": {
"id": "id",
"name": "Acme Corp",
"enterprise_id": "enterprise id"
},
"identity": {
"external_id": "cus_1042",
"handle": "handle"
},
"granted_scopes": [
"granted scopes"
],
"connected_at": "2026-10-04T21:04:11.000Z",
"last_event_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keyupdateChannelConnection
wsWorkspaceIdrequiredchannel_connectionChannelConnectionIdrequiredlabelstringhandler"mention"200 with data: ChannelConnection
/v1/workspaces/{ws}/channel-connections/{channel_connection}curl -X PATCH https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-connections/chcon_034UNYVNxd3k7NFOVSWyAe \ -H "Authorization: Bearer $ZUPFLOW_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "label": "label", "handler": "mention" }'
{
"data": {
"id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"provider": "slack",
"app_id": "chapp_034UNYVNxdX7o9Sp4Z0kCa",
"agent_id": "agt_034ywLOuKYCjR5w5Q59KRz",
"short_id": "k7qmxa",
"label": "label",
"handler": "mention",
"status": "connected",
"team": {
"id": "id",
"name": "Acme Corp",
"enterprise_id": "enterprise id"
},
"identity": {
"external_id": "cus_1042",
"handle": "handle"
},
"granted_scopes": [
"granted scopes"
],
"connected_at": "2026-10-04T21:04:11.000Z",
"last_event_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z",
"updated_at": "2026-10-04T21:04:11.000Z"
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keydeleteChannelConnection
wsWorkspaceIdrequiredchannel_connectionChannelConnectionIdrequired204 with an empty body
/v1/workspaces/{ws}/channel-connections/{channel_connection}curl -X DELETE https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-connections/chcon_034UNYVNxd3k7NFOVSWyAe \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
q searches namesConsole sessionAPI keylistChannelConversations
wsWorkspaceIdrequiredchannel_connectionChannelConnectionIdrequiredcursorstringlimitintegerqstringkind"channel" | "private_channel" | "dm" | "group_dm"200 with data: ChannelConversation[]
/v1/workspaces/{ws}/channel-connections/{channel_connection}/conversationscurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-connections/chcon_034UNYVNxd3k7NFOVSWyAe/conversations \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "conv_034UNYVNxd3k7BFPdmTECW",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"external_id": "cus_1042",
"kind": "channel",
"name": "Acme Corp",
"is_external": true,
"identity_is_member": true,
"last_message_at": "2026-10-04T21:04:11.000Z",
"paused_until": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}thread keeps one thread'sConsole sessionAPI keylistChannelMessages
wsWorkspaceIdrequiredchannel_connectionChannelConnectionIdrequiredconversationChannelConversationIdrequiredcursorstringlimitintegerthreadstring200 with data: ChannelMessage[]
/v1/workspaces/{ws}/channel-connections/{channel_connection}/conversations/{conversation}/messagescurl https://zupflow.example.com/v1/workspaces/ws_034a8swzUzvsQ2inuZzZfA/channel-connections/chcon_034UNYVNxd3k7NFOVSWyAe/conversations/conv_034UNYVNxd3k7BFPdmTECW/messages \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"id": "chmsg_034UNYVNxdRCAxtYiHCvOx",
"workspace_id": "ws_034a8swzUzvsQ2inuZzZfA",
"connection_id": "chcon_034UNYVNxd3k7NFOVSWyAe",
"conversation_id": "conv_034UNYVNxd3k7BFPdmTECW",
"external_id": "cus_1042",
"thread_key": "thread key",
"direction": "inbound",
"author": {
"id": "person_034UNYVNxdef4lbZTpLVrR",
"handle": "handle",
"display_name": "display name",
"is_automated": true
},
"text": "text",
"mentions": [
"mentions"
],
"run_id": "run_034NRN3tk3efa42EcmTqpS",
"tool_call_id": "call_034ptAVGI4F0rFleDY0wrs",
"agent_hop": 1,
"sent_at": "2026-10-04T21:04:11.000Z",
"edited_at": "2026-10-04T21:04:11.000Z",
"deleted_at": "2026-10-04T21:04:11.000Z",
"created_at": "2026-10-04T21:04:11.000Z"
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keylistChannelToolLevels
orgOrganizationIdrequired200 with data: ChannelToolLevel[]
/v1/organizations/{org}/channel-tool-levelscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/channel-tool-levels \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": [
{
"provider": "slack",
"tool": "list_issues",
"level": "allow",
"confirmed": true,
"effect": "read",
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionupdateChannelToolLevels
orgOrganizationIdrequiredproviderChannelProviderrequiredlevelsobject[]required200 with data: ChannelToolLevel[]
/v1/organizations/{org}/channel-tool-levelscurl -X PUT https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/channel-tool-levels \ -H "Authorization: Bearer $CONSOLE_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "provider": "slack", "levels": [ { "tool": "list_issues", "level": "allow" } ] }'
{
"data": [
{
"provider": "slack",
"tool": "list_issues",
"level": "allow",
"confirmed": true,
"effect": "read",
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
}
],
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionAPI keygetChannelSettings
orgOrganizationIdrequired200 with data: ChannelSettings
/v1/organizations/{org}/channel-settingscurl https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/channel-settings \ -H "Authorization: Bearer $ZUPFLOW_API_KEY"
{
"data": {
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"breaker_runs": 1,
"breaker_window_minutes": 1,
"breaker_pause_minutes": 1,
"message_retention_days": 1,
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}Console sessionupdateChannelSettings
orgOrganizationIdrequiredbreaker_runsintegerrequiredbreaker_window_minutesintegerrequiredbreaker_pause_minutesintegerrequiredmessage_retention_daysintegerrequired200 with data: ChannelSettings
/v1/organizations/{org}/channel-settingscurl -X PUT https://zupflow.example.com/v1/organizations/org_034WrceamQGAwHgTod2dHN/channel-settings \ -H "Authorization: Bearer $CONSOLE_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "breaker_runs": 1, "breaker_window_minutes": 1, "breaker_pause_minutes": 1, "message_retention_days": 1 }'
{
"data": {
"organization_id": "org_034WrceamQGAwHgTod2dHN",
"breaker_runs": 1,
"breaker_window_minutes": 1,
"breaker_pause_minutes": 1,
"message_retention_days": 1,
"updated_at": "2026-10-04T21:04:11.000Z",
"updated_by": {
"id": "usr_0344un49YpnirMXyqfkTed",
"name": "Acme Corp",
"email": "ada@example.com",
"avatar_url": "https://example.com/asset"
}
},
"meta": {
"pagination": {
"next_cursor": null,
"total": 3
}
},
"error": null
}X-Slack-Signature, X-Slack-Request-Timestamp) with the app's signing secret: an unknown reference, a bad signature or a timestamp more than five minutes off is 401, before anything is stored. A delivery seen before (by its event ID) is answered again without effect. Not idempotency-keyed: the provider's event ID is the keyproviderreceiveChannelEvent
inbound_refstringrequiredtypestringrequired200 with an empty body
/channels/inbound/{inbound_ref}curl -X POST https://zupflow.example.com/channels/inbound/inbound ref \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "type": "type" }'
{
"challenge": "challenge"
}