Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Project Management

Conversations

5 endpoints5 implementedAll modules →
  1. GET /rest/v1.0/projects/{project_id}/conversationsList conversations the caller participates in
  2. POST /rest/v1.0/projects/{project_id}/conversationsCreate a conversation
  3. GET /rest/v1.0/projects/{project_id}/conversations/{id}Show a conversation with a bounded message window
  4. POST /rest/v1.0/projects/{project_id}/conversations/{id}/messagesPost a message to a conversation
  5. PATCH /rest/v1.0/projects/{project_id}/conversations/{id}/readMark a conversation read for the caller
GET /rest/v1.0/projects/{project_id}/conversations

List conversations the caller participates in

v1.0Implemented

Parameters

  • page
    integerquery
  • per_page
    integerquery
  • search
    stringquery
  • project_id
    stringpathrequired

Response · 200 · ConversationListItem[]

  • id
    integerrequired
  • project_id
    integerrequired
  • subject
    stringrequired
  • title
    stringrequired
  • is_group
    booleanrequired
  • created_by
    UserStub
  • participants
    Participant[]required
  • participant_count
    integerrequired
  • message_count
    integerrequired
  • last_message
    objectrequired
  • unread_count
    integerrequired
  • created_at
    stringrequired
  • updated_at
    string
POST /rest/v1.0/projects/{project_id}/conversations

Create a conversation

v1.0Implemented

Parameters

  • project_id
    stringpathrequired

Response · 201 · ConversationShow

  • id
    integerrequired
  • project_id
    integerrequired
  • subject
    stringrequired
  • title
    stringrequired
  • is_group
    booleanrequired
  • created_by
    UserStub
  • participants
    Participant[]required
  • participant_count
    integerrequired
  • messages
    Message[]required
  • message_count
    integerrequired
  • has_older
    booleanrequired
  • older_cursor
    stringrequired
  • window_count
    integerrequired
  • read_through
    stringrequired
  • unread_count
    integerrequired
  • created_at
    stringrequired
  • updated_at
    string
GET /rest/v1.0/projects/{project_id}/conversations/{id}

Show a conversation with a bounded message window

v1.0Implemented

Parameters

  • before
    stringquery
  • per_page
    integerquery
  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · ConversationShow

  • id
    integerrequired
  • project_id
    integerrequired
  • subject
    stringrequired
  • title
    stringrequired
  • is_group
    booleanrequired
  • created_by
    UserStub
  • participants
    Participant[]required
  • participant_count
    integerrequired
  • messages
    Message[]required
  • message_count
    integerrequired
  • has_older
    booleanrequired
  • older_cursor
    stringrequired
  • window_count
    integerrequired
  • read_through
    stringrequired
  • unread_count
    integerrequired
  • created_at
    stringrequired
  • updated_at
    string
POST /rest/v1.0/projects/{project_id}/conversations/{id}/messages

Post a message to a conversation

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 201 · ConversationShow

  • id
    integerrequired
  • project_id
    integerrequired
  • subject
    stringrequired
  • title
    stringrequired
  • is_group
    booleanrequired
  • created_by
    UserStub
  • participants
    Participant[]required
  • participant_count
    integerrequired
  • messages
    Message[]required
  • message_count
    integerrequired
  • has_older
    booleanrequired
  • older_cursor
    stringrequired
  • window_count
    integerrequired
  • read_through
    stringrequired
  • unread_count
    integerrequired
  • created_at
    stringrequired
  • updated_at
    string
PATCH /rest/v1.0/projects/{project_id}/conversations/{id}/read

Mark a conversation read for the caller

v1.0Implemented

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Request body

  • through
    string
  • last_read_at
    string (date-time)

Response · 200 · ConversationShow

  • id
    integerrequired
  • project_id
    integerrequired
  • subject
    stringrequired
  • title
    stringrequired
  • is_group
    booleanrequired
  • created_by
    UserStub
  • participants
    Participant[]required
  • participant_count
    integerrequired
  • messages
    Message[]required
  • message_count
    integerrequired
  • has_older
    booleanrequired
  • older_cursor
    stringrequired
  • window_count
    integerrequired
  • read_through
    stringrequired
  • unread_count
    integerrequired
  • created_at
    stringrequired
  • updated_at
    string

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file