List the users assigned to a customer

GET/v1/api/store/{team_slug}/customer/{id}/assign

v1Operation ID v1_public_customer_assign_index

Lists the team members assigned to the customer. People who have left the team are left out. Members whose role has Manage Customers at "Manage Assigned to User" list and change only the customers they are assigned to.

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

  The customer's id (id from List customers or Create a customer). A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example uAu3dAKIaHyAYk

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (3)

  • idstringrequired

    The user id.

  • namestring | nullrequired
  • avatar_urlstring | null
• 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 live customer with this id in the team: deleted customers are not found here. error.code is null and error.message names the record type.

  Fix

  Check the id. Find deleted customers with the trashed_only filter and restore them first.

Related

• PUTAssign or unassign a user on a customer/v1/api/store/{team_slug}/customer/{id}/assign

Example request

curl

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

Example response 200

Response

{
  "data": [
    {
      "avatar_url": "https://example.com/avatars/alex.png",
      "id": "lOURnovd3hkIQI",
      "name": "Alex Rivera"
    }
  ],
  "status": 200,
  "success": true
}