ChatMo Open API

Tickets

Endpoint

Ticket list, create, and update — with auto-generated changelog rows on tracked field changes.

List tickets

GET

https://api.chatmo.io/v1/open-api

/tickets

Paginated tickets with full inline relations — status, assigned_user, created_by_user, conversation, assignees[], _count.activities. Used by the chat detail screen's Linked tickets tab and the dedicated tickets screen.

sort always prepends position ASC as the primary key (kanban order), UNLESS conversation_id is set — in that case kanban order is irrelevant and only the user-selected key is applied.

Performance: 7 queries flat — list + count + batched (statuses, users, conversations, assignees, activity-counts). No N+1.

List tickets › query Parameters

board_id

string · uuid

status_id

string · uuid

priority

string

Comma-separated: LOW,MEDIUM,HIGH,URGENT.

assigned_to

string

Comma-separated UUIDs. Matches legacy assigned_to OR junction ticket_assignees.

created_by

string

Comma-separated UUIDs.

conversation_id

string · uuid

Tickets linked to a specific chat. Disables position sort.

search

string · maxLength: 200

ILIKE across title, description, cast(ticket_number AS TEXT).

is_done

boolean

date_from

string · date

YYYY-MM-DD or RFC 3339. Inclusive lower bound on created_at.

date_to

string · date

YYYY-MM-DD or RFC 3339. Inclusive upper bound on created_at. Bare dates are auto-bumped to end-of-day.

sort

string · enum

Enum values:

newest

oldest

updated_recently

urgent_first

Default: newest

page

integer · min: 1 · max: 500

1-indexed page number. Capped at 500 to bound deep-scan cost.

Default: 1

limit

integer · min: 1 · max: 100

Rows per page. Capped at 100.

Default: 50

List tickets › Responses

Tickets page.

success

boolean

object

GET/tickets

curl --request GET \
  --url https://api.chatmo.io/v1/open-api/tickets

shell

Example Responses

