Skip to main content
GET
/
orgs
/
{org_id}
/
projects
/
{project_id}
/
workforce
cURL
curl --request GET \
  --url https://api.timbal.ai/orgs/{org_id}/projects/{project_id}/workforce \
  --header 'Authorization: Bearer <token>'
{
  "workforce": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "agent",
      "deleted_at": 123,
      "description": "<string>",
      "uid": "<string>",
      "url": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

​
org_id
string
required
​
project_id
string
required

Query Parameters

​
rev
string

Git branch name (for example main). When omitted, all registered (non-deleted) workforce components are returned without deployment status.

Response

200 - application/json

List of workforce items

Workforce components registered for the project. The url field is set only when the component has a running deployment for the git branch you queried (rev).

​
workforce
object[]
required