Team

note

This page documents the legacy v1 and v2 API, which remains available for existing integrations such as the Zapier app. New integrations should use the CheckFlow API v3 — see Migrating from v1 and v2.

Endpoints for retrieving team members and groups. These are commonly used to look up IDs needed for task assignment operations.

---

Get Members and Groups

Returns all active team members and groups, optionally filtered by name. Results include group membership details.

GET /api/team/members-and-groups

Request Headers

Header	Required	Description
X-API-KEY	Yes	Your API key

Query Parameters

Parameter	Type	Required	Default	Description
nameContains	string	No	—	Filters results to members or groups whose name contains this string. Leave empty to return all.

Example Request

GET https://app.checkflow.io/api/team/members-and-groups
X-API-KEY: your-api-key-here

Example Response

{
  "members": [
    { "id": 7, "fullName": "Jane Smith" },
    { "id": 12, "fullName": "John Doe" }
  ],
  "groups": [
    {
      "id": 3,
      "name": "Operations Team",
      "members": [
        { "id": 7, "fullName": "Jane Smith" }
      ]
    }
  ]
}

Response Codes

Code	Description
200	Returns a list of matching members and groups.
401	API key is missing or invalid.
404	No members or groups found matching the criteria.

---

Get Members

Returns all active team members, optionally filtered by name.

GET /api/team/members

Request Headers

Header	Required	Description
X-API-KEY	Yes	Your API key

Query Parameters

Parameter	Type	Required	Default	Description
nameContains	string	No	—	Filters results to members whose name contains this string. Leave empty to return all.

Example Request

GET https://app.checkflow.io/api/team/members?nameContains=Jane
X-API-KEY: your-api-key-here

Example Response

[
  {
    "id": 7,
    "assigneeId": 7,
    "assigneeName": "Jane Smith",
    "assigneeType": 1
  }
]

Response Codes

Code	Description
200	Returns a list of matching members.
401	API key is missing or invalid.
404	No members found matching the criteria.

---

Get Groups

Returns all active groups, optionally filtered by name.

GET /api/team/groups

Request Headers

Header	Required	Description
X-API-KEY	Yes	Your API key

Query Parameters

Parameter	Type	Required	Default	Description
nameContains	string	No	—	Filters results to groups whose name contains this string. Leave empty to return all.

Example Request

GET https://app.checkflow.io/api/team/groups?nameContains=Operations
X-API-KEY: your-api-key-here

Example Response

[
  {
    "id": 3,
    "assigneeId": 3,
    "assigneeName": "Operations Team",
    "assigneeType": 2
  }
]

Response Codes

Code	Description
200	Returns a list of matching groups.
401	API key is missing or invalid.
404	No groups found matching the criteria.

Related Pages

• Roles & Permissions — what the roles in the response mean.
• Tasks — assigning a task to the users this returns.