API Documentation

{
  "data": [ ... ],
  "links": {
    "first": "...?page=1",
    "last": "...?page=5",
    "prev": null,
    "next": "...?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 20,
    "to": 20,
    "total": 93
  }
}

Returns 404 if ticket_form_public_id does not exist or the form does not belong to the team. Returns 422 if assigned_to is not the team owner or a team member.

{
  "data": {
    "id": 1,
    "public_id": "550e8400-e29b-41d4-a716-446655440000",
    "reference": "TK-000001",
    "subject": "Cannot login to dashboard",
    "description": "I get an error when trying to login...",
    "status": "open",
    "priority": "high",
    "submitter_name": "Mario Rossi",
    "submitter_email": "mario@example.com",
    "form_data": { "category": "bug" },
    "deflected": false,
    "assigned_to": { "id": 1, "name": "Admin User" },
    "form": { "id": 1, "public_id": "...", "name": "Support Form" },
    "replies": [
      {
        "id": 1,
        "content": "We are looking into this issue.",
        "is_internal_note": false,
        "is_ai_generated": false,
        "author": { "id": 1, "name": "Admin", "email": "admin@example.com" },
        "attachments": [],
        "created_at": "2026-03-07T11:00:00.000000Z"
      }
    ],
    "attachments": [
      {
        "id": 1,
        "filename": "screenshot.png",
        "mime_type": "image/png",
        "size": "245.3 KB",
        "type": "image"
      }
    ],
    "resolved_at": null,
    "created_at": "2026-03-07T10:00:00.000000Z",
    "updated_at": "2026-03-07T10:00:00.000000Z"
  }
}

{
  "data": {
    "id": 5,
    "content": "We have identified the issue and deployed a fix.",
    "is_internal_note": false,
    "is_ai_generated": false,
    "author": { "id": 1, "name": "Admin", "email": "admin@example.com" },
    "created_at": "2026-03-07T14:30:00.000000Z"
  }
}

curl -X GET "https://your-domain/api/v1/{team_id}/tickets/{ticket_id}/attachments/{attachment_id}" \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"

{
  "data": {
    "id": 1,
    "public_id": "550e8400-e29b-41d4-a716-446655440000",
    "visitor_id": "v_abc123",
    "visitor_name": "Mario Rossi",
    "visitor_email": "mario@example.com",
    "visitor_phone": null,
    "status": "active",
    "source_url": "https://example.com/pricing",
    "messages": [
      {
        "id": 1,
        "role": "user",
        "content": "What are your pricing plans?",
        "sources": null,
        "confidence": null,
        "token_count": 12,
        "created_at": "2026-03-07T09:00:00.000000Z"
      },
      {
        "id": 2,
        "role": "assistant",
        "content": "We offer three plans: Starter, Pro, and Ultimate...",
        "sources": [
          { "document": "pricing.pdf", "chunk": "Our pricing starts at..." }
        ],
        "confidence": 0.92,
        "token_count": 145,
        "created_at": "2026-03-07T09:00:02.000000Z"
      }
    ],
    "created_at": "2026-03-07T09:00:00.000000Z",
    "updated_at": "2026-03-07T09:15:00.000000Z"
  }
}

{
  "data": {
    "id": 1,
    "name": "Help Center",
    "slug": "help-center",
    "description": "Main documentation portal",
    "is_published": true,
    "primary_color": "#6366f1",
    "hide_branding": false,
    "categories": [
      {
        "id": 1,
        "name": "Getting Started",
        "slug": "getting-started",
        "description": "Learn the basics",
        "icon": "book",
        "sort_order": 1,
        "articles_count": 5
      },
      {
        "id": 2,
        "name": "Advanced",
        "slug": "advanced",
        "description": "Advanced topics",
        "icon": "cog",
        "sort_order": 2,
        "articles_count": 12
      }
    ],
    "created_at": "2026-03-01T09:00:00.000000Z",
    "updated_at": "2026-03-05T14:00:00.000000Z"
  }
}

{
  "data": [
    {
      "id": 1,
      "title": "Quick Start Guide",
      "slug": "quick-start-guide",
      "content": "<p>Welcome to the platform...</p>",
      "excerpt": "Get started in 5 minutes",
      "is_published": true,
      "sort_order": 1,
      "meta_title": "Quick Start",
      "meta_description": "Learn how to get started",
      "created_at": "2026-03-01T09:00:00.000000Z",
      "updated_at": "2026-03-05T14:00:00.000000Z"
    }
  ]
}

{
  "data": {
    "id": 1,
    "title": "Quick Start Guide",
    "slug": "quick-start-guide",
    "content": "<p>Welcome to the platform...</p>",
    "excerpt": "Get started in 5 minutes",
    "is_published": true,
    "sort_order": 1,
    "meta_title": "Quick Start",
    "meta_description": "Learn how to get started",
    "category": {
      "id": 1,
      "name": "Getting Started",
      "slug": "getting-started",
      "description": "Learn the basics",
      "icon": "book",
      "sort_order": 1,
      "articles_count": 5
    },
    "created_at": "2026-03-01T09:00:00.000000Z",
    "updated_at": "2026-03-05T14:00:00.000000Z"
  }
}