Scannable Docs

List teams

Returns the teams in your organisation, by name. Find teams by name with q. Filter to the teams one member belongs to with member, to teams with or without members with empty, and by creation time with created_after and created_before. Pass each response’s next_cursor as cursor to fetch the next page, until it is null.

GET
/v1/teams

Authorization

ApiKey
headerAuthorizationBearer <token>

Your organisation's API key. Send it as Authorization: Bearer <key>. Create one in the Scannable admin under Settings → API keys.

Query Parameters

limit?integer

Page size (1–100). Defaults to 20.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor of the previous page. Leave it out for the first page. A cursor only works with the filters it was issued for.

q?string

Only teams whose name contains this text, ignoring case, such as rig for Riggers.

member?string

Only the teams this member belongs to. A member_ identifier from the members list, such as member_flffmtixhdzcnwf. A member of another organisation returns 404.

empty?boolean

Omit for all teams, true for only teams with no members, false for only teams with at least one. true cannot be combined with member.

created_after?string

Only teams created at or after this time, as an ISO 8601 date-time such as 2026-01-01T00:00:00Z.

Formatdate-time
created_before?string

Only teams created at or before this time, as an ISO 8601 date-time such as 2026-06-30T23:59:59Z.

Formatdate-time

Response Body

A page of your teams, by name.

application/json
  1. response
data*array<>
total*integer

The total number of results that match the filters.

Range-9007199254740991 <= value <= 9007199254740991
limit*integer

The page size applied to this response.

Range-9007199254740991 <= value <= 9007199254740991
next_cursor*|

Pass as cursor to fetch the next page. Null on the last page.

Example Request
curl -X GET 'https://api.scannable.io/v1/teams'
Example response
{  "data": [    {      "id": "team_45ylkvywouutob2",      "name": "Riggers",      "created_at": "2026-03-02T09:30:00.000Z",      "updated_at": "2026-03-04T14:05:00.000Z"    }  ],  "total": 42,  "limit": 20,  "next_cursor": "eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9"}