GraphQL

GraphQL complements REST: use it when you need one round-trip across inbox, CRM, AI, and insights. Every field maps to a documented REST handler; authentication uses the same X-API-Key or Bearer token.

Endpoint

• URL: POST http://localhost:8000/v1/graphql (production: https://api.syntra.io/v1/graphql)
• Schema: developer-platform/api-specs/graphql.schema.graphql
• GraphiQL: available in local dev at the same URL (GET in browser when NODE_ENV is not production)

Agent workspace query

query AgentWorkspace {
  me
  conversations
  agents
  contacts(q: "acme")
  metrics(from: "2026-06-01", to: "2026-06-22")
}

Send a message (mutation)

curl -X POST http://localhost:8000/v1/graphql \
  -H "X-API-Key: sk_test_syntra_dev_key" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "mutation($c: String!, $t: String!, $b: String!) { sendMessage(channel: $c, to: $t, body: $b) }",
    "variables": {
      "c": "whatsapp",
      "t": "+233241234567",
      "b": "Hello from GraphQL"
    }
  }'