{
  "success": true,
  "data": {
    "tickets": [
      {
        "id": "tkt-1-12345678-1234-4abc-9def-0123456789ab",
        "organization_id": "7b25578d-4051-4b0f-92ce-f80944e543f7",
        "board_id": "f3017414-1234-4abc-9def-0123456789ab",
        "template_id": null,
        "status_id": "ab12cd34-5678-4abc-9def-0123456789ab",
        "ticket_number": 123,
        "title": "Refund for order #456",
        "description": "Customer received a defective unit. Requesting full refund.",
        "priority": "HIGH",
        "assigned_to": null,
        "conversation_id": "04d5172a-8a14-4f0c-b714-0f6c9ee27a20",
        "is_done": false,
        "done_at": null,
        "position": 0,
        "created_by": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
        "created_at": "2026-05-15T10:08:56.421Z",
        "updated_at": "2026-05-18T11:04:43.129Z",
        "status": {
          "id": "ab12cd34-5678-4abc-9def-0123456789ab",
          "name": "New Order",
          "color": "#6B7280"
        },
        "assigned_user": null,
        "created_by_user": {
          "id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
          "full_name": "Sarah Johnson"
        },
        "conversation": {
          "id": "04d5172a-8a14-4f0c-b714-0f6c9ee27a20",
          "subject": "Refund issue"
        },
        "assignees": [
          {
            "id": "asg-1-12345678",
            "ticket_id": "tkt-1-12345678-1234-4abc-9def-0123456789ab",
            "user_id": "e25d8c89-2b1f-4d3e-9a4c-8f0b1d2e3f4a",
            "assigned_at": "2026-05-15T10:08:56.421Z",
            "user": {
              "id": "e25d8c89-2b1f-4d3e-9a4c-8f0b1d2e3f4a",
              "full_name": "Sarah Johnson",
              "avatar_url": null
            }
          }
        ],
        "_count": {
          "activities": 5
        }
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total_items": 768,
      "total_pages": 39,
      "has_prev_page": false,
      "has_next_page": true
    }
  }
}

json

application/json

Create a ticket

POST

https://api.chatmo.io/v1/open-api

/tickets

Creates a ticket. ticket_number is auto-allocated as MAX(ticket_number)+1 within the organization; position is auto-allocated as MAX(position)+1 within the target status column. All writes (ticket + assignees + field_values + product snapshots) happen in a single transaction.

Create a ticket › Request Body

board_id

string · uuid · required

status_id

string · uuid · required

Must belong to board_id.

title

string · minLength: 1 · maxLength: 255 · required

description

string · maxLength: 5000

priority

string · enum

Enum values:

LOW

MEDIUM

HIGH

URGENT

Default: MEDIUM

template_id

string · uuid

assigned_to

string · uuid

Legacy single assignee.

assigned_to_ids

string[]

Multi-assignee array. Inserted into ticket_assignees.

conversation_id

string · uuid

object[]

Create a ticket › Responses

Ticket created with all relations inlined.

success

boolean

code

integer

object

POST/tickets

curl --request POST \
  --url https://api.chatmo.io/v1/open-api/tickets \
  --header 'Content-Type: application/json' \
  --data '
{
  "board_id": "f3017414-...",
  "status_id": "ab12cd34-...",
  "title": "Refund for order #456"
}
'

shell

Example Request Body

{
  "board_id": "f3017414-...",
  "status_id": "ab12cd34-...",
  "title": "Refund for order #456"
}

json

application/json

Example Responses

{
  "success": true,
  "code": 201,
  "data": {
    "ticket": {
      "id": "tkt-1-12345678-1234-4abc-9def-0123456789ab",
      "organization_id": "7b25578d-4051-4b0f-92ce-f80944e543f7",
      "board_id": "f3017414-1234-4abc-9def-0123456789ab",
      "template_id": null,
      "status_id": "ab12cd34-5678-4abc-9def-0123456789ab",
      "ticket_number": 123,
      "title": "Refund for order #456",
      "description": "Customer received a defective unit. Requesting full refund.",
      "priority": "HIGH",
      "assigned_to": null,
      "conversation_id": "04d5172a-8a14-4f0c-b714-0f6c9ee27a20",
      "is_done": false,
      "done_at": null,
      "position": 0,
      "created_by": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
      "created_at": "2026-05-15T10:08:56.421Z",
      "updated_at": "2026-05-18T11:04:43.129Z",
      "status": {
        "id": "ab12cd34-5678-4abc-9def-0123456789ab",
        "name": "New Order",
        "color": "#6B7280"
      },
      "assigned_user": null,
      "created_by_user": {
        "id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
        "full_name": "Sarah Johnson"
      },
      "conversation": {
        "id": "04d5172a-8a14-4f0c-b714-0f6c9ee27a20",
        "subject": "Refund issue"
      },
      "assignees": [
        {
          "id": "asg-1-12345678",
          "ticket_id": "tkt-1-12345678-1234-4abc-9def-0123456789ab",
          "user_id": "e25d8c89-2b1f-4d3e-9a4c-8f0b1d2e3f4a",
          "assigned_at": "2026-05-15T10:08:56.421Z",
          "user": {
            "id": "e25d8c89-2b1f-4d3e-9a4c-8f0b1d2e3f4a",
            "full_name": "Sarah Johnson",
            "avatar_url": null
          }
        }
      ],
      "_count": {
        "activities": 5
      }
    }
  }
}

json

application/json

Get a ticket

GET

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}

Returns the same enriched ticket detail payload as POST /tickets and PATCH /tickets/{id} — one DTO for all three on the client side. Includes inline status, assigned_user, created_by_user, conversation, assignees[], products[], attachments[], field_values[], and a _count.activities badge.

Get a ticket › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

Get a ticket › Responses

Ticket detail.

success

boolean

object

GET/tickets/{ticket_id}

curl --request GET \
  --url https://api.chatmo.io/v1/open-api/tickets/:ticket_id

shell

Example Responses

