RevKeenDocs
StatusSupport
API Reference

List conversation threads

List conversation threads for the authenticated merchant --- **Related endpoints** - `POST /comms/send` — Send a message - `GET /comms/threads/{threadId}/messages` — List messages in a thread **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

GET
/comms/threads

List conversation threads for the authenticated merchant

Related endpoints

  • POST /comms/send — Send a message
  • GET /comms/threads/{threadId}/messages — List messages in a thread

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Query Parameters

customerId?string

Filter by customer UUID

Formatuuid
status?string

Filter by thread status

Value in

  • "open"
  • "closed"
  • "pending"
channel?string

Filter by channel

invoiceId?string

Filter by related invoice UUID

Formatuuid
limit?number

Maximum number of results (1-100)

Range1 <= value <= 100
Default50
offset?|

Number of results to skip

Range0 <= value
Default0

Response Body

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/comms/threads" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "threads": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",      "subject": "string",      "status": "string",      "priority": "string",      "last_message_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "total": 0,  "limit": 0,  "offset": 0}

Send a message POST

Send a direct message to a customer via email, SMS, or WhatsApp --- **Related endpoints** - `GET /comms/threads` — List conversation threads - `GET /comms/threads/{threadId}/messages` — List messages in a thread **Common errors** - `400 invalid_request` — malformed payload or failed validation. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

Create a credit note POST

Issue a credit note for a paid or partially paid invoice. The credit can be applied via refund to payment method, customer balance, or marked as external. --- **Related endpoints** - `GET /credit_notes` — List credit notes - `GET /credit_notes/{id}` — Get credit note by ID - `POST /credit_notes/{id}/void` — Void a credit note - `GET /credit_notes/invoice/{invoice_id}/eligibility` — Check credit note eligibility for an invoice - `GET /credit_notes/transaction/{transaction_id}/reversal-eligibility` — Check reversal eligibility for a transaction - `GET /credit_notes/{id}/lines` — List line items on a credit note - `POST /credit_notes/preview` — Preview a credit note without creating it **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).