Scannable Docs

List members

Returns the members of your organisation, by last name and then first name. Narrow them with email (the whole address, any case), role, competent_person and in_team. Pass each response’s next_cursor as cursor to fetch the next page, until it is null.

GET
/v1/members

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.

email?string

Only the member with this email address, such as sam.carter@example.com. The whole address must match; case is ignored.

role?string

Only members with this role in your organisation.

Value in"admin""manager""member""supplier""user"
competent_person?boolean

Omit for everyone, true for only competent persons, false for only members who are not.

in_team?boolean

Omit for everyone, true for only members in at least one team, false for only members in no team.

Response Body

A page of your members.

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/members'
Example response
{  "data": [    {      "id": "member_0shacc5ppeye6v5",      "name": "Sam Carter",      "email": "sam.carter@example.com",      "role": "member",      "competent_person": false,      "created_at": "2026-03-02T09:30:00.000Z",      "updated_at": "2026-03-04T14:05:00.000Z"    }  ],  "total": 42,  "limit": 20,  "next_cursor": "eyJwb3NpdGlvbiI6eyJjcmVhdGVkQXQiOiIyMDIxLTAyLTI1VDIzOjIzOjI5LjAwMFoiLCJ1aWQiOiJpdXNoOTN4djN4cnN2MWMifSwiZmlsdGVycyI6Imw5Rnc0VlVPN2tyOCJ9"}