Get a Tag

GET /tags/{tag_name}

Retrieve an existing tag for your organization by the value of its name field.

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Path parameters

  • tag_name string Required

    The name field for a tag resource

Responses

  • 200 application/json

    A tag resource

    Hide headers attributes Show headers attributes
    Hide response attributes Show response 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

      The user ID associated with the user who created the tag when applicable.

    • description string | null

      An optional, brief description for this tag.

    • id string

      A UUID identifier for the tag.

    • 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

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

    • updated_by integer | null

      The user ID associated with the last user to edit the tag when applicable.
GET /tags/{tag_name} 
curl \
 -X GET https://api.arta.io/tags/{tag_name} \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200) 
{
  "id": "39fdd1c1-4bae-4235-9ea8-412c63d2be90",
  "name": "ny-warehouse",
  "color": "008000",
  "is_active": true,
  "created_at": "2024-09-05T15:00:46.905529",
  "created_by": 1,
  "updated_at": "2024-09-25T17:58:47.918049",
  "updated_by": null,
  "description": null
}