clients.md

Clients

Client has the following properties

• name: The name of the client (string, required, unique in workspace)
• wid: workspace ID, where the client will be used (integer, required)
• notes: Notes for the client (string, not required)
• at: timestamp that is sent in the response, indicates the time client was last updated

Create a client

POST https://api.track.toggl.com/api/v8/clients

Example request

curl -v -u 1971800d4d82861d8f2c1651fea4d212:api_token \
	-H "Content-Type: application/json" \
	-d '{"client":{"name":"Very Big Company","wid":777}}' \
	-X POST https://api.track.toggl.com/api/v8/clients

Successful response

{
	"data": {
		"id":1239455,
		"wid":777,
		"name":"Very Big Company",
		"at":"2013-02-26T08:45:28+00:00"
	}
}

Get client details

GET https://api.track.toggl.com/api/v8/clients/{client_id}

Example request

curl -v -u 1971800d4d82861d8f2c1651fea4d212:api_token \
	-X GET https://api.track.toggl.com/api/v8/clients/1239455

Successful response

{
	"data": {
		"id":1239455,
		"wid":777,
		"name":"Very Big Company",
		"at":"2013-02-26T08:45:28+00:00",
		"notes": "Contact: John Jacob Jingleheimer Schmidt"
	}
}

Update a client

PUT https://api.track.toggl.com/api/v8/clients/{client_id}

Workspace id (wid) can't be changed.

Example request

curl -v -u 1971800d4d82861d8f2c1651fea4d212:api_token \
	-H "Content-Type: application/json" \
	-d '{"client":{"name":"Very Big Company","notes":"something about the client"}}' \
	-X PUT https://api.track.toggl.com/api/v8/clients/1239455

Successful response

{
	"data": {
		"id":1239455,
		"wid":777,
		"name":"Very Big Company",
		"notes":"something about the client",
		"at":"2013-02-26T08:55:28+00:00"
	}
}

Delete a client

DELETE https://api.track.toggl.com/api/v8/clients/{client_id}

Example request

curl -v -u 1971800d4d82861d8f2c1651fea4d212:api_token \
	-X DELETE https://api.track.toggl.com/api/v8/clients/1239455

Successful request will return 200 OK. If the user has no access to delete, you'll get a status code 4xx

Get workspace clients

Retrieving workspace clients is documented here.

Get clients visible to user

GET https://api.track.toggl.com/api/v8/clients

Example request

curl -v -u 1971800d4d82861d8f2c1651fea4d212:api_token \
	-X GET https://api.track.toggl.com/api/v8/clients

Successful response is an array of clients

[
	{
		"id":1239455,
		"wid":777,
		"name":"Very Big Company",
		"notes":"something about the client",
		"at":"2013-02-26T08:55:28+00:00"
	}, {
		"id":1239456,
		"wid":777,
		"name":"Small Startup",
		"notes":"Really cool people",
		"at":"2013-03-26T08:55:28+00:00"
	}
]

Get client projects

GET https://api.track.toggl.com/api/v8/clients/{client_id}/projects

Example request

curl -v -u 1971800d4d82861d8f2c1651fea4d212:api_token \
	-X GET https://api.track.toggl.com/api/v8/clients/1239455/projects

To filter projects by their state you can add the additional param to the request url:

• active: possible values true/false/both. By default true. If false, only archived projects are returned.

Successful response is an array of client projects

[
	{
		"id":909,
		"wid":777,
		"cid":987,
		"name":"Very lucrative project",
		"billable":false,
		"is_private":true,
		"active":true,
		"at":"2013-03-06T09:15:18+00:00"
	},{
		"id":32143,
		"wid":777,
		"cid":987,
		"name":"Factory server infrastructure",
		"billable":true,
		"is_private":true,
		"active":true,
		"at":"2013-03-06T09:16:06+00:00"
	}
]