Skip to content
Products
/
/
/
M10 - Retrieve a thread

M10 - Retrieve a thread

Request

Call Frequency
Recommended usage: Synchronous only - At each page that includes a message thread display
Maximum usage: Synchronous only - At each page that includes a message thread display
Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_OFFER_MESSAGE_READROLE_PARTNER_MESSAGE_READ)
Path
thread_idstringrequired

The identifier of the thread to retrieve.

Query
shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/inbox/threads/{thread_id}?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
authorized_participantsArray of objectsrequired

Thread authorized participants
Those are the participants who are authorized to join the thread.

current_participantsArray of objectsrequired

Thread current participants
Those are the participants who have actually participated in the thread, meaning that they are either sender or receivers of at least one message of the thread.
These participants must be on the list of the authorized_participants

customer_organizationobject

Data related to the customer organization (B2B transactions)

date_createdstring, (date-time)required

Thread created date

date_updatedstring, (date-time)required

Thread updated date

entitiesArray of objects

Thread entities

idstringrequired

Thread id

messagesArray of objectsrequired

Thread messages

metadataobjectrequired

Thread metadata

no_store_reply_neededArray of objects

Thread "no store reply needed" actions.

topicobjectrequired

Thread topic

Response
{
  "authorized_participants": [
    { … },
    { … }
  ],
  "current_participants": [
    { … },
    { … }
  ],
  "customer_organization": {
    "display_name": "Customer organization",
    "id": "customer-org-id"
  },
  "date_created": "2018-10-02T08:36:36.479Z",
  "date_updated": "2018-10-03T09:40:17.241Z",
  "entities": [
    { … }
  ],
  "id": "702c3e56-dcca-41e2-b6bd-72ba3fa809be",
  "messages": [
    { … },
    { … }
  ],
  "metadata": {
    "last_message_date": "2018-10-03T09:40:17.241Z",
    "last_sender": { … },
    "shop_reply_needed_since": null,
    "total_count": 2
  },
  "no_store_reply_needed": [],
  "topic": {
    "type": "FREE_TEXT",
    "value": "Questions about my order"
  }
}