Open API v1

API reference

Generate this page from core/openapi/v1.yaml (or GET /open/v1/openapi.yaml). The tables below are a human index of the same contract.

Base path: https://api.taggoai.com.

Contacts

List query: limit, starting_after, email, phone, search, tag, segment, lifecycle_stage, created_after, created_before.

Create body (required name): email, phone, avatar, website, source, status, group, gender, birthday, address, company, tags, segments, lifecycle_stage, preferred_channel, preferred_language, timezone, do_not_contact, marketing_consent, custom_fields, external_ids.

Tickets

List query: limit, starting_after, status, priority, category, contact_id, tag, created_after, created_before.

Create body (required subject): type, priority, status, category, sentiment, contact_id, conversation_id, assignee_id, tags, notes, language, due_at.

Statuses: New, On you, On customer, On hold, Solved, Closed, Cancelled.

Conversations

List query: limit, starting_after, status (open | closed), channel, contact_id, unread.

Send body: { "body": "string", "internal_note": false }.

Webhooks

Create body: { "url": "https://...", "description": "...", "events": ["contact.created"] }.

Events: contact.created, contact.updated, ticket.created, ticket.updated, message.received, conversation.assigned.

Spec