Team

Get a Team

Retrieves a specific team by its ID.

Response includes:

  • Team details (name, external_id, timestamps)
  • leads - Array of users who lead the team (currently max one, may change in the future)
  • business_unit - Business Unit the team belongs to (may be null)
  • ancestors - Team hierarchy path from root to immediate parent, ordered from root to parent
  • children - Direct child teams (not recursive)
  • members - All team members, including leads

Note: Archived teams are not accessible and will return a 404 error.

get/teams/{id}

Request

  • Base URL: https://connect.workpath.com/api/v3
  • URL: https://connect.workpath.com/api/v3/teams/{id}
  • Auth: HTTP bearer

Response

OK

idinteger required

Unique identifier for the team.

namestring required

Name of the team.

descriptionstring nullable

Description of the team. May be null if not set.

external_idstring nullable

External identifier for integration with other systems, called "Team Code" in the Workpath UI. Typically used for systemic organizational codes assigned to teams in large organizations (e.g., "WP-PE-INF"). May be null if not set.

created_atstring date-time required

Timestamp when the team was created in ISO 8601 format.

updated_atstring date-time required

Timestamp when the team was last updated in ISO 8601 format.

workpath_urlstring uri required

URL to view the team in the Workpath platform.

Example response

{
  "id": 4,
  "name": "Strategy Office",
  "description": "Responsible for defining and tracking company-wide strategic objectives.",
  "external_id": "WP-STR-001",
  "created_at": "2025-12-15T10:30:00Z",
  "updated_at": "2026-01-20T14:45:00Z",
  "workpath_url": "https://acme.workpath.com/teams/4",
  "leads": [
    {
      "id": 5,
      "name": "Thomas Weber"
    }
  ],
  "business_unit": {
    "id": 2,
    "name": "ACME EMEA"
  },
  "ancestors": [
    {
      "id": 1,
      "name": "ACME Corp"
    },
    {
      "id": 2,
      "name": "Executive Team"
    }
  ],
  "children": [
    {
      "id": 10,
      "name": "Strategy Analytics"
    }
  ],
  "members": [
    {
      "id": 5,
      "name": "Thomas Weber"
    },
    {
      "id": 3,
      "name": "Maria Schmidt"
    },
    {
      "id": 7,
      "name": "Sarah Johnson"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.