List a vendor's contacts

GET/v1/api/store/{team_slug}/vendor/{hash_id}/contact

v1Operation ID v1_public_vendor_contact_index

Lists every contact of the vendor, deleted ones included (trashed). Not paged, in no set order. Warning: YoPrint does not verify that the vendor ID exists. Passing an unknown or deleted vendor ID returns an empty list [] instead of a 404.

Permission

Any member of the team.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The vendor's id (id from List vendors). A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example EDhVUaC6jbLbed

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (18)

  • created_atstring (date-time)required
  • first_namestring | nullrequired
  • idstringrequired
  • is_primarybooleanrequired
  • trashedbooleanrequired

    True when the contact is deleted.

  • updated_atstring (date-time)required
  • customer_idstring

    Customer contacts only.

  • default_receive_smsboolean
  • emailstring | null
  • external_typestring | null
  • faxstring | null
  • fax_countrystring | null
  • is_externalboolean

    True for a contact synced from Shopify; such contacts are read-only.

  • last_namestring | null
  • phonestring | null
  • phone_countrystring | null
  • send_invoiceboolean

    Customer contacts only.

  • vendor_idstring

    Vendor contacts only.

• 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.

Related

• POSTAdd a contact to a vendor/v1/api/store/{team_slug}/vendor/{hash_id}/contact

Example request

curl

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

Example response 200

Response

{
  "data": [
    {
      "created_at": "2026-11-01T09:00:00+00:00",
      "default_receive_sms": false,
      "email": "sam@example.com",
      "external_type": null,
      "fax": null,
      "fax_country": null,
      "first_name": "Sam",
      "id": "fopJXRDkZ8Qk7S",
      "is_external": false,
      "is_primary": true,
      "last_name": "Lee",
      "phone": "+1 201 555 0123",
      "phone_country": "US",
      "trashed": false,
      "updated_at": "2026-11-01T09:00:00+00:00",
      "vendor_id": "MFwvMEIK7ud89l"
    }
  ],
  "status": 200,
  "success": true
}