{
  "success": true,
  "code": 200,
  "message": "ticket detail",
  "data": {
    "ticket": {
      "id": "f3017414-1234-4abc-9def-0123456789ab",
      "organization_id": "7b25578d-4051-4b0f-92ce-f80944e543f7",
      "board_id": "ab12cd34-5678-4abc-9def-0123456789ab",
      "template_id": null,
      "status_id": "ab12cd34-5678-4abc-9def-0123456789ab",
      "ticket_number": 123,
      "title": "Refund for order #456",
      "description": "Customer requested a refund after a delivery delay.",
      "priority": "MEDIUM",
      "assigned_to": "9d8a4ce1-9c14-4f72-bb20-7a8b81d7bd31",
      "conversation_id": "55555555-5555-4555-9555-555555555555",
      "is_done": false,
      "done_at": null,
      "position": 7,
      "created_by": "9d8a4ce1-9c14-4f72-bb20-7a8b81d7bd31",
      "created_at": "2026-05-20T08:11:00Z",
      "updated_at": "2026-05-26T03:42:00Z",
      "status": {
        "id": "ab12cd34-5678-4abc-9def-0123456789ab",
        "name": "In Progress",
        "color": "#3B82F6"
      },
      "assigned_user": {
        "id": "9d8a4ce1-9c14-4f72-bb20-7a8b81d7bd31",
        "full_name": "Alice Sutanto",
        "avatar_url": null
      },
      "created_by_user": {
        "id": "9d8a4ce1-9c14-4f72-bb20-7a8b81d7bd31",
        "full_name": "Alice Sutanto"
      },
      "conversation": {
        "id": "55555555-5555-4555-9555-555555555555",
        "subject": "Order #456 — delivery issue"
      },
      "assignees": [
        {
          "id": "66666666-6666-4666-9666-666666666666",
          "ticket_id": "f3017414-1234-4abc-9def-0123456789ab",
          "user_id": "9d8a4ce1-9c14-4f72-bb20-7a8b81d7bd31",
          "assigned_at": "2026-05-20T08:12:00Z",
          "user": {
            "id": "9d8a4ce1-9c14-4f72-bb20-7a8b81d7bd31",
            "full_name": "Alice Sutanto",
            "avatar_url": null
          }
        }
      ],
      "products": [],
      "attachments": [],
      "field_values": [],
      "_count": {
        "activities": 4
      }
    }
  }
}

json

application/json

Delete a ticket

DELETE

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}

Soft-delete (deleted_at + deleted_by). The row stops surfacing in every list / detail / search query immediately.

Delete a ticket › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

Delete a ticket › Responses

Ticket deleted.

success

boolean

message

string

data

object | null

Update a ticket

PATCH

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}

Partial update. Empty body returns 400 no editable fields in update request.

Status side-effect: when status_id points at a status with is_default=true on its board, the ticket flips to is_done=true and stamps done_at. Moving back to a non-default status clears both.

Auto-changelog: every tracked field change auto-writes a ticket_activities row of type=CHANGELOG with structured metadata: {field, old, new}. Tracked fields: title, description, priority, status (uses the status NAME, not the id, in the human-readable content), and custom field values. All writes (ticket update + assignee delete-create + field_value upserts + N changelog inserts) happen inside one transaction.

Update a ticket › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

Update a ticket › Request Body

All fields optional. Empty body returns 400.

title

string · minLength: 1 · maxLength: 255

description

string | null

Pass empty string to clear.

priority

string · enum

Enum values:

LOW

MEDIUM

HIGH

URGENT

status_id

string · uuid

Must belong to the same board. Flips is_done if the target status is the board's is_default.

assigned_to

string | null · uuid

assigned_to_ids

string[]

When present, REPLACES ticket_assignees (delete-all + create-all in one transaction).

conversation_id

string | null · uuid

template_id

string | null · uuid

object[]

Update a ticket › Responses

Updated ticket with all relations.

success

boolean

object

PATCH/tickets/{ticket_id}

curl --request PATCH \
  --url https://api.chatmo.io/v1/open-api/tickets/:ticket_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "title",
  "description": "description",
  "priority": "LOW",
  "status_id": "00000000-0000-0000-0000-000000000000",
  "assigned_to": "00000000-0000-0000-0000-000000000000",
  "assigned_to_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "conversation_id": "00000000-0000-0000-0000-000000000000",
  "template_id": "00000000-0000-0000-0000-000000000000",
  "field_values": [
    {
      "template_field_id": "00000000-0000-0000-0000-000000000000",
      "value": "value"
    }
  ]
}
'

shell

Example Request Body

{
  "title": "title",
  "description": "description",
  "priority": "LOW",
  "status_id": "00000000-0000-0000-0000-000000000000",
  "assigned_to": "00000000-0000-0000-0000-000000000000",
  "assigned_to_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "conversation_id": "00000000-0000-0000-0000-000000000000",
  "template_id": "00000000-0000-0000-0000-000000000000",
  "field_values": [
    {
      "template_field_id": "00000000-0000-0000-0000-000000000000",
      "value": "value"
    }
  ]
}

json

Example Responses

