Skip to main content

Tags

GET Tags

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/tags

List Workspace tags.

curl  https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/tags \
-H "Content-Type: application/json" \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Response

200

NameTypeDescription
itemsArray of object-
items
NameTypeDescription
atstringWhen was created/last modified
creator_idintegerCreatorID the user who created the tag
deleted_atstringWhen was deleted
idintegerTag ID
integration_ext_idstringThe external ID of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_ext_typestringThe external type of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_providerstringThe provider (e.g. JIRA/SalesForce) that has an entity linked to this Toggl Track entity
namestringTag name
permissionsstring-
workspace_idintegerWorkspace ID

403

User does not have access to this resource.

500

Internal Server Error

POST Create tag

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/tags

Create workspace tags.

curl -X POST https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/tags \
-H "Content-Type: application/json" \
-d '\{"name":"string"\}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Body

NameTypeDescription
namestringTag name

Response

200

NameTypeDescription
itemsArray of object-
items
NameTypeDescription
atstringWhen was created/last modified
creator_idintegerCreatorID the user who created the tag
deleted_atstringWhen was deleted
idintegerTag ID
integration_ext_idstringThe external ID of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_ext_typestringThe external type of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_providerstringThe provider (e.g. JIRA/SalesForce) that has an entity linked to this Toggl Track entity
namestringTag name
permissionsstring-
workspace_idintegerWorkspace ID

400

Possible errors:

  • Invalid JSON input
  • tag name can't be blank
  • a tag with the name '{tag_name}' already exists

403

Only organization or workspace administrators may manage tags in this workspace.

500

Internal Server Error

PUT Update tag

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/tags/{tag_id}

Update workspace tags.

curl -X PUT https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/tags/{tag_id} \
-H "Content-Type: application/json" \
-d '\{"name":"string"\}' \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
tag_idintegertrueNumeric ID of the tag

Body

NameTypeDescription
namestringTag name

Response

200

NameTypeDescription
itemsArray of object-
items
NameTypeDescription
atstringWhen was created/last modified
creator_idintegerCreatorID the user who created the tag
deleted_atstringWhen was deleted
idintegerTag ID
integration_ext_idstringThe external ID of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_ext_typestringThe external type of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_providerstringThe provider (e.g. JIRA/SalesForce) that has an entity linked to this Toggl Track entity
namestringTag name
permissionsstring-
workspace_idintegerWorkspace ID

400

Possible errors:

  • Invalid JSON input
  • Invalid tag ID
  • tag name can't be blank
  • a tag with the name '{tag_name}' already exists

403

Only organization or workspace administrators may manage tags in this workspace.

404

Tag was not found

500

Internal Server Error

DELETE Delete tag

https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/tags/{tag_id}

Delete workspace tags.

curl -X DELETE https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/tags/{tag_id} \
-H "Content-Type: application/json" \
-u <email>:<password>

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
tag_idintegertrueNumeric ID of the tag

Response

200

Successful operation.

400

Invalid tag ID.

403

Only organization or workspace administrators may manage tags in this workspace.

404

Tag was not found.

500

Internal Server Error

© 2024 Toggl. All rights reserved.