ReferenceTags
ResourcesTags

Tags

List tags

GET
/api/v1/orgs/{owner}/tags

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/tags"
{  "count": 0,  "results": [    {      "uuid": "string",      "name": "string",      "user": "string",      "color": "string",      "description": "string",      "icon": "string",      "stats": {}    }  ],  "previous": "string",  "next": "string"}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Create tag

POST
/api/v1/orgs/{owner}/tags

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Tag body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/tags" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "user": "string",  "color": "string",  "description": "string",  "icon": "string",  "stats": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Load tags

GET
/api/v1/orgs/{owner}/tags/load

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Query Parameters

offset?integer

Pagination offset.

limit?integer

Limit size.

sort?string

Sort to order the search.

query?string

Query filter the search.

bookmarks?boolean

Filter by bookmarks.

mode?string

Mode of the search.

no_page?boolean

No pagination.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/tags/load"
{}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Sync tags

POST
/api/v1/orgs/{owner}/tags/sync

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

Request Body

application/json

Data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/orgs/string/tags/sync" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Patch tag

PATCH
/api/v1/orgs/{owner}/tags/{tag.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

tag.uuid*string

UUID

Request Body

application/json

Tag body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/orgs/string/tags/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "user": "string",  "color": "string",  "description": "string",  "icon": "string",  "stats": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Update tag

PUT
/api/v1/orgs/{owner}/tags/{tag.uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

tag.uuid*string

UUID

Request Body

application/json

Tag body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/orgs/string/tags/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "uuid": "string",  "name": "string",  "user": "string",  "color": "string",  "description": "string",  "icon": "string",  "stats": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Get tag

GET
/api/v1/orgs/{owner}/tags/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/orgs/string/tags/string"
{  "uuid": "string",  "name": "string",  "user": "string",  "color": "string",  "description": "string",  "icon": "string",  "stats": {}}
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Delete tag

DELETE
/api/v1/orgs/{owner}/tags/{uuid}

Authorization

ApiKey
Authorization<token>

In: header

Path Parameters

owner*string

Owner of the namespace

uuid*string

Uuid identifier of the entity

Query Parameters

cascade?boolean

Flag to handle sub-entities.

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/orgs/string/tags/string"
Empty
{}
{}
{}
{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}
Searches
Teams

On this page

List tagsCreate tagLoad tagsSync tagsPatch tagUpdate tagGet tagDelete tag

Actions

Give us feedback