Skip to main content
GET
/
v0
/
users
List users for the caller's organisation
curl --request GET \
  --url https://sis.sumvin.com/v0/users \
  --header 'Authorization: Bearer <token>'
{
  "_links": {
    "self": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    }
  },
  "users": [
    {
      "id": "<string>",
      "account_status": "<string>",
      "created_at": 123,
      "updated_at": 123,
      "email": "<string>",
      "username": "<string>",
      "primary_eoa_address": "<string>",
      "sri": "<string>",
      "kyc_verified_at": 123,
      "phone": "<string>",
      "first_name": "<string>",
      "last_names": "<string>",
      "country_of_residence": "<string>",
      "sumsub_applicant_id": "<string>",
      "sumsub_global_id": "<string>"
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 500
offset
integer
default:0
Required range: x >= 0
env_id
string | null

Optional environment external_id (e.g. 'env-abc123'). When provided, scopes results to users that authenticated against this environment. When omitted, returns users across every environment in the organisation.

Response

Successful Response

Base links present in all responses.

users
(SISUserFull · object | SISUserPartner · object | SISUserThin · object)[]
required
total
integer
required