API v2

By Orqestra · Published September 2, 2026

What this API does

The Orqestra REST API lets you send messages, manage contacts and segments, read conversation history, trigger automations, and run broadcasts from your own systems. Everything the dashboard does with customer conversations, it does through the same data this API exposes.

https://orqestra.id/api/v2

All paths in this section are relative to that base. Requests and responses are JSON; send Content-Type: application/json on any request with a body.

Start here

Authentication — tokens, permissions, and what 401 vs 403 means.
Pagination & responses — the response envelope and how to page safely.
Errors — status codes, and what is safe to retry.
Rate limits — the 60-second window and its headers.

Already integrated against v1? See Migrating from v1 — v1 has been removed.

Your first request

Create a token under Settings → API Access, then confirm it works:

curl "https://orqestra.id/api/v2/organization" \
  -H "Authorization: Bearer $ORQESTRA_TOKEN"

A 200 with your organization's details means the token is live. A 401 means the header is wrong; a 403 means the token lacks settings.view.

Sending a message

curl -X POST "https://orqestra.id/api/v2/messages" \
  -H "Authorization: Bearer $ORQESTRA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "628123456789",
    "type": "text",
    "text": "Pesanan #12345 sudah dikirim. Nomor resi: JX0099881."
  }'

WhatsApp only permits free-form messages within 24 hours of the customer's last message. Outside that window this call is rejected and you must send an approved template instead. That is Meta's rule, not ours.

Channel support

Orqestra runs five channels, but the public API does not expose them equally. Outbound sends accept WhatsApp and Instagram only. Web Chat, Telegram and TikTok Shop conversations are readable through the chat endpoints, and automations reach them, but you cannot address them from POST /messages today.

Resources

Resource	Endpoints	What it covers
Messages	1	Send messages to a customer.
Chats & Sessions	8	Read conversations and their message history, manage the agent session attached to a chat, assign a chat to a teammate, and escalate to a human when automation has gone as far as it usefully can.
Contacts	10	Create, read and update the people your organization talks to.
Contact Fields	3	Custom attributes on a single contact — order numbers, plan tiers, anything your business tracks that Orqestra does not model natively.
Segments	5	Named groups of contacts, used as broadcast audiences and as automation conditions.
Templates	4	WhatsApp message templates.
Broadcasts	4	Send an approved template to many contacts at once.
Flows	2	Journeys — the automation graphs built in the Flow Builder.
Tickets	5	Work items attached to a contact or conversation, for issues that outlive a single chat session.
Channels	2	The channel instances connected to your organization.
Users	1	The agents in your organization.
Organization	1	Metadata about the organization the token belongs to.

The playground

The API v2 playground is the interactive reference: every endpoint with its full schema, and a button to send a real request with your own token. Test there before writing code.