Conversations between buyers, sellers and the marketplace. Generated from the OpenAPI spec. Each endpoint says which key it needs; see Authentication.
| Method | Path | What it does |
|---|---|---|
| GET | /v1/me/conversations |
The signed-in user’s conversations |
| POST | /v1/me/conversations |
Message the seller, the buyer or the marketplace |
| GET | /v1/me/conversations/{id}/messages |
Read a conversation |
| POST | /v1/me/conversations/{id}/messages |
Reply in a conversation |
The signed-in user’s conversations
Section titled “The signed-in user’s conversations”GET /v1/me/conversations · operation listMyConversations
Latest first, with the last message and how many are unread.
Auth: your secret key (Authorization: Bearer sk_…) and the user’s session (X-User-Session: …), from your server
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
limit |
query | integer | ≥ 1; ≤ 100; default 50 |
offset |
query | integer | ≥ 0 |
Responses: 200 ConversationListOutputBody · default a problem
Message the seller, the buyer or the marketplace
Section titled “Message the seller, the buyer or the marketplace”POST /v1/me/conversations · operation startConversation
About a listing (a question before buying), an order (its buyer or seller), or support (the marketplace). Continues the existing conversation if there is one.
Auth: your secret key (Authorization: Bearer sk_…) and the user’s session (X-User-Session: …), from your server
Body (application/json): StartConversationRequest
Responses: 201 StartConversationResponse · default a problem
Read a conversation
Section titled “Read a conversation”GET /v1/me/conversations/{id}/messages · operation readMyConversation
Oldest first; marks them read.
Auth: your secret key (Authorization: Bearer sk_…) and the user’s session (X-User-Session: …), from your server
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
id * |
path | string | |
after |
query | integer | Only messages after this id. ≥ 0 |
limit |
query | integer | ≥ 1; ≤ 200; default 100 |
Responses: 200 MessagesOutputBody · default a problem
Reply in a conversation
Section titled “Reply in a conversation”POST /v1/me/conversations/{id}/messages · operation sendMessage
Auth: your secret key (Authorization: Bearer sk_…) and the user’s session (X-User-Session: …), from your server
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
id * |
path | string |
Body (application/json): MessageInput
Responses: 201 MessageBody · default a problem
Schemas
Section titled “Schemas”Fields marked * are always present in responses and required in requests.
ConversationListOutputBody
Section titled “ConversationListOutputBody”| Field | Type | Notes |
|---|---|---|
items * |
ConversationBody[] |
StartConversationRequest
Section titled “StartConversationRequest”| Field | Type | Notes |
|---|---|---|
body * |
string | max 5000 chars |
listing_id |
string | |
order_id |
string | |
support |
boolean | To the marketplace |
StartConversationResponse
Section titled “StartConversationResponse”| Field | Type | Notes |
|---|---|---|
conversation * |
ConversationBody | |
message * |
MessageBody |
MessagesOutputBody
Section titled “MessagesOutputBody”| Field | Type | Notes |
|---|---|---|
items * |
MessageBody[] |
MessageInput
Section titled “MessageInput”| Field | Type | Notes |
|---|---|---|
body * |
string | max 5000 chars |
MessageBody
Section titled “MessageBody”| Field | Type | Notes |
|---|---|---|
at * |
string (date-time) | |
body * |
string | |
from_marketplace * |
boolean | Written by the marketplace (support) |
id * |
integer | |
sender_id |
string | The user who wrote it |
ConversationBody
Section titled “ConversationBody”| Field | Type | Notes |
|---|---|---|
id * |
string | |
kind * |
string | one of listing, order, support |
last_message |
string | |
last_message_at * |
string (date-time) | |
listing_id |
string | |
order_id |
string | |
unread * |
integer | |
user_a * |
string | The buyer, or the user asking for support |
user_b |
string | The seller (not in support conversations) |