"Clients" Endpoints - GET List clients

Tech Discussions API References
, , ,
1 
https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/clients

List clients from workspace.

  • cURL
  • Go
  • Ruby
  • JavaScript
  • Python
  • Rust
extern crate tokio;extern crate serde_json;use reqwest::{Client};use reqwest::header::{CONTENT_TYPE};#[tokio::main]async fn main() -> Result<(), reqwest::Error> {  let client = Client::new().basic_auth("<email>", "<password>");  let json = client.request(Method::GET, "https://api.track.toggl.com/api/v9/workspaces/{workspace_id}/clients".to_string())  .header(CONTENT_TYPE, "application/json")  .send()  .await?  .json()  .await?;    println!("{:#?}", json);  Ok(())}

Parameters​

Path​

name type required description
workspace_id integer true Numeric ID of the workspace

Query​

name type required description
status string false Use ‘active’ to only list active clients, ‘archived’ to only list archived clients and ‘both’ to retrieve active and archived clients. If not provided, only active clients are returned.
name string false If provided, allows to filter by client name in a case insensitive manner, returning all the ones that contain the given string.

Response​

200​

Name Type Description
items Array of object -
items​
Name Type Description
archived boolean IsArchived is true if the client is archived
at string When was the last update
creator_id integer CreatorID is the ID of the user who created the client
id integer Client ID
integration_ext_id string The external ID of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_ext_type string The external type of the linked entity in the external system (e.g. JIRA/SalesForce)
integration_provider string The provider (e.g. JIRA/SalesForce) that has an entity linked to this Toggl Track entity
name string Name of the client
notes string -
permissions string List of authorization permissions for this client.
wid integer Workspace ID

400​

Client status is invalid

403​

Forbidden

500​

Internal Server Error