Skip to main content

Clients

GET List clients

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

List clients from workspace.

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

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Query

nametyperequireddescription
statusstringfalseClient status
namestringfalseClient name

Response

[
{
"archived": {
"type": "boolean"
},
"at": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"server_deleted_at": {
"type": "string"
},
"wid": {
"type": "integer"
}
}
]

POST Create client

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

Create workspace client.

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

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace

Body

nametypedescription
idintegerClient ID
namestringClient name
widintegerWorkspace ID

Response

{
"archived": {
"type": "boolean"
},
"at": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"server_deleted_at": {
"type": "string"
},
"wid": {
"type": "integer"
}
}

GET Load client from ID

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

Load client from workspace.

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

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
client_idintegertrueNumeric ID of the client

Response

{
"archived": {
"type": "boolean"
},
"at": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"server_deleted_at": {
"type": "string"
},
"wid": {
"type": "integer"
}
}

PUT Change client

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

Update workspace client.

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

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
client_idintegertrueNumeric ID of the client

Body

nametypedescription
idintegerClient ID
namestringClient name
widintegerWorkspace ID

Response

{
"archived": {
"type": "boolean"
},
"at": {
"type": "string"
},
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"server_deleted_at": {
"type": "string"
},
"wid": {
"type": "integer"
}
}

DELETE Delete client

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

Delete workspace client.

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

Parameters

Path

nametyperequireddescription
workspace_idintegertrueNumeric ID of the workspace
client_idintegertrueNumeric ID of the client

Response

Successful operation.
© 2022 Toggl. All rights reserved.