> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itspropel.com/llms.txt.
> For full documentation content, see https://docs.itspropel.com/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server.

# List Teams

GET https://workforce/teams

Reference: https://docs.itspropel.com/propel-biz/07-workforce/teams/list-teams

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: PropelBiz
  version: 1.0.0
paths:
  /workforce/teams:
    get:
      operationId: list-teams
      summary: List Teams
      tags:
        - subpackage_07Workforce.subpackage_07Workforce/teams
      parameters:
        - name: include
          in: query
          description: >-
            Optional: Relationships to include - tenantLocation, members,
            leadMember
          required: false
          schema:
            type: string
        - name: is_active
          in: query
          description: 'Optional: Filter by active status - true|false'
          required: false
          schema:
            type: boolean
        - name: sort_by
          in: query
          description: 'Optional: Sort column - name|code|created_at - default name'
          required: false
          schema:
            type: string
        - name: sort_direction
          in: query
          description: 'Optional: Sort direction - asc|desc - default asc'
          required: false
          schema:
            type: string
        - name: per_page
          in: query
          description: 'Optional: Results per page - default 50'
          required: false
          schema:
            type: integer
        - name: page
          in: query
          description: 'Optional: Page number - default 1'
          required: false
          schema:
            type: integer
        - name: '{{tenant_key_name}}'
          in: header
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/07 Workforce_Teams_List
                  Teams_Response_200
servers:
  - url: https:/
components:
  schemas:
    07 Workforce_Teams_List Teams_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: 07 Workforce_Teams_List Teams_Response_200

```

## SDK Code Examples

```python
import requests

url = "https://https/workforce/teams"

querystring = {"include":"members,leadMember","is_active":"true","sort_by":"name","sort_direction":"asc","per_page":"50","page":"1"}

payload = { "X-Tenant-Key": "tenant123|regionA" }
headers = {
    "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://https/workforce/teams?include=members%2CleadMember&is_active=true&sort_by=name&sort_direction=asc&per_page=50&page=1';
const options = {
  method: 'GET',
  headers: {
    '{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}',
    'Content-Type': 'application/json'
  },
  body: '{"X-Tenant-Key":"tenant123|regionA"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://https/workforce/teams?include=members%2CleadMember&is_active=true&sort_by=name&sort_direction=asc&per_page=50&page=1"

	payload := strings.NewReader("{\n  \"X-Tenant-Key\": \"tenant123|regionA\"\n}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://https/workforce/teams?include=members%2CleadMember&is_active=true&sort_by=name&sort_direction=asc&per_page=50&page=1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"X-Tenant-Key\": \"tenant123|regionA\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://https/workforce/teams?include=members%2CleadMember&is_active=true&sort_by=name&sort_direction=asc&per_page=50&page=1")
  .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}")
  .header("Content-Type", "application/json")
  .body("{\n  \"X-Tenant-Key\": \"tenant123|regionA\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://https/workforce/teams?include=members%2CleadMember&is_active=true&sort_by=name&sort_direction=asc&per_page=50&page=1', [
  'body' => '{
  "X-Tenant-Key": "tenant123|regionA"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://https/workforce/teams?include=members%2CleadMember&is_active=true&sort_by=name&sort_direction=asc&per_page=50&page=1");
var request = new RestRequest(Method.GET);
request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"X-Tenant-Key\": \"tenant123|regionA\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}",
  "Content-Type": "application/json"
]
let parameters = ["X-Tenant-Key": "tenant123|regionA"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://https/workforce/teams?include=members%2CleadMember&is_active=true&sort_by=name&sort_direction=asc&per_page=50&page=1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```