Get users - Sqabl APIs

Request

Query Params

email

string

optional

pageSize

integer

optional

For pagination; specifies the maximum number of items to fetch.

lastEvaluatedKey

string

optional

Check the APIs doc on how to use this.

keyword

string

optional

A search query.

Header Params

Authorization

string

optional

Viewer's access token, from whom the request is made, to check their relationships with the fetched users.

Example:

Bearer some-viewer-token

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.sqabl.com/v1/users?email&pageSize&lastEvaluatedKey&keyword' \
--header 'Authorization: Bearer some-viewer-token'

Responses

🟢200Success

application/json

Body

object {0}

Examples

SuccessSuccess (when access token is valid)Success (when "withTotalFlames" param key is true)

{
    "success": true,
    "statusCode": 200,
    "pagination": {
        "lastEvaluatedKey": {
            "id": "cm1kirt9x000008l1fo6f2be9",
            "dateCreated": "2024-10-31 09:30:31.912Z"
        }
    },
    "data": [
        {
            "id": "cm1jb6nsf000008jp4poz6y4n",
            "email": "olomolateju@gmail.com",
            "displayName": "tej",
            "firstName": "Tejumade",
            "lastName": "Olomola",
            "country": "Nigeria",
            "verified": true
        },
        {
            "id": "cm1jckkee000008m9abf1f0o4",
            "email": "adedolapolisa@gmail.com",
            "displayName": "Adedolapo Olisa",
            "firstName": "Adedolapo",
            "lastName": "Olisa",
            "imageSrc": "https://lh3.googleusercontent.com/a/ACg8ocJO2n0a0haOvQY9KXTdBNgCLRl2MRLZ-N4naOkb2vT6iWfhSw=s96-c",
            "interests": [
                "Engineering",
                "Athletics",
                "Self-Improvement"
            ],
            "verified": true
        },
        {
            "id": "cm1kirt9x000008l1fo6f2be9",
            "email": "moonred400@gmail.com",
            "displayName": "hashwarmer",
            "firstName": "oluwasanmi",
            "lastName": "Ogunyemi",
            "country": "Nigeria",
            "verified": true
        }
    ]
}