»Organization Tags API
This API returns the list of tags used with all resources across the organization. Tags can be added to this pool directly or via those resources. Tags deleted here will be removed from all other resources. Tags can be added, applied, removed and deleted in bulk.
List Tags
GET /organizations/:organization_name/tags
Parameter | Description |
---|---|
:organization_name | The name of the organization to list tags from |
Query Parameters
This endpoint supports pagination with standard URL query parameters; remember to percent-encode [
as %5B
and ]
as %5D
if your tooling doesn't automatically encode URLs.
Parameter | Description |
---|---|
q | Optional. A search query string. Organization tags are searchable by name likeness. |
filter[exclude][taggable][id] | Optional. If specified, omits organization's related workspace's tags. |
page[number] | Optional. If omitted, the endpoint will return the first page. |
page[size] | Optional. If omitted, the endpoint will return 20 organization tags per page. |
Sample Request
Sample Response
Delete tags
This endpoint deletes one or more tags from an organization. The organization and tags must already exist. Tags deleted here will be removed from all other resources.
DELETE /organizations/:organization_name/tags
Parameter | Description |
---|---|
:organization_name | The name of the organization to delete tags from |
Status | Response | Reason(s) |
---|---|---|
204 | Nothing | Successfully removed tags from organization |
404 | JSON API error object | Organization not found, or user unauthorized to perform action |
Request Body
This POST endpoint requires a JSON object with the following properties as a request payload.
It is important to note that type
and id
are required.
Key path | Type | Default | Description |
---|---|---|---|
data[].type | string | Must be "tags" . | |
data[].id | string | The id of the tag to remove. |
Sample Payload
Sample Request
Sample Response
No response body.
Status code 204
.
Add workspaces to a tag
POST /tags/:tag_id/relationships/workspaces
Parameter | Description |
---|---|
:tag_id | The ID of the tag that workspaces should have added. |
Status | Response | Reason(s) |
---|---|---|
204 | Nothing | Successfully added workspaces to tag |
404 | JSON API error object | Tag not found, or user unauthorized to perform action |
Request Body
This POST endpoint requires a JSON object with the following properties as a request payload.
Key path | Type | Default | Description |
---|---|---|---|
data[].type | string | Must be "workspaces" . | |
data[].id | string | The id of the workspace to add. |
Sample Request
Sample Payload
Sample Response
No response body.
Status code 204
.