{
  "success": true,
  "data": {
    "ticket": {
      "id": "tkt-1-12345678-1234-4abc-9def-0123456789ab",
      "organization_id": "7b25578d-4051-4b0f-92ce-f80944e543f7",
      "board_id": "f3017414-1234-4abc-9def-0123456789ab",
      "template_id": null,
      "status_id": "ab12cd34-5678-4abc-9def-0123456789ab",
      "ticket_number": 123,
      "title": "Refund for order #456",
      "description": "Customer received a defective unit. Requesting full refund.",
      "priority": "HIGH",
      "assigned_to": null,
      "conversation_id": "04d5172a-8a14-4f0c-b714-0f6c9ee27a20",
      "is_done": false,
      "done_at": null,
      "position": 0,
      "created_by": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
      "created_at": "2026-05-15T10:08:56.421Z",
      "updated_at": "2026-05-18T11:04:43.129Z",
      "status": {
        "id": "ab12cd34-5678-4abc-9def-0123456789ab",
        "name": "New Order",
        "color": "#6B7280"
      },
      "assigned_user": null,
      "created_by_user": {
        "id": "8c2f7b6e-4d9a-4b1f-9e3c-1a5d8b7a2c4e",
        "full_name": "Sarah Johnson"
      },
      "conversation": {
        "id": "04d5172a-8a14-4f0c-b714-0f6c9ee27a20",
        "subject": "Refund issue"
      },
      "assignees": [
        {
          "id": "asg-1-12345678",
          "ticket_id": "tkt-1-12345678-1234-4abc-9def-0123456789ab",
          "user_id": "e25d8c89-2b1f-4d3e-9a4c-8f0b1d2e3f4a",
          "assigned_at": "2026-05-15T10:08:56.421Z",
          "user": {
            "id": "e25d8c89-2b1f-4d3e-9a4c-8f0b1d2e3f4a",
            "full_name": "Sarah Johnson",
            "avatar_url": null
          }
        }
      ],
      "_count": {
        "activities": 5
      }
    }
  }
}

json

application/json

Mark a ticket done (or reopen)

PATCH

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}/mark-done

Flips is_done (+ done_at) directly — no status change required. Mirrors the dashboard's mark-done endpoint so boards without a is_default-flagged status can still surface a one-tap Mark done affordance on mobile.

Pass {"is_done": false} to reopen. Empty body defaults to mark-as-done. Idempotent — calling with the requested value when the ticket is already in that state still returns 200.

Mark a ticket done (or reopen) › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

Mark a ticket done (or reopen) › Request Body optional

Body optional — omitting it defaults to `is_done=true` (mark as done). Pass `false` to reopen.

is_done

boolean | null

Mark a ticket done (or reopen) › Responses

Ticket updated (or already in the requested state — idempotent).

success

boolean

object

PATCH/tickets/{ticket_id}/mark-done

curl --request PATCH \
  --url https://api.chatmo.io/v1/open-api/tickets/:ticket_id/mark-done \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_done": true
}
'

shell

Example Request Body

{
  "is_done": true
}

json

Example Responses

{
  "success": true,
  "code": 200,
  "message": "ticket updated",
  "data": {
    "ticket": {
      "id": "f3017414-1234-4abc-9def-0123456789ab",
      "organization_id": "7b25578d-4051-4b0f-92ce-f80944e543f7",
      "board_id": "ab12cd34-5678-4abc-9def-0123456789ab",
      "template_id": null,
      "status_id": "ab12cd34-5678-4abc-9def-0123456789ab",
      "ticket_number": 123,
      "title": "Refund for order #456",
      "description": "Customer requested a refund after a delivery delay.",
      "priority": "MEDIUM",
      "assigned_to": "9d8a4ce1-9c14-4f72-bb20-7a8b81d7bd31",
      "conversation_id": "55555555-5555-4555-9555-555555555555",
      "is_done": true,
      "done_at": "2026-05-26T07:02:18Z",
      "position": 7,
      "created_by": "9d8a4ce1-9c14-4f72-bb20-7a8b81d7bd31",
      "created_at": "2026-05-20T08:11:00Z",
      "updated_at": "2026-05-26T07:02:18Z",
      "status": {
        "id": "ab12cd34-5678-4abc-9def-0123456789ab",
        "name": "In Progress",
        "color": "#3B82F6"
      },
      "assigned_user": {
        "id": "9d8a4ce1-9c14-4f72-bb20-7a8b81d7bd31",
        "full_name": "Alice Sutanto",
        "avatar_url": null
      },
      "created_by_user": {
        "id": "9d8a4ce1-9c14-4f72-bb20-7a8b81d7bd31",
        "full_name": "Alice Sutanto"
      },
      "conversation": {
        "id": "55555555-5555-4555-9555-555555555555",
        "subject": "Order #456 — delivery issue"
      },
      "assignees": [
        {
          "id": "66666666-6666-4666-9666-666666666666",
          "ticket_id": "f3017414-1234-4abc-9def-0123456789ab",
          "user_id": "9d8a4ce1-9c14-4f72-bb20-7a8b81d7bd31",
          "assigned_at": "2026-05-20T08:12:00Z",
          "user": {
            "id": "9d8a4ce1-9c14-4f72-bb20-7a8b81d7bd31",
            "full_name": "Alice Sutanto",
            "avatar_url": null
          }
        }
      ],
      "products": [],
      "attachments": [],
      "field_values": [],
      "_count": {
        "activities": 4
      }
    }
  }
}

