API reference

Every endpoint, parameter and field, drawn from the same OpenAPI 3.1 document the API serves. Use that document to generate a client, import the API into Postman or Insomnia, or give it to an AI tool.

Groups

• People 5Customers and contacts.
• Companies 5Accounts: the organisations you sell to or support.
• Leads 5People or companies that have shown interest and are not yet customers.
• Opportunities 5Deals moving through a pipeline.
• Pipelines 2Pipelines and their stages, for moving deals.
• Custom objects 5Records of the objects your workspace defines for itself.
• Tasks 6Work for your team, optionally linked to a record.
• Notes 5Notes on customers, companies, leads and deals.
• Tickets 4Support tickets, addressed by their number.
• Meetings 6Schedule, move, cancel and list meetings. They reach calendars and invite attendees.
• Inbox 9The live chat inbox: read conversations, take them over from the AI agent, reply, hand back.
• Team 1The people in the workspace, for owners and assignees.
• Webhooks 8Subscribe an address to events, rotate its secret and read delivery history.
• Reports 1Run saved reports.
• Evidence 2What the workspace knows about a record, and where it came from.

Use the document

• Postman: import https://synconone.com/api/v1/postman.json (Import, then Link) for a ready-made collection with every request, grouped as here. Set its apiKey variable to your key, in the variable's current value so it is not shared. Insomnia and similar tools can import the OpenAPI document instead.
• Generate a client: point openapi-generator, openapi-typescript or your language's generator at the document.
• Swagger UI or Redoc: load the same address. It allows requests from any origin, since it describes the API and exposes no data.
• AI tools: connect the MCP server instead, which offers every endpoint as a tool.