# Tags

Labels used to categorize, filter, and classify resources. Learn more about tags [here](https://docs.secoda.com/resource-and-metadata-management/tags/custom-tags).

## List Tags

> Get a list of tags. No filtering is currently available.

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Tags","description":"Labels used to categorize, filter, and classify resources. Learn more about tags [here](https://docs.secoda.com/resource-and-metadata-management/tags/custom-tags)."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/tag":{"get":{"tags":["Tags"],"summary":"List Tags","description":"Get a list of tags. No filtering is currently available.","responses":{"200":{"description":"List of tags.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/v1_ListResponse"},{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/v1_TagsResponse"}}}}]}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"v1_ListResponse":{"type":"object","properties":{"links":{"type":"object","description":"Indicates Links to associated pages.","properties":{"next":{"type":"string","description":"The link to the next page (null if there are no more pages)."},"previous":{"type":"string","description":"The link to the previous page (null if on the first page)."}}},"meta":{"type":"object","description":"Reprents the meta data of the response.","properties":{"page":{"type":"integer","description":"The current page number."},"previous_page":{"type":"integer","description":"The previous page number (null if on the first page)."},"next_page":{"type":"integer","description":"The next page number (null if on the last page)."}}},"count":{"type":"integer","description":"The total count of items returned."},"total_pages":{"type":"integer","description":"The total number of pages."}}},"v1_TagsResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"name":{"type":"string","description":"Indicates the name of the tag."},"description":{"type":"string","description":"Indicates the description of the tag."},"color":{"type":"string","description":"Defines the different colors of the tags in HEX format."},"integration_id":{"type":"string","description":"The unique identifier of the integration the tag is pulled from. Null if the tag is created manually in Secoda."},"workspace_id":{"type":"string","description":"Indiactes the workspace ID where the tag belongs."}}}}}}
```

## Create Tag

> Create a new tag for the workspace.

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Tags","description":"Labels used to categorize, filter, and classify resources. Learn more about tags [here](https://docs.secoda.com/resource-and-metadata-management/tags/custom-tags)."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/tag":{"post":{"tags":["Tags"],"summary":"Create Tag","description":"Create a new tag for the workspace.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Indicates the name of the tag."},"description":{"type":"string","description":"Indicates the description of the tag."},"color":{"type":"string","description":"Defines the different colors of the tags."}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_TagsResponse"}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"v1_TagsResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"name":{"type":"string","description":"Indicates the name of the tag."},"description":{"type":"string","description":"Indicates the description of the tag."},"color":{"type":"string","description":"Defines the different colors of the tags in HEX format."},"integration_id":{"type":"string","description":"The unique identifier of the integration the tag is pulled from. Null if the tag is created manually in Secoda."},"workspace_id":{"type":"string","description":"Indiactes the workspace ID where the tag belongs."}}}}}}
```

## Get Tag

> Get a tag by its ID.

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Tags","description":"Labels used to categorize, filter, and classify resources. Learn more about tags [here](https://docs.secoda.com/resource-and-metadata-management/tags/custom-tags)."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/tag/{tag_id}":{"get":{"tags":["Tags"],"summary":"Get Tag","description":"Get a tag by its ID.","parameters":[{"name":"tag_id","in":"path","required":true,"description":"The ID of the tag to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1_TagsResponse"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"v1_TagsResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the resource."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was created in Secoda in UTC format."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the resource was last updated in Secoda in UTC format."},"name":{"type":"string","description":"Indicates the name of the tag."},"description":{"type":"string","description":"Indicates the description of the tag."},"color":{"type":"string","description":"Defines the different colors of the tags in HEX format."},"integration_id":{"type":"string","description":"The unique identifier of the integration the tag is pulled from. Null if the tag is created manually in Secoda."},"workspace_id":{"type":"string","description":"Indiactes the workspace ID where the tag belongs."}}}}}}
```

## Delete Tag

> Delete a tag by its ID.

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Tags","description":"Labels used to categorize, filter, and classify resources. Learn more about tags [here](https://docs.secoda.com/resource-and-metadata-management/tags/custom-tags)."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/tag/{tag_id}":{"delete":{"tags":["Tags"],"summary":"Delete Tag","description":"Delete a tag by its ID.","parameters":[{"name":"tag_id","in":"path","required":true,"description":"The ID of the tag to delete.","schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}}}}
```

## Update Tag

> Use this endpoint to update tag name, color, or icon.

```json
{"openapi":"3.0.0","info":{"title":"Secoda API","version":"8.22.39"},"tags":[{"name":"Tags","description":"Labels used to categorize, filter, and classify resources. Learn more about tags [here](https://docs.secoda.com/resource-and-metadata-management/tags/custom-tags)."}],"servers":[{"url":"https://api.secoda.co","description":"Base URL for all US cloud based workspaces"},{"url":"https://eapi.secoda.co","description":"Base URL for all EU cloud based workspaces"},{"url":"https://aapi.secoda.co","description":"Base URL for all APAC cloud based workspaces"},{"url":"https://{customer_domain}.secoda.co","description":"Base URL for On Premise Secoda workspaces","variables":{"customer_domain":{"default":"customer_domain","description":"The specific domain set up for your On Premise Secoda workspace."}}}],"security":[{"ApiKeyAuth":[]}],"paths":{"/api/v1/tag/{tag_id}":{"patch":{"tags":["Tags"],"summary":"Update Tag","description":"Use this endpoint to update tag name, color, or icon.","parameters":[{"name":"tag_id","in":"path","required":true,"description":"The ID of the tag to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"color":{"type":"string","description":"Represents the color of the tags."}},"required":["color"]}}}},"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.secoda.co/api/reference/tags.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.