# M11 - List all threads

You may want to retrieve the threads linked to a specific entity, using both entity_type and entity_id.
For example, to retrieve threads for an order, use entity_type=MMP_ORDER&entity_id=my-order-1.

Available values for entity_type are:

MMP_ORDER: for threads on product orders
MMP_OFFER: for threads on offers
MPS_ORDER: for threads on service orders
MPS_SERVICE: for threads on services
SELLER_OPERATOR: for threads between sellers and operator


This resource uses seek pagination. The default value for parameter limit is 50.
Call FrequencyRecommended usage: Synchronous only - At each page that includes an inbox displayMaximum usage: Synchronous only - At each page that includes an inbox displayPaginationThis resource supports seek pagination (see documentation)

Endpoint: GET /api/inbox/threads

## Query parameters:

  - `entity_type` (string)
    Entity type to include in result (default: include all). Available values: MMP_ORDER, MMP_OFFER, MPS_ORDER, MPS_SERVICE, SELLER_OPERATOR

  - `entity_id` (array)
    Comma separated list of Entity id to include in result (default: include all). The entity_type must be specified to use this filter, otherwise an error 400 will be returned. Example of an entity_id query: entity_id=order1-A,order20-A,order13-A&entity_type=MMP_ORDER

  - `updated_since` (string)
    Retrieve threads modified at or after this date.

  - `with_messages` (boolean)
    True to include message details. Limited to the last 100 messages received on each thread.

  - `channel_codes` (array)
    List of the channel codes to filter with, using a comma (,) as a separator.
 If specified, only order messages linked to the given channels will be returned (Whatever the value of entity_type).
 Otherwise, messages will be returned regardless of their channels.

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

## Response 200 fields (application/json):

  - `data` (array, required)
    Page of data

  - `data.authorized_participants` (array, required)
    Thread authorized participants
Those are the participants who are authorized to join the thread.

  - `data.authorized_participants.display_name` (string, required)
    Participant display name

  - `data.authorized_participants.id` (string)
    Participant idWhen type equals OPERATOR, no id will be returned.

  - `data.authorized_participants.type` (string, required)
    Participant type
    Enum: "OPERATOR", "SHOP", "CUSTOMER"

  - `data.current_participants` (array, required)
    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

  - `data.customer_organization` (object)
    Data related to the customer organization (B2B transactions)

  - `data.customer_organization.display_name` (string, required)
    Customer organization name

  - `data.customer_organization.id` (string, required)
    Customer organization id

  - `data.date_created` (string, required)
    Thread created date

  - `data.date_updated` (string, required)
    Thread updated date

  - `data.entities` (array)
    Thread entities

  - `data.entities.id` (string, required)
    Entity id

  - `data.entities.label` (string, required)
    Entity label

  - `data.entities.type` (string, required)
    Entity type

  - `data.id` (string, required)
    Thread id

  - `data.messages` (array)
    Thread messages. Limited to the last 100 messages of the thread. Present if with_messages query parameter has been set to true

  - `data.messages.attachments` (array)
    Message attachments

  - `data.messages.attachments.id` (string, required)
    Attachment id

  - `data.messages.attachments.name` (string, required)
    Attachment file name

  - `data.messages.attachments.size` (integer, required)
    Attachment size

  - `data.messages.body` (string, required)
    Message body

  - `data.messages.date_created` (string, required)
    Message creation date

  - `data.messages.from` (object, required)
    Message sender

  - `data.messages.from.display_name` (string, required)
    Sender display name

  - `data.messages.from.organization_details` (object)
    Organization details of the sender

  - `data.messages.from.type` (string, required)
    Sender type
    Enum: "OPERATOR_USER", "SHOP_USER", "CUSTOMER_USER"

  - `data.messages.id` (string, required)
    Message id

  - `data.messages.to` (array, required)
    Message recipients

  - `data.metadata` (object, required)
    Thread metadata

  - `data.metadata.last_message_date` (string, required)
    Date of the last message

  - `data.metadata.last_sender` (object, required)
    Last message sender

  - `data.metadata.shop_reply_needed_since` (string, required)
    Date since a shop response is needed in the thread

  - `data.metadata.total_count` (integer, required)
    Number of messages in the thread

  - `data.no_store_reply_needed` (array)
    Thread "no store reply needed" actions. Present if "with_messages" query parameter has been set to true.

  - `data.no_store_reply_needed.date` (string, required)
    No store reply needed action date

  - `data.no_store_reply_needed.user_type` (string, required)
    Entity that operated "no store reply needed" action.
    Enum: "OPERATOR", "SHOP"

  - `data.topic` (object, required)
    Thread topic

  - `data.topic.type` (string, required)
    Topic type
    Enum: "FREE_TEXT", "REASON_CODE"

  - `data.topic.value` (string, required)
    Topic value

  - `next_page_token` (string)
    Token to access the next page. Absent if the current page is the last one.

  - `previous_page_token` (string)
    Token to access the previous page. Absent if the current page is the first one.