List tags

GET /tags

Retrieve a paginated collection of tags belonging to your organization.

Tags allow you to categorize and organize Shipments, Requests, and other resources for easier tracking and filtering. They can be created, updated, and archived by setting is_active to false. Archived tags remain linked to existing records but cannot be associated with new ones. If needed, tags can be reactivated later.

Tags are global for an organization and shared across both Live and Test modes.

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Query parameters

  • page_size integer

    Results per page (max 50).

    Default value is 20.

  • page integer

    Page number of the results to fetch.

    Default value is 1.

Responses

  • 200 application/json

    A paginated list of tag resources

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • items array[object]
      Hide items attributes Show items attributes object
      • color string

        The hexadecimal color code for the tag, without the leading #.

      • created_at string

        A NaiveDatetime-formatted timestamp describing when the tag was created with microsecond precision.

      • created_by integer | null
      • description string | null

        An optional, brief description for the tag.

      • id string
      • is_active boolean

        Indicates whether or not the tag is active. Inactive tags may not be associated to new resources.

      • name string

        The name for the tag. It may contain lower case letters, dashes, and alphanumeric characters only. The maximum character count is 50.

      • updated_at string
      • updated_by integer | null
    • metadata object
      Hide metadata attributes Show metadata attributes object
GET /tags 
curl \
 -X GET https://api.arta.io/tags \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200) 
{
  "items": [
    {
      "id": "f7e4b35b-5131-47c2-9a88-238bd6e62e2d",
      "name": "ny-warehouse",
      "color": "008000",
      "is_active": false,
      "created_at": "2024-09-25T19:17:54.871490",
      "created_by": null,
      "updated_at": "2024-09-25T19:19:01.648283",
      "updated_by": null,
      "description": null
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "is_estimate": false,
    "total_count": 1
  }
}