Local API V2 – Tag Interface

List Tags

Endpoint

GET /openapi/v2/tags

Returns a list of Tags.

Query Parameters

Name	Type	Required	Description
request	string	Yes	Parameters for listing Tags.

Response Parameters

data.list contains the list of Tags:

Name	Type	Description
id	string	Tag ID.
name	string	Tag name.
style	string	Tag color: gray, red, orange, yellow, green, teal, blue, purple, or pink.

Create a Tag

Endpoint

POST /openapi/v2/tags

Creates a Tag.

Request Parameters

Name	Type	Required	Description
name	string	No	Tag name.
style	string	No	Tag color: gray, red, orange, yellow, green, teal, blue, purple, or pink.

Request Example

{
  "name": "automation",
  "style": "blue"
}

Add a Tag to Profiles

Endpoint

POST /openapi/v2/tags/{tagId}/profiles

Adds the specified Tag to one or more Profiles.

Path Parameters

Name	Type	Required	Description
tagId	string	Yes	Tag ID.

Request Parameters

Name	Type	Required	Description
profile_ids	string[]	No	List of Profile IDs.

Request Example

{
  "profile_ids": ["1876881021063852034"]
}

Remove a Tag from Profiles

Endpoint

DELETE /openapi/v2/tags/{tagId}/profiles

Removes the specified Tag from one or more Profiles.

Path Parameters

Name	Type	Required	Description
tagId	string	Yes	Tag ID.

Request Parameters

Name	Type	Required	Description
profile_ids	string[]	No	List of Profile IDs.

Update a Tag

Endpoint

PATCH /openapi/v2/tags/{tagId}

Updates a Tag’s name or color.

Path Parameters

Name	Type	Required	Description
tagId	string	Yes	Tag ID.

Request Parameters

Name	Type	Required	Description
name	string	No	Tag name.
style	string	No	Tag color: gray, red, orange, yellow, green, teal, blue, purple, or pink.

Delete a Tag

Endpoint

DELETE /openapi/v2/tags/{tagId}

Deletes a Tag.

Path Parameters

Name	Type	Required	Description
tagId	string	Yes	Tag ID.