Shipeasy
APIOperations

List the project's tags

Sorted by name.

Sorted by name.

Use case

See which tags already exist before tagging an item, so you reuse ios instead of minting iOS-app.

GET
/api/admin/tags

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Query Parameters

q?string

Case-insensitive substring filter on the tag name. Omit to return every tag.

Lengthlength <= 64

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://shipeasy.ai/api/admin/tags"
[
  {
    "id": "tag_01j7w8a1b2c3d4e5f6g7h8i9j0",
    "name": "checkout"
  },
  {
    "id": "tag_01j7w8a1b2c3d4e5f6g7h8i9j1",
    "name": "ios"
  }
]
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?