Search tag groups

get

https://{host}/platform/referencedata/v1/tagGroups

Returns a list of tag groups.

For each tag group, the response lists tags by tag entity. Platform API supports nine tag entity types: 1 (Databases), 2 (Results), 3 (Profiles), 4 (Portfolios), 5 (Accounts), 6 (Treaties), 7 (Aggregate Portfolios), 8 (Programs), and 9 (Business Hierarchies)

This operation supports response filtering using query parameters. Depending on the properties specified in the query string, you may use a combination of comparison operators, list operators, and logical operators. To learn more, see Response Filtering.

Query Params

isActive

boolean

filter

string

Query string to select response data based on property values.

Property	Type	Comparison	List
`createdBy`	`string`	`=`, `!=`, `LIKE`, `NOT LIKE`	`IN`, `NOT IN`
`isActive`	`boolean`	`=`, `!=`	`IN`, `NOT IN`
`tagGroupId`	`number`	`=`, `!=`, `<`, `>`, `<=`, `>=`	`IN`, `NOT IN`
`tagGroupName`	`string`	`=`, `!=`, `LIKE`, `NOT LIKE`	`IN`, `NOT IN`
`updatedBy`	`string`	`=`, `!=`, `LIKE`, `NOT LIKE`	`IN`, `NOT IN`

offset

int32

≥ 0

Number of the page displaying the returned records, starting at 0.

limit

int32

≥ 1

Defaults to 5000

Number of records returned per page. See Response Pagination

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error