Get a message participant

GET/v1/api/store/{team_slug}/participant/{id}

v1Operation ID v1_public_participant_show

Returns one person on an order's or purchase order's message thread: who they are (type), how to reach them, and what they receive (status, can_receive_mail, can_receive_sms).

To list or add participants, use the sales order participant operations.

Permission

Any member of the team, for any participant on the team.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• idstringrequired

  The participant's id, from the order's participant list. A hash id; unique keys and document numbers are refused with 404.

  • Example vKNPqQz8fsYDuT

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (24)

  • can_receive_mailboolean
  • can_receive_smsboolean
  • contactobject | null

    The contact's own record (id, first_name, last_name, email, phone, phone_country, customer_id or vendor_id, and more). Null when the participant has no contact.

  • contact_idstring | null
  • delivery_channelstring | null

    Always null here. Set only when the participant is read as one of a message's recipients.

  • delivery_created_atstring | null

    Always null here. Set only when the participant is read as one of a message's recipients.

  • delivery_destinationstring | null

    Always null here. Set only when the participant is read as one of a message's recipients.

  • delivery_destination_namestring | null

    Always null here. Set only when the participant is read as one of a message's recipients.

  • delivery_idstring | null

    Always null here. Set only when the participant is read as one of a message's recipients.

  • delivery_latest_error_reasonstring | null

    Always null here. Set only when the participant is read as one of a message's recipients.

  • delivery_message_idstring | null

    Always null here. Set only when the participant is read as one of a message's recipients.

  • delivery_participant_idstring | null

    Always null here. Set only when the participant is read as one of a message's recipients.

  • delivery_statestring | null

    Always null here. Set only when the participant is read as one of a message's recipients.

  • delivery_statusstring | null

    Always null here. Set only when the participant is read as one of a message's recipients.

  • delivery_updated_atstring | null

    Always null here. Set only when the participant is read as one of a message's recipients.

  • emailstring | null
  • idstring
  • namestring | null
  • order_idstring | null
  • phonestring | null

    A contact's phone. Null for team members and guests.

  • purchase_order_idstring | null
  • statusstring

    What they get. The emails and texts YoPrint sends on the order by itself (approval requests, order details, reminders) go only to all and message; notification and disabled get none of them.

    • One of: "message", "notification", "all", "disabled"
  • trashedboolean

    Always false here: a removed participant answers 404.

  • typestring

    user: a team member. contact: one of the customer's or vendor's contacts (name, email and phone come from the contact). guest: just a name and email.

    • One of: "user", "contact", "guest"
• statusintegerrequired
• successbooleanrequired

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.

  When

  No participant of this team has this id, or it was removed.

  Fix

  Use an id from the order's participant list.

Related

• PATCHChange a message participant without checks/v1/api/store/{team_slug}/participant/{id}
• DELETERemove a message participant/v1/api/store/{team_slug}/participant/{id}
• GETList the participants of an order/v1/api/store/{team_slug}/sales_order/{hash_id}/participant

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/participant/vKNPqQz8fsYDuT' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": {
    "can_receive_mail": true,
    "can_receive_sms": false,
    "contact": {
      "created_at": "2026-11-01T09:00:00+00:00",
      "customer_id": "63KcENAAsKuipY",
      "default_receive_sms": false,
      "email": "jordan@example.com",
      "external_type": null,
      "fax": null,
      "fax_country": null,
      "first_name": "Jordan",
      "id": "uTCR3hxPDePBUK",
      "is_external": false,
      "is_primary": true,
      "last_name": "Lee",
      "phone": "+1 201 555 0123",
      "phone_country": "US",
      "send_invoice": true,
      "trashed": false,
      "updated_at": "2026-11-01T09:00:00+00:00"
    },
    "contact_id": "uTCR3hxPDePBUK",
    "delivery_channel": null,
    "delivery_created_at": null,
    "delivery_destination": null,
    "delivery_destination_name": null,
    "delivery_id": null,
    "delivery_latest_error_reason": null,
    "delivery_message_id": null,
    "delivery_participant_id": null,
    "delivery_state": null,
    "delivery_status": null,
    "delivery_updated_at": null,
    "email": "jordan@example.com",
    "id": "vKNPqQz8fsYDuT",
    "name": "Jordan Lee",
    "order_id": "V4keXwwxMQyXw7",
    "phone": "+1 201 555 0123",
    "purchase_order_id": null,
    "status": "all",
    "trashed": false,
    "type": "contact"
  },
  "status": 200,
  "success": true
}