List Teams

The List Teams API allows you to fetch a list of teams within Zenput.
Below is a sample call and a full description of input parameters, and success and error output formats.

$ curl -H 'X-API-TOKEN: <API_TOKEN>' \
    'https://www.zenput.com/api/v3/teams/?start=0&limit=1'

Input parameters
All input parameters are optional.

Name

Type

Description

external_key

text

Filter results to given external key.

limit

integer

Number of results to return per page.

start

integer

The initial index from which to return the results.

meta_only

boolean

Return only data within the meta key.

Output format (success)

{
  "meta": {
    "status_code": 200,
    "count": 999,
    "next": "https://www.zenput.com/api/v3/teams/?limit=1&start=1",
    "previous": null
  },
  "data": [
    {
      "id": 1,
      "name": "Team name",
      "description": "Team description",
      "children": [
        {
          "id": 2,
          "name": "Child team",
          "has_children": true,
          "has_accounts": false,
          "has_users": true
        }
      ],
      "users": [],
      "locations": [],
      "company": {
        "id": 1,
        "name": "Zenput",
        "features": []
      },
      "external_key": "team-external-key",
      "created_user": {
        "id": 1,
        "username": "[email protected]",
        "display_name": "First Name Last Name",
        "user_role": {
          "id": 1,
          "name": "Store Manager"
        },
        "groups": [
          {
            "id": 2,
            "name": "Manager"
          }
        ]
      },
      "parent": null,
      "is_editable": true,
      "is_company_root": false,
      "has_accounts": false,
      "has_children": true,
      "has_users": false
    }
  ]
}