json

application/json

Labels Ticket Comments

List tickets

GET

https://api.chatmo.io/v1/open-api

/tickets

sort always prepends position ASC as the primary key (kanban order), UNLESS conversation_id is set — in that case kanban order is irrelevant and only the user-selected key is applied.

Performance: 7 queries flat — list + count + batched (statuses, users, conversations, assignees, activity-counts). No N+1.

List tickets › query Parameters

board_id

string · uuid

status_id

string · uuid

priority

string

Comma-separated: LOW,MEDIUM,HIGH,URGENT.

assigned_to

string

Comma-separated UUIDs. Matches legacy assigned_to OR junction ticket_assignees.

created_by

string

Comma-separated UUIDs.

conversation_id

string · uuid

Tickets linked to a specific chat. Disables position sort.

search

string · maxLength: 200

ILIKE across title, description, cast(ticket_number AS TEXT).

is_done

boolean

date_from

string · date

YYYY-MM-DD or RFC 3339. Inclusive lower bound on created_at.

date_to

string · date

YYYY-MM-DD or RFC 3339. Inclusive upper bound on created_at. Bare dates are auto-bumped to end-of-day.

sort

string · enum

Enum values:

newest

oldest

updated_recently

urgent_first

Default: newest

page

integer · min: 1 · max: 500

1-indexed page number. Capped at 500 to bound deep-scan cost.

Default: 1

limit

integer · min: 1 · max: 100

Rows per page. Capped at 100.

Default: 50

List tickets › Responses

Tickets page.

success

boolean

object

Create a ticket

POST

https://api.chatmo.io/v1/open-api

/tickets

Create a ticket › Request Body

board_id

string · uuid · required

status_id

string · uuid · required

Must belong to board_id.

title

string · minLength: 1 · maxLength: 255 · required

description

string · maxLength: 5000

priority

string · enum

Enum values:

LOW

MEDIUM

HIGH

URGENT

Default: MEDIUM

template_id

string · uuid

assigned_to

string · uuid

Legacy single assignee.

assigned_to_ids

string[]

Multi-assignee array. Inserted into ticket_assignees.

conversation_id

string · uuid

object[]

Create a ticket › Responses

Ticket created with all relations inlined.

success

boolean

code

integer

object

Get a ticket

GET

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}

Get a ticket › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

Get a ticket › Responses

Ticket detail.

success

boolean

object

Delete a ticket

DELETE

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}

Soft-delete (deleted_at + deleted_by). The row stops surfacing in every list / detail / search query immediately.

Delete a ticket › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

Delete a ticket › Responses

Ticket deleted.

success

boolean

message

string

data

object | null

Update a ticket

PATCH

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}

Partial update. Empty body returns 400 no editable fields in update request.

Update a ticket › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

Update a ticket › Request Body

All fields optional. Empty body returns 400.

title

string · minLength: 1 · maxLength: 255

description

string | null

Pass empty string to clear.

priority

string · enum

Enum values:

LOW

MEDIUM

HIGH

URGENT

status_id

string · uuid

Must belong to the same board. Flips is_done if the target status is the board's is_default.

assigned_to

string | null · uuid

assigned_to_ids

string[]

When present, REPLACES ticket_assignees (delete-all + create-all in one transaction).

conversation_id

string | null · uuid

template_id

string | null · uuid

object[]

Update a ticket › Responses

Updated ticket with all relations.

success

boolean

object

Mark a ticket done (or reopen)

PATCH

https://api.chatmo.io/v1/open-api

/tickets/{ticket_id}/mark-done

Pass {"is_done": false} to reopen. Empty body defaults to mark-as-done. Idempotent — calling with the requested value when the ticket is already in that state still returns 200.

Mark a ticket done (or reopen) › path Parameters

ticket_id

string · uuid · required

UUID of the ticket.

Mark a ticket done (or reopen) › Request Body optional

Body optional — omitting it defaults to `is_done=true` (mark as done). Pass `false` to reopen.

is_done

boolean | null

Mark a ticket done (or reopen) › Responses

Ticket updated (or already in the requested state — idempotent).

success

boolean

object