API reference

API reference

Search approved contacts, find conversations, read message history, and send messages through Coop.

The Coop API turns the conversations already available to your team into a programmatic messaging surface. It uses the same encrypted message store and Relay path as the dashboard.

Start with this flow:

  1. Create an API token and save its secret when Coop shows it.
  2. Search contacts to find a Contact ID.
  3. List that Contact’s conversations to find the route you want.
  4. Read paginated messages or send a reply.

Use GET /v1/recent when you want the latest accessible conversations without searching first.

API tokens currently inherit the global team target policy. A token can read or send only the Contacts, unknown conversations, and groups shared with the team, subject to the token’s scopes. Tokens cannot start a conversation with an arbitrary phone number or email address.

All examples use https://api.example.com as the Coop API origin. Replace it with the API origin of your self-hosted installation.