Skip to content
YoPrintDevelopers

List messages

Open .md

GET/v2/api/store/{team_slug}/messages

v2Operation ID v2_public_messages_index

Lists the messages on your team's sales orders, quotes and purchase orders, newest first: emails and texts you sent to customers and vendors, and the replies they sent back. YoPrint's internal staff notifications are not included.

Each message has its sender, a preview, what it is on, and delivery_summary, which tells you whether it reached everyone. The page size is your team's list size setting (50 unless changed); use page to read further. To filter, use POST /v2/api/store/{team_slug}/messages/filter.

Permission

Any member can read purchase order messages. For sales order and quote messages you need permission to message all orders, or only the orders you created or are assigned to. The team owner sees everything. Without either permission you see only purchase order messages.

Path parameters

  • team_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team

Query parameters

  • pageinteger

    The page to read, from 1.

    • Default 1
    • Minimum 1

Request body

This operation takes no request body.

Response

200Successful response.

  • dataarray of objectsrequired
    Fields of each item (32)
    • actor_namestring | null

      The writer's name, by actor_type: your team's name for system, the team member, the contact, the order's customer, the purchase order's vendor, the participant, or the name a guest gave. Null when YoPrint can't find the writer's record.

    • actor_typestring

      Who wrote it: user, customer, vendor, contact (written in the customer or vendor portal), participant, guest (someone who is not a contact) or system.

    • attachmentsarray of objects

      Files attached to it, in the same shape as an upload (id, name, file_name, mime_type, size, url).

    • contactobject | null

      The contact who wrote it, when contact_id is set: first_name, last_name, email, phone and more.

    • contact_idstring | null
    • created_atstring (date-time)
    • customerobject | null

      The order's customer. Null without an order.

      Child fields (2)
      • idinteger

        A plain number, not a hash id; no operation takes it.

      • namestring
    • delivery_summaryobject | null

      Outbound messages: how delivery went across all recipients. Null for inbound messages.

      Child fields (12)
      • acceptedinteger
      • completeboolean
      • deliveredinteger
      • failedinteger
      • reasonstring | null

        Why the state is not final, or why nothing was sent, for example no_recipients or delivery_evidence_unavailable. Usually null.

      • retryableboolean

        True when the retry operation accepts this message. When false, it answers 422.

      • skippedinteger
      • statestring

        sent: the provider took it, delivery not confirmed yet. partial: recipients are in different states. not_sent: there were no recipients.

        • One of: "pending", "sending", "sent", "delivered", "failed", "partial", "unknown", "not_sent"
      • submittinginteger
      • totalinteger
      • unknowninteger
      • waitinginteger
    • emailstring | null

      The sender's email address.

    • has_messageboolean
    • has_original_messageboolean
    • idstring
    • is_order_rushinteger | null

      1 for a rush order, 0 otherwise (a number, not a boolean); null for a message without an order.

      • One of: 0, 1
    • modestring | boolean

      The order's state in the web app: view once it is created, create while it is a draft, edit while someone is editing it. false (not null) without an order.

    • namestring | null

      The sender's name.

    • order_idstring | null

      The sales order or quote it is on.

    • order_object_typestring | null

      sales_order or quote. Null without an order.

    • order_quoteboolean | null
    • order_scoped_idstring | null

      The order's number, such as SO1001. Null without an order.

    • participantobject | null

      The author, as a message participant, when message_participant_id is set. Its delivery_* fields are null.

      Child fields (24)
    • preview_messagestring | null

      A short plain-text preview.

    • purchase_order_idstring | null

      The purchase order it is on.

    • purchase_scoped_idstring | null

      The purchase order's number. An empty string "" (not null) when it is not on a purchase order.

    • recipientsarray of objects

      Who it was sent to: each participant with its delivery (delivery_status, delivery_channel, delivery_destination). delivery_id is the id the recipient operations take.

      Fields of each item (24)
    • rendered_attachmentsarray of objects

      Everything attached when it was sent: the files (attachment_type media, upload shape) and generated documents such as the order PDF (attachment_type internal_attachment, with name and url).

    • statusstring | null

      Older delivery status word, such as pending, dispatched, partial_delivered, delivery_failed, delivered, or received for a reply. Prefer delivery_summary.

    • status_idstring | null

      Your team's message status (for example "Needs reply"), set with the status operation. Null when none is set.

    • systemboolean

      True for messages YoPrint sent automatically.

    • typestring

      outbound: sent by your team. inbound: a reply received.

      • One of: "outbound", "inbound"
    • userobject | null

      The team member who wrote it, when user_id is set. The list sends their whole account profile; rely only on id, name, email, avatar_url and timezone, which the single message also has.

    • user_idstring | null
    • vendorobject | null

      The purchase order's vendor. Null without a purchase order.

      Child fields (2)
      • idinteger

        A plain number, not a hash id; no operation takes it.

      • namestring
  • statusintegerrequired
  • successbooleanrequired
  • paginationobject
    Child fields (6)
    • countintegerrequired
    • currentPageintegerrequired
    • perPageintegerrequired
    • totalintegerrequired
    • totalPagesintegerrequired

Errors

  • 401The API key is missing or wrong (unauthenticated).

  • 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  • 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Notes

  • To read one message in full, with its body, use GET /v2/api/store/{team_slug}/messages/{hash_id}.
  • customer.id and vendor.id here are plain numbers, not the hash ids other operations take. Read the order or purchase order to reach them.

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI specSupport: support@yoprint.comyoprint.com