List tags

GET/v1/api/store/{team_slug}/tag

v1Operation ID v1_public_tag_index

Lists the team's tags, each with id, name and color_hex. The same tags are used on customers and on sales orders. The list is paged: pagination gives total, count, perPage, currentPage and totalPages. Ask for the next page with page; the page size is the team's setting (50 unless changed), and per_page is ignored.

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

Query parameters

• pageinteger

  The page to return. Pages hold the team's page size (pagination_per_page in team settings: 50 unless changed, 5 to 100). per_page is not read here.

  • Default 1
  • Minimum 1
  • Example 1

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (3)

  • color_hexstring | nullrequired

    Such as #2563EB. Null for a tag saved without a color.

  • idstringrequired
  • namestringrequired
• statusintegerrequired
• successbooleanrequired
• paginationobject
  Child fields (6)

  • countintegerrequired
  • currentPageintegerrequired
  • linksobject | array of anyrequired

    Links to the neighbouring pages: previous and next, each present only when that page exists. An empty list, [], when there is only one page.

    Child fields (2)

    • nextstring (uri)

      The next page.

    • previousstring (uri)

      The previous page.

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

Related

• POSTCreate a tag/v1/api/store/{team_slug}/tag
• PUTTag a customer/v1/api/store/{team_slug}/customer/{hash_id}/tag/attach
• PUTTag an order/v1/api/store/{team_slug}/sales_order/{hash_id}/tag/attach

Example request

curl

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

Example response 200

Response

{
  "data": [
    {
      "color_hex": "#2563EB",
      "id": "zzVW0sylTIm6oo",
      "name": "Wholesale"
    }
  ],
  "pagination": {
    "count": 1,
    "currentPage": 1,
    "links": [],
    "perPage": 50,
    "total": 1,
    "totalPages": 1
  },
  "status": 200,
  "success": true
}