{ "info": { "name": "Syncon One API", "description": "Every endpoint of the Syncon One REST API, made from its OpenAPI document.\n\nSet the `apiKey` collection variable to a key from Settings, API (it starts with `sk_live_`). Keep it in the collection's *current value* so it is not shared. Docs: https://synconone.com/docs/public-api", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://synconone.com/api/v1", "type": "string" }, { "key": "apiKey", "value": "", "type": "secret" } ], "item": [ { "name": "Companies", "description": "Accounts: the organisations you sell to or support.", "item": [ { "name": "List companies", "request": { "method": "GET", "description": "Needs scope `companies:read`.", "header": [], "url": { "raw": "{{baseUrl}}/companies", "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [ { "key": "limit", "value": "25", "description": "Page size, at most 100.", "disabled": true }, { "key": "cursor", "value": "string", "description": "`pagination.nextCursor` from the previous page.", "disabled": true }, { "key": "sort", "value": "-updated_at", "description": "Sort order. A leading minus sorts descending.", "disabled": true }, { "key": "updated_since", "value": "2026-11-05T10:00:00Z", "description": "Only records updated at or after this instant.", "disabled": true }, { "key": "q", "value": "string", "description": "Free-text search over the object's main columns.", "disabled": true }, { "key": "domain", "value": "example.com", "description": "Only records whose domain equals this.", "disabled": true }, { "key": "industry", "value": "string", "description": "Only records whose industry equals this.", "disabled": true }, { "key": "lifecycle_stage", "value": "string", "description": "Only records whose lifecycle_stage equals this.", "disabled": true }, { "key": "owner", "value": "string", "description": "Only records whose owner equals this.", "disabled": true }, { "key": "country", "value": "string", "description": "Only records whose country equals this.", "disabled": true }, { "key": "tier", "value": "string", "description": "Only records whose tier equals this.", "disabled": true } ], "variable": [] } }, "response": [] }, { "name": "Create a company", "request": { "method": "POST", "description": "Built-in and custom fields by key. Relations take public ids.\n\nNeeds scope `companies:write`.", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string. Retrying with the same key replays the first answer.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies", "host": [ "{{baseUrl}}" ], "path": [ "companies" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Emily Carter\",\n \"domain\": \"example.com\",\n \"website\": \"https://example.com\",\n \"industry\": \"string\",\n \"employee_count\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a company", "request": { "method": "GET", "description": "Needs scope `companies:read`.", "header": [], "url": { "raw": "{{baseUrl}}/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the company." } ] } }, "response": [] }, { "name": "Update a company", "request": { "method": "PATCH", "description": "Only the keys sent are changed. Fields are applied in order; the first refusal stops the request and `details.applied` lists what was already changed.\n\nNeeds scope `companies:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the company." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Emily Carter\",\n \"domain\": \"example.com\",\n \"website\": \"https://example.com\",\n \"industry\": \"string\",\n \"employee_count\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Archive a company", "request": { "method": "DELETE", "description": "Archives the record (it can be restored in the app). Nothing is destroyed.\n\nNeeds scope `companies:write`.", "header": [], "url": { "raw": "{{baseUrl}}/companies/:id", "host": [ "{{baseUrl}}" ], "path": [ "companies", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the company." } ] } }, "response": [] } ] }, { "name": "Custom objects", "description": "Records of the objects your workspace defines for itself.", "item": [ { "name": "List records of a custom object", "request": { "method": "GET", "description": "Needs scope `records:read`.", "header": [], "url": { "raw": "{{baseUrl}}/objects/:slug/records", "host": [ "{{baseUrl}}" ], "path": [ "objects", ":slug", "records" ], "query": [ { "key": "limit", "value": "25", "description": "Page size, at most 100.", "disabled": true }, { "key": "cursor", "value": "string", "description": "`pagination.nextCursor` from the previous page.", "disabled": true }, { "key": "sort", "value": "-updated_at", "description": "Sort order. A leading minus sorts descending.", "disabled": true }, { "key": "updated_since", "value": "2026-11-05T10:00:00Z", "description": "Only records updated at or after this instant.", "disabled": true }, { "key": "q", "value": "string", "description": "Free-text search over the object's main columns.", "disabled": true }, { "key": "owner", "value": "string", "description": "Only records whose owner equals this.", "disabled": true } ], "variable": [ { "key": "slug", "value": "string", "description": "The custom object's slug, as shown in CRM settings." } ] } }, "response": [] }, { "name": "Create a custom object record", "request": { "method": "POST", "description": "Needs scope `records:write`.", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string. Retrying with the same key replays the first answer.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/objects/:slug/records", "host": [ "{{baseUrl}}" ], "path": [ "objects", ":slug", "records" ], "query": [], "variable": [ { "key": "slug", "value": "string", "description": "The custom object's slug, as shown in CRM settings." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Emily Carter\",\n \"owner\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a custom object record", "request": { "method": "GET", "description": "Needs scope `records:read`.", "header": [], "url": { "raw": "{{baseUrl}}/objects/:slug/records/:id", "host": [ "{{baseUrl}}" ], "path": [ "objects", ":slug", "records", ":id" ], "query": [], "variable": [ { "key": "slug", "value": "string", "description": "The custom object's slug, as shown in CRM settings." }, { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the record." } ] } }, "response": [] }, { "name": "Update a custom object record", "request": { "method": "PATCH", "description": "Needs scope `records:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/objects/:slug/records/:id", "host": [ "{{baseUrl}}" ], "path": [ "objects", ":slug", "records", ":id" ], "query": [], "variable": [ { "key": "slug", "value": "string", "description": "The custom object's slug, as shown in CRM settings." }, { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the record." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Emily Carter\",\n \"owner\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Archive a custom object record", "request": { "method": "DELETE", "description": "Needs scope `records:write`.", "header": [], "url": { "raw": "{{baseUrl}}/objects/:slug/records/:id", "host": [ "{{baseUrl}}" ], "path": [ "objects", ":slug", "records", ":id" ], "query": [], "variable": [ { "key": "slug", "value": "string", "description": "The custom object's slug, as shown in CRM settings." }, { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the record." } ] } }, "response": [] } ] }, { "name": "Evidence", "description": "What the workspace knows about a record, and where it came from.", "item": [ { "name": "List evidence on a record", "request": { "method": "GET", "description": "Newest first. Private evidence is never returned; metadata-only evidence has `title` and `content` null.\n\nNeeds scope `evidence:read`.", "header": [], "url": { "raw": "{{baseUrl}}/evidence", "host": [ "{{baseUrl}}" ], "path": [ "evidence" ], "query": [ { "key": "record_type", "value": "person", "description": "", "disabled": false }, { "key": "record_id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "", "disabled": false }, { "key": "kinds", "value": "string", "description": "Comma-separated evidence kinds.", "disabled": true }, { "key": "limit", "value": "25", "description": "Page size, at most 100.", "disabled": true }, { "key": "cursor", "value": "string", "description": "`pagination.nextCursor` from the previous page.", "disabled": true } ], "variable": [] } }, "response": [] }, { "name": "Get one piece of evidence", "request": { "method": "GET", "description": "Needs scope `evidence:read`.", "header": [], "url": { "raw": "{{baseUrl}}/evidence/:id", "host": [ "{{baseUrl}}" ], "path": [ "evidence", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Evidence id." } ] } }, "response": [] } ] }, { "name": "Inbox", "description": "The live chat inbox: read conversations, take them over from the AI agent, reply, hand back.", "item": [ { "name": "List conversations in the inbox", "request": { "method": "GET", "description": "The live chat queue, most recently active first. Not pageable: narrow with view, q, responder, priority or tag.\n\nNeeds scope `conversations:read`.", "header": [], "url": { "raw": "{{baseUrl}}/conversations", "host": [ "{{baseUrl}}" ], "path": [ "conversations" ], "query": [ { "key": "view", "value": "all", "description": "", "disabled": true }, { "key": "q", "value": "string", "description": "Search the visitor, site and messages.", "disabled": true }, { "key": "responder", "value": "ai", "description": "", "disabled": true }, { "key": "priority", "value": "none", "description": "", "disabled": true }, { "key": "tag", "value": "string", "description": "A tag name.", "disabled": true }, { "key": "limit", "value": "25", "description": "Page size, at most 80.", "disabled": true } ], "variable": [] } }, "response": [] }, { "name": "Get a conversation", "request": { "method": "GET", "description": "Who is answering, who holds it, and whether the acting teammate may reply.\n\nNeeds scope `conversations:read`.", "header": [], "url": { "raw": "{{baseUrl}}/conversations/:id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the conversation, conv_…" } ] } }, "response": [] }, { "name": "Change a conversation's owner, priority or tags", "request": { "method": "PATCH", "description": "Needs scope `conversations:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/conversations/:id", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the conversation, conv_…" } ] }, "body": { "mode": "raw", "raw": "{\n \"priority\": \"none\",\n \"assignee\": \"string\",\n \"add_tags\": [\n \"string\"\n ],\n \"remove_tags\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Read a conversation's messages", "request": { "method": "GET", "description": "The thread as the team sees it, oldest first, with system lines such as joins. Poll with `after` set to the last cursor to follow it live. Reading does not mark it read.\n\nNeeds scope `conversations:read`.", "header": [], "url": { "raw": "{{baseUrl}}/conversations/:id/messages", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":id", "messages" ], "query": [ { "key": "after", "value": "0", "description": "Only messages after this cursor. 0 starts at the beginning.", "disabled": true }, { "key": "limit", "value": "50", "description": "At most 100.", "disabled": true } ], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the conversation, conv_…" } ] } }, "response": [] }, { "name": "Take a conversation over from the AI agent", "request": { "method": "POST", "description": "The visitor sees a teammate arrive. Refused with 409 when another teammate already has it. Do this before replying.\n\nNeeds scope `conversations:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/conversations/:id/join", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":id", "join" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the conversation, conv_…" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Reply to the visitor", "request": { "method": "POST", "description": "Sends a message the visitor reads at once, as the teammate the key stands for. The conversation must be joined first (409 otherwise). Sending the same client_message_id twice posts once.\n\nNeeds scope `conversations:write`.", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string. Retrying with the same key replays the first answer.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/conversations/:id/reply", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":id", "reply" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the conversation, conv_…" } ] }, "body": { "mode": "raw", "raw": "{\n \"text\": \"Asked about annual terms on the website.\",\n \"reply_to\": 1,\n \"client_message_id\": \"pr_1a2b3c4d5e6f7a8b\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Hand a conversation back to the AI agent", "request": { "method": "POST", "description": "Only the teammate who holds it can. The agent carries on from where the human left off.\n\nNeeds scope `conversations:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/conversations/:id/return-to-ai", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":id", "return-to-ai" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the conversation, conv_…" } ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List a conversation's internal notes", "request": { "method": "GET", "description": "Notes only the team sees, newest first.\n\nNeeds scope `conversations:read`.", "header": [], "url": { "raw": "{{baseUrl}}/conversations/:id/notes", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":id", "notes" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the conversation, conv_…" } ] } }, "response": [] }, { "name": "Add an internal note to a conversation", "request": { "method": "POST", "description": "The visitor never sees it.\n\nNeeds scope `conversations:write`.", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string. Retrying with the same key replays the first answer.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/conversations/:id/notes", "host": [ "{{baseUrl}}" ], "path": [ "conversations", ":id", "notes" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the conversation, conv_…" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Asked about annual terms on the website.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Leads", "description": "People or companies that have shown interest and are not yet customers.", "item": [ { "name": "List leads", "request": { "method": "GET", "description": "Needs scope `leads:read`.", "header": [], "url": { "raw": "{{baseUrl}}/leads", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [ { "key": "limit", "value": "25", "description": "Page size, at most 100.", "disabled": true }, { "key": "cursor", "value": "string", "description": "`pagination.nextCursor` from the previous page.", "disabled": true }, { "key": "sort", "value": "-updated_at", "description": "Sort order. A leading minus sorts descending.", "disabled": true }, { "key": "updated_since", "value": "2026-11-05T10:00:00Z", "description": "Only records updated at or after this instant.", "disabled": true }, { "key": "q", "value": "string", "description": "Free-text search over the object's main columns.", "disabled": true }, { "key": "status", "value": "string", "description": "Only records whose status equals this.", "disabled": true }, { "key": "source", "value": "string", "description": "Only records whose source equals this.", "disabled": true }, { "key": "owner", "value": "string", "description": "Only records whose owner equals this.", "disabled": true }, { "key": "person", "value": "string", "description": "Only records linked to this person (public id).", "disabled": true }, { "key": "company", "value": "string", "description": "Only records linked to this company (public id).", "disabled": true } ], "variable": [] } }, "response": [] }, { "name": "Create a lead", "request": { "method": "POST", "description": "Built-in and custom fields by key. Relations take public ids.\n\nNeeds scope `leads:write`.", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string. Retrying with the same key replays the first answer.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/leads", "host": [ "{{baseUrl}}" ], "path": [ "leads" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"person\": \"string\",\n \"company\": \"string\",\n \"title\": \"Annual plan renewal\",\n \"status\": \"new\",\n \"source\": \"website\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a lead", "request": { "method": "GET", "description": "Needs scope `leads:read`.", "header": [], "url": { "raw": "{{baseUrl}}/leads/:id", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the lead." } ] } }, "response": [] }, { "name": "Update a lead", "request": { "method": "PATCH", "description": "Only the keys sent are changed. Fields are applied in order; the first refusal stops the request and `details.applied` lists what was already changed.\n\nNeeds scope `leads:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/leads/:id", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the lead." } ] }, "body": { "mode": "raw", "raw": "{\n \"company\": \"string\",\n \"title\": \"Annual plan renewal\",\n \"status\": \"new\",\n \"source\": \"website\",\n \"owner\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Archive a lead", "request": { "method": "DELETE", "description": "Archives the record (it can be restored in the app). Nothing is destroyed.\n\nNeeds scope `leads:write`.", "header": [], "url": { "raw": "{{baseUrl}}/leads/:id", "host": [ "{{baseUrl}}" ], "path": [ "leads", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the lead." } ] } }, "response": [] } ] }, { "name": "Meetings", "description": "Schedule, move, cancel and list meetings. They reach calendars and invite attendees.", "item": [ { "name": "List meetings", "request": { "method": "GET", "description": "Soonest first for upcoming, most recent first for past. Not pageable: `pagination.hasMore` says whether more exist beyond `limit`.\n\nNeeds scope `meetings:read`.", "header": [], "url": { "raw": "{{baseUrl}}/meetings", "host": [ "{{baseUrl}}" ], "path": [ "meetings" ], "query": [ { "key": "window", "value": "upcoming", "description": "", "disabled": true }, { "key": "limit", "value": "25", "description": "", "disabled": true } ], "variable": [] } }, "response": [] }, { "name": "Schedule a meeting", "request": { "method": "POST", "description": "Lands on the owner's connected calendar and invites the attendees, as in the app. Send `notify: false` to save it without telling anyone.\n\nNeeds scope `meetings:write`.", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string. Retrying with the same key replays the first answer.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/meetings", "host": [ "{{baseUrl}}" ], "path": [ "meetings" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Annual plan renewal\",\n \"starts_at\": \"2026-11-05T10:00:00Z\",\n \"ends_at\": \"2026-11-05T10:00:00Z\",\n \"duration_minutes\": 30,\n \"time_zone\": \"UTC\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a meeting", "request": { "method": "GET", "description": "Needs scope `meetings:read`.", "header": [], "url": { "raw": "{{baseUrl}}/meetings/:id", "host": [ "{{baseUrl}}" ], "path": [ "meetings", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the meeting." } ] } }, "response": [] }, { "name": "Change a meeting", "request": { "method": "PATCH", "description": "Only the keys sent change. Moving it or changing the attendees tells them, unless `notify` is false. A cancelled meeting cannot be changed.\n\nNeeds scope `meetings:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/meetings/:id", "host": [ "{{baseUrl}}" ], "path": [ "meetings", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the meeting." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Annual plan renewal\",\n \"starts_at\": \"2026-11-05T10:00:00Z\",\n \"ends_at\": \"2026-11-05T10:00:00Z\",\n \"time_zone\": \"Australia/Sydney\",\n \"meeting_url\": \"https://example.com\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a meeting", "request": { "method": "DELETE", "description": "Removes it from every list and timeline. A meeting the AI agent booked with a visitor can be cancelled but not deleted.\n\nNeeds scope `meetings:write`.", "header": [], "url": { "raw": "{{baseUrl}}/meetings/:id", "host": [ "{{baseUrl}}" ], "path": [ "meetings", ":id" ], "query": [ { "key": "notify", "value": "true", "description": "Tell the attendees it is off. Only a meeting a teammate made can be deleted.", "disabled": true } ], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the meeting." } ] } }, "response": [] }, { "name": "Cancel a meeting", "request": { "method": "POST", "description": "The meeting stays on the record, marked cancelled. Cancelling twice changes nothing.\n\nNeeds scope `meetings:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/meetings/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "meetings", ":id", "cancel" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the meeting." } ] }, "body": { "mode": "raw", "raw": "{\n \"notify\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Notes", "description": "Notes on customers, companies, leads and deals.", "item": [ { "name": "List notes on a record", "request": { "method": "GET", "description": "The most recent notes on one record, pinned first. Not pageable: `pagination.hasMore` says whether older notes exist beyond `limit`.\n\nNeeds scope `notes:read`.", "header": [], "url": { "raw": "{{baseUrl}}/notes", "host": [ "{{baseUrl}}" ], "path": [ "notes" ], "query": [ { "key": "record_type", "value": "person", "description": "", "disabled": false }, { "key": "record_id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "", "disabled": false }, { "key": "limit", "value": "25", "description": "Page size, at most 100.", "disabled": true } ], "variable": [] } }, "response": [] }, { "name": "Add a note to a record", "request": { "method": "POST", "description": "Needs scope `notes:write`.", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string. Retrying with the same key replays the first answer.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/notes", "host": [ "{{baseUrl}}" ], "path": [ "notes" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"record_type\": \"person\",\n \"record_id\": \"pr_1a2b3c4d5e6f7a8b\",\n \"body\": \"Asked about annual terms on the website.\",\n \"pinned\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a note", "request": { "method": "GET", "description": "Needs scope `notes:read`.", "header": [], "url": { "raw": "{{baseUrl}}/notes/:id", "host": [ "{{baseUrl}}" ], "path": [ "notes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the note." } ] } }, "response": [] }, { "name": "Edit a note", "request": { "method": "PATCH", "description": "Change the text, pin or unpin it, or both.\n\nNeeds scope `notes:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/notes/:id", "host": [ "{{baseUrl}}" ], "path": [ "notes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the note." } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Asked about annual terms on the website.\",\n \"pinned\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a note", "request": { "method": "DELETE", "description": "Removes it from the record. An administrator can still recover it.\n\nNeeds scope `notes:write`.", "header": [], "url": { "raw": "{{baseUrl}}/notes/:id", "host": [ "{{baseUrl}}" ], "path": [ "notes", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the note." } ] } }, "response": [] } ] }, { "name": "Opportunities", "description": "Deals moving through a pipeline.", "item": [ { "name": "List opportunities", "request": { "method": "GET", "description": "Needs scope `opportunities:read`.", "header": [], "url": { "raw": "{{baseUrl}}/opportunities", "host": [ "{{baseUrl}}" ], "path": [ "opportunities" ], "query": [ { "key": "limit", "value": "25", "description": "Page size, at most 100.", "disabled": true }, { "key": "cursor", "value": "string", "description": "`pagination.nextCursor` from the previous page.", "disabled": true }, { "key": "sort", "value": "-updated_at", "description": "Sort order. A leading minus sorts descending.", "disabled": true }, { "key": "updated_since", "value": "2026-11-05T10:00:00Z", "description": "Only records updated at or after this instant.", "disabled": true }, { "key": "q", "value": "string", "description": "Free-text search over the object's main columns.", "disabled": true }, { "key": "owner", "value": "string", "description": "Only records whose owner equals this.", "disabled": true }, { "key": "pipeline", "value": "string", "description": "Only records whose pipeline id equals this.", "disabled": true }, { "key": "stage", "value": "string", "description": "Only records whose stage id equals this.", "disabled": true }, { "key": "stage_kind", "value": "string", "description": "Only records whose stage_kind equals this.", "disabled": true }, { "key": "currency", "value": "string", "description": "Only records whose currency equals this.", "disabled": true }, { "key": "source", "value": "string", "description": "Only records whose source equals this.", "disabled": true }, { "key": "person", "value": "string", "description": "Only records linked to this person (public id).", "disabled": true }, { "key": "company", "value": "string", "description": "Only records linked to this company (public id).", "disabled": true } ], "variable": [] } }, "response": [] }, { "name": "Create an opportunity", "request": { "method": "POST", "description": "Built-in and custom fields by key. Relations take public ids. Changing `stage` moves the opportunity through the pipeline's rules; when an approval policy applies the response is 409 `approval_required` and the opportunity does not move. `lost_reason` / `win_reason` in the same body travel with the move.\n\nNeeds scope `opportunities:write`.", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string. Retrying with the same key replays the first answer.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/opportunities", "host": [ "{{baseUrl}}" ], "path": [ "opportunities" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Emily Carter\",\n \"company\": \"string\",\n \"person\": \"string\",\n \"stage\": \"string\",\n \"amount\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get an opportunity", "request": { "method": "GET", "description": "Needs scope `opportunities:read`.", "header": [], "url": { "raw": "{{baseUrl}}/opportunities/:id", "host": [ "{{baseUrl}}" ], "path": [ "opportunities", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the opportunity." } ] } }, "response": [] }, { "name": "Update an opportunity", "request": { "method": "PATCH", "description": "Only the keys sent are changed. Fields are applied in order; the first refusal stops the request and `details.applied` lists what was already changed. Changing `stage` moves the opportunity through the pipeline's rules; when an approval policy applies the response is 409 `approval_required` and the opportunity does not move. `lost_reason` / `win_reason` in the same body travel with the move.\n\nNeeds scope `opportunities:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/opportunities/:id", "host": [ "{{baseUrl}}" ], "path": [ "opportunities", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the opportunity." } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Emily Carter\",\n \"company\": \"string\",\n \"stage\": \"string\",\n \"amount\": 1,\n \"currency\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Archive an opportunity", "request": { "method": "DELETE", "description": "Archives the record (it can be restored in the app). Nothing is destroyed.\n\nNeeds scope `opportunities:write`.", "header": [], "url": { "raw": "{{baseUrl}}/opportunities/:id", "host": [ "{{baseUrl}}" ], "path": [ "opportunities", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the opportunity." } ] } }, "response": [] } ] }, { "name": "People", "description": "Customers and contacts.", "item": [ { "name": "List people", "request": { "method": "GET", "description": "Needs scope `people:read`.", "header": [], "url": { "raw": "{{baseUrl}}/people", "host": [ "{{baseUrl}}" ], "path": [ "people" ], "query": [ { "key": "limit", "value": "25", "description": "Page size, at most 100.", "disabled": true }, { "key": "cursor", "value": "string", "description": "`pagination.nextCursor` from the previous page.", "disabled": true }, { "key": "sort", "value": "-updated_at", "description": "Sort order. A leading minus sorts descending.", "disabled": true }, { "key": "updated_since", "value": "2026-11-05T10:00:00Z", "description": "Only records updated at or after this instant.", "disabled": true }, { "key": "q", "value": "string", "description": "Free-text search over the object's main columns.", "disabled": true }, { "key": "email", "value": "emily@example.com", "description": "Only records whose email equals this.", "disabled": true }, { "key": "lifecycle_stage", "value": "string", "description": "Only records whose lifecycle_stage equals this.", "disabled": true }, { "key": "owner", "value": "string", "description": "Only records whose owner equals this.", "disabled": true }, { "key": "company", "value": "string", "description": "Only records linked to this company (public id).", "disabled": true }, { "key": "lead_source", "value": "string", "description": "Only records whose lead_source equals this.", "disabled": true }, { "key": "country", "value": "string", "description": "Only records whose country equals this.", "disabled": true }, { "key": "city", "value": "string", "description": "Only records whose city equals this.", "disabled": true }, { "key": "title", "value": "Annual plan renewal", "description": "Only records whose title equals this.", "disabled": true } ], "variable": [] } }, "response": [] }, { "name": "Create a person", "request": { "method": "POST", "description": "Built-in and custom fields by key. Relations take public ids.\n\nNeeds scope `people:write`.", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string. Retrying with the same key replays the first answer.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/people", "host": [ "{{baseUrl}}" ], "path": [ "people" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"display_name\": \"Emily Carter\",\n \"first_name\": \"Emily\",\n \"last_name\": \"Carter\",\n \"email\": \"emily@example.com\",\n \"phone\": \"+61 400 000 000\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a person", "request": { "method": "GET", "description": "Needs scope `people:read`.", "header": [], "url": { "raw": "{{baseUrl}}/people/:id", "host": [ "{{baseUrl}}" ], "path": [ "people", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the person." } ] } }, "response": [] }, { "name": "Update a person", "request": { "method": "PATCH", "description": "Only the keys sent are changed. Fields are applied in order; the first refusal stops the request and `details.applied` lists what was already changed.\n\nNeeds scope `people:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/people/:id", "host": [ "{{baseUrl}}" ], "path": [ "people", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the person." } ] }, "body": { "mode": "raw", "raw": "{\n \"display_name\": \"Emily Carter\",\n \"first_name\": \"Emily\",\n \"last_name\": \"Carter\",\n \"email\": \"emily@example.com\",\n \"phone\": \"+61 400 000 000\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Archive a person", "request": { "method": "DELETE", "description": "Archives the record (it can be restored in the app). Nothing is destroyed.\n\nNeeds scope `people:write`.", "header": [], "url": { "raw": "{{baseUrl}}/people/:id", "host": [ "{{baseUrl}}" ], "path": [ "people", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the person." } ] } }, "response": [] } ] }, { "name": "Pipelines", "description": "Pipelines and their stages, for moving deals.", "item": [ { "name": "List pipelines and their stages", "request": { "method": "GET", "description": "Needs scope `pipelines:read`.", "header": [], "url": { "raw": "{{baseUrl}}/pipelines", "host": [ "{{baseUrl}}" ], "path": [ "pipelines" ], "query": [], "variable": [] } }, "response": [] }, { "name": "Get a pipeline", "request": { "method": "GET", "description": "Needs scope `pipelines:read`.", "header": [], "url": { "raw": "{{baseUrl}}/pipelines/:id", "host": [ "{{baseUrl}}" ], "path": [ "pipelines", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Pipeline id." } ] } }, "response": [] } ] }, { "name": "Reports", "description": "Run saved reports.", "item": [ { "name": "Run a saved report", "request": { "method": "POST", "description": "Runs the saved definition now. A key acting as a member opens that member's own, shared and workspace reports; other keys open workspace-visible reports. Totals include only records the key may see.\n\nNeeds scope `reports:read`.", "header": [], "url": { "raw": "{{baseUrl}}/reports/:id/run", "host": [ "{{baseUrl}}" ], "path": [ "reports", ":id", "run" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the saved report." } ] } }, "response": [] } ] }, { "name": "Tasks", "description": "Work for your team, optionally linked to a record.", "item": [ { "name": "List tasks", "request": { "method": "GET", "description": "Ordered by due date (soonest first; completed tasks by completion, newest first).\n\nNeeds scope `tasks:read`.", "header": [], "url": { "raw": "{{baseUrl}}/tasks", "host": [ "{{baseUrl}}" ], "path": [ "tasks" ], "query": [ { "key": "limit", "value": "25", "description": "Page size, at most 100.", "disabled": true }, { "key": "cursor", "value": "string", "description": "`pagination.nextCursor` from the previous page.", "disabled": true }, { "key": "window", "value": "all", "description": "", "disabled": true }, { "key": "owner", "value": "string", "description": "", "disabled": true }, { "key": "person", "value": "string", "description": "", "disabled": true }, { "key": "company", "value": "string", "description": "", "disabled": true }, { "key": "lead", "value": "string", "description": "", "disabled": true }, { "key": "opportunity", "value": "string", "description": "", "disabled": true } ], "variable": [] } }, "response": [] }, { "name": "Create a task", "request": { "method": "POST", "description": "Needs scope `tasks:write`.", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string. Retrying with the same key replays the first answer.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tasks", "host": [ "{{baseUrl}}" ], "path": [ "tasks" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Annual plan renewal\",\n \"description\": \"Asked about annual terms on the website.\",\n \"kind\": \"task\",\n \"priority\": \"low\",\n \"due_at\": \"2026-11-05T10:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a task", "request": { "method": "GET", "description": "Needs scope `tasks:read`.", "header": [], "url": { "raw": "{{baseUrl}}/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the task." } ] } }, "response": [] }, { "name": "Update a task", "request": { "method": "PATCH", "description": "Needs scope `tasks:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the task." } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Annual plan renewal\",\n \"description\": \"Asked about annual terms on the website.\",\n \"kind\": \"task\",\n \"priority\": \"low\",\n \"due_at\": \"2026-11-05T10:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a task", "request": { "method": "DELETE", "description": "Removes the task for good, and the record it was on gets its next activity recalculated.\n\nNeeds scope `tasks:write`.", "header": [], "url": { "raw": "{{baseUrl}}/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the task." } ] } }, "response": [] }, { "name": "Complete a task", "request": { "method": "POST", "description": "Idempotent: completing a completed task changes nothing.\n\nNeeds scope `tasks:write`.", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string. Retrying with the same key replays the first answer.", "disabled": true } ], "url": { "raw": "{{baseUrl}}/tasks/:id/complete", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "complete" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "Public id of the task." } ] } }, "response": [] } ] }, { "name": "Team", "description": "The people in the workspace, for owners and assignees.", "item": [ { "name": "List teammates", "request": { "method": "GET", "description": "Everyone in the workspace. Use the id as the owner of a customer, company, lead, deal or task.\n\nNeeds scope `team:read`.", "header": [], "url": { "raw": "{{baseUrl}}/team/members", "host": [ "{{baseUrl}}" ], "path": [ "team", "members" ], "query": [], "variable": [] } }, "response": [] } ] }, { "name": "Tickets", "description": "Support tickets, addressed by their number.", "item": [ { "name": "List tickets", "request": { "method": "GET", "description": "Newest ticket number first.\n\nNeeds scope `tickets:read`.", "header": [], "url": { "raw": "{{baseUrl}}/tickets", "host": [ "{{baseUrl}}" ], "path": [ "tickets" ], "query": [ { "key": "limit", "value": "25", "description": "Page size, at most 100.", "disabled": true }, { "key": "cursor", "value": "string", "description": "`pagination.nextCursor` from the previous page.", "disabled": true }, { "key": "status", "value": "new", "description": "", "disabled": true }, { "key": "priority", "value": "low", "description": "", "disabled": true }, { "key": "assignee", "value": "string", "description": "Member user id.", "disabled": true }, { "key": "q", "value": "string", "description": "Search the subject and summary.", "disabled": true }, { "key": "updated_since", "value": "2026-11-05T10:00:00Z", "description": "Only tickets changed at or after this time.", "disabled": true } ], "variable": [] } }, "response": [] }, { "name": "Open a ticket about a record", "request": { "method": "POST", "description": "Needs at least one of person, company, lead or opportunity, each a record the key can see.\n\nNeeds scope `tickets:write`.", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}", "description": "Any unique string. Retrying with the same key replays the first answer.", "disabled": true }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tickets", "host": [ "{{baseUrl}}" ], "path": [ "tickets" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"subject\": \"Annual plan renewal\",\n \"summary\": \"Asked about annual terms on the website.\",\n \"priority\": \"low\",\n \"assignee\": \"string\",\n \"person\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a ticket", "request": { "method": "GET", "description": "Needs scope `tickets:read`.", "header": [], "url": { "raw": "{{baseUrl}}/tickets/:id", "host": [ "{{baseUrl}}" ], "path": [ "tickets", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "The ticket number." } ] } }, "response": [] }, { "name": "Change a ticket", "request": { "method": "PATCH", "description": "Move it along its lifecycle, change its priority or reassign it. A status the ticket cannot move to from where it is answers 409.\n\nNeeds scope `tickets:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tickets/:id", "host": [ "{{baseUrl}}" ], "path": [ "tickets", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "The ticket number." } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"new\",\n \"priority\": \"low\",\n \"assignee\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Webhooks", "description": "Subscribe an address to events, rotate its secret and read delivery history.", "item": [ { "name": "List webhook events", "request": { "method": "GET", "description": "The events a subscription can receive.\n\nNeeds scope `webhooks:read`.", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/events", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "events" ], "query": [], "variable": [] } }, "response": [] }, { "name": "List webhook subscriptions", "request": { "method": "GET", "description": "Never includes a signing secret.\n\nNeeds scope `webhooks:read`.", "header": [], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ], "query": [], "variable": [] } }, "response": [] }, { "name": "Subscribe a URL to events", "request": { "method": "POST", "description": "The response carries the signing secret once. Not idempotent on purpose: a replayed response would store the secret.\n\nNeeds scope `webhooks:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ], "query": [], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com\",\n \"events\": [\n \"record.created\"\n ],\n \"description\": \"Asked about annual terms on the website.\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a webhook subscription", "request": { "method": "GET", "description": "Needs scope `webhooks:read`.", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "The subscription's id." } ] } }, "response": [] }, { "name": "Change a webhook subscription", "request": { "method": "PATCH", "description": "Only the keys sent are changed. A new url is checked the same way as on create.\n\nNeeds scope `webhooks:write`.", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "The subscription's id." } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com\",\n \"events\": [\n \"record.created\"\n ],\n \"description\": \"Asked about annual terms on the website.\",\n \"status\": \"active\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Unsubscribe", "request": { "method": "DELETE", "description": "Deletes the subscription and its delivery history. This cannot be undone.\n\nNeeds scope `webhooks:write`.", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "The subscription's id." } ] } }, "response": [] }, { "name": "Replace the signing secret", "request": { "method": "POST", "description": "The old secret stops signing at once, with no overlap. The new one is returned once.\n\nNeeds scope `webhooks:write`.", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:id/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "rotate-secret" ], "query": [], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "The subscription's id." } ] } }, "response": [] }, { "name": "List deliveries", "request": { "method": "GET", "description": "Newest first: what was sent, to where it got, and how it went.\n\nNeeds scope `webhooks:read`.", "header": [], "url": { "raw": "{{baseUrl}}/webhooks/:id/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "deliveries" ], "query": [ { "key": "limit", "value": "25", "description": "Page size, at most 100.", "disabled": true }, { "key": "cursor", "value": "string", "description": "", "disabled": true } ], "variable": [ { "key": "id", "value": "pr_1a2b3c4d5e6f7a8b", "description": "The subscription's id." } ] } }, "response": [] } ] } ] }