The people connected to your app

GET

/v1/users

const url = 'https://api.eu.apigami.com/v1/users?limit=500';
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://api.eu.apigami.com/v1/users?limit=500' \
  --header 'Authorization: Bearer <token>'

Every person connected to your app, with or without a browser, oldest connection first, by the references your team sees. A page counts people: follow next until it is null. Your API key works here, and so does the production version’s APIGAMI_KEY in code Apigami hosts. A disabled account, or a person who left the team of a private app, is not listed.

Authorizations

apiKey

Parameters

Query Parameters

limit

integer

default: 500 >= 1 <= 1000

How many people a page holds at most. Default 500, clamped to 1000.

cursor

string

The next of a previous answer: an opaque place after the last person of that page. Leave it out for the first page.

Responses

200

A page of people. next is the cursor of the following page, or null after the last one.

application/json

object

users

required

Array<object>

object

user_ref

required

string

connected_at

required

When the person connected to your app.

string format: date-time

next

required

Pass it back as cursor; null after the last page.

string | null

Example

{
  "users": [
    {
      "user_ref": "usr_3f9c1a0e7b2d4c58a61e9f0b2d7c4e13",
      "connected_at": "2026-09-01T08:00:00.000Z"
    }
  ],
  "next": null
}

400

A query parameter could not be read, or the cursor names a person no longer in your team’s references.

application/json

object

error

required

string

consentPending

Present and true when the approval window is open and the user has not answered within 45 s.

boolean

Examples

{
  "error": "bad cursor"
}

{
  "error": "limit must be a number"
}

401

Missing, malformed or revoked API key, or the key of a version that is not in production.

application/json

object

error

required

string

consentPending

Present and true when the approval window is open and the user has not answered within 45 s.

boolean

Example

{
  "error": "bad client credentials"
}

403

Your app is disabled.

application/json

object

error

required

string

consentPending

Present and true when the approval window is open and the user has not answered within 45 s.

boolean

Example

{
  "error": "client disabled"
}