Introduction to the Convot API

The Convot REST API lets you build on top of your support workspace: open and reply to conversations, sync contacts from your own systems, and manage your help center, changelog, and roadmap, all programmatically.

Base URL

All endpoints live under:

https://app.convot.io/v1

Every request is scoped to a single Convot app by your API key, so you never put an app id in the URL.

What you can do

• Conversations: list, read, create, resolve, reopen.
• Messages: list a conversation’s messages (customer replies plus internal notes and activity events, each tagged with a type you can filter on), and send a reply.
• Contacts: list, read, create, and update people.
• Help center: manage articles and categories.
• Changelog: publish and edit changelog entries.
• Roadmap: read and create feature requests.

The interactive reference

The full, always-current reference (every endpoint, parameter, and response shape) is published as an OpenAPI document and rendered here:

• Reference: https://docs.convot.io
• OpenAPI spec: https://docs.convot.io/openapi.yaml

You can import the spec into Postman, Insomnia, or any OpenAPI tool to generate a client.

Next steps

1. Read Authentication to create your first key.
2. Follow the Quickstart to make your first call.
3. Review Scopes and permissions, Rate limits, and Errors.