List people

GET

/members

const url = 'https://kmlrvcofvtzdlbomxrbp.supabase.co/functions/v1/external-api/members?limit=100&format=json&role=admin';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url 'https://kmlrvcofvtzdlbomxrbp.supabase.co/functions/v1/external-api/members?limit=100&format=json&role=admin' \
  --header 'Authorization: Bearer <token>'

People in your company with their role and team. /users is an alias. Requires the read:members scope.

Authorizations

bearerKey
headerKey

Parameters

Query Parameters

limit

integer

default: 100 >= 1 <= 1000

How many rows to return, 1 to 1000.

format

string

default: json

Allowed values: json csv

csv returns the same rows as CSV, for Excel, Google Sheets or Power BI.

team_id

string format: uuid

Only people in this team.

role

string

Only people with this role.

Responses

200

People in your company.

Array<object>

object

string format: uuid

name

string

email

string format: email

role

string

team_id

string | null format: uuid

team_name

No Team when the person has no team.

string

created_at

string format: date-time

Example

[
  {
    "name": "Jana Nováková",
    "role": "employee",
    "team_name": "Marketing"
  }
]

401

The key is missing, malformed or revoked.

application/json

object

error

string

Example

{
  "error": "Unauthorized: Invalid or missing API Key"
}

403

The key works but does not have the scope this endpoint needs.

application/json

object

error

string

Example

{
  "error": "Forbidden: this key is missing the \"read:members\" scope"
}

500

Something went wrong on our side. The response does not include details.

application/json

object

error

string

Example

{
  "error": "Internal Server Error"
}