Skip to main content
GET
/
finops
/
v1
/
tags
/
{tag_id}
Get a tag by ID
curl --request GET \
  --url https://api.sandbox.tesouro.com/finops/v1/tags/{tag_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-finops-version: <x-finops-version>' \
  --header 'x-organization-id: <x-organization-id>'
{
  "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
  "created_at": "2022-09-07T16:35:18.484507+00:00",
  "updated_at": "2022-09-07T16:35:18.484507+00:00",
  "name": "Marketing",
  "category": "department",
  "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
  "description": "Tag for the Marketing Department"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-finops-version
string<date>
required
​
x-organization-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

​
tag_id
string<uuid>
required

Response

Successful Response

Represents a user-defined tag that can be assigned to resources to filter them.

​
id
string<uuid>
required

A unique ID of this tag.

Example:

"ea837e28-509b-4b6a-a600-d54b6aa0b1f5"

​
created_at
string<date-time>
required

Date and time when the tag was created. Timestamps follow the ISO 8601 standard.

Example:

"2022-09-07T16:35:18.484507+00:00"

​
updated_at
string<date-time>
required

Date and time when the tag was last updated. Timestamps follow the ISO 8601 standard.

Example:

"2022-09-07T16:35:18.484507+00:00"

​
name
string
required

The tag name.

Example:

"Marketing"

​
category
enum<string>

The tag category.

Available options:
document_type,
department,
project,
cost_center,
vendor_type,
payment_method,
approval_status
Example:

"department"

​
created_by_entity_user_id
string<uuid>

ID of the user who created the tag.

Example:

"ea837e28-509b-4b6a-a600-d54b6aa0b1f5"

​
description
string

The tag description.

Required string length: 1 - 255
Example:

"Tag for the Marketing Department"