Favicon

You are here: Home > API Reference > Platform > People > Get list of people paginated

Get list of people paginated

Required Permission: base.people.management.list

Get list of people paginated

GET
https://api.applivery.io/v1/organizations/{organizationId}/people 
curl -X GET "https://api.applivery.io/v1/organizations/{organizationId}/people" \
  -H "Authorization: Bearer <YOUR_API_KEY>"
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/people", {
  method: "GET",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.applivery.io/v1/organizations/{organizationId}/people",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

page integer
optional
Sequential page index for navigating large datasets, enabling systematic access to specific record subsets within the total collection.
limit integer
optional
Maximum number of records returned per request to control data density, optimize interface performance, and manage payload size.
sort string
optional
lastLogin.dashboard:asclastLogin.dashboard:desclastLogin.sdk:asclastLogin.sdk:desclastLogin.store:asclastLogin.store:desclastAction.dashboard:asclastAction.dashboard:desclastAction.sdk:asclastAction.sdk:desclastAction.store:asclastAction.store:desccreatedAt:asccreatedAt:descupdatedAt:ascupdatedAt:descname:ascname:descemail:ascemail:desc
email string
optional
≤ 500 characters
scope string
optional
organizationapplication
role any
optional
applicationId string
optional
Match pattern: ^[a-fA-F0-9]{24}$
tags array
optional
origin string
optional
dashboardssosdksdk-temporal

Responses

200 Response application/json
status boolean required
data object required
items array [object] required
id string required
Match pattern: ^[a-fA-F0-9]{24}$
email string required
≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email
firstName string required
≤ 256 characters
lastName string required
≤ 256 characters
picture string optional
≤ 500 characters
kind any required
role string optional
user serviceAccount platformUser platformServiceAccount
has2FAActive any optional
ssoUser any optional
activityTrace object optional
entries array [object] required
createdAt string required
updatedAt string required
totalDocs integer required
≥ -9007199254740991 · ≤ 9007199254740991
limit integer required
≥ -9007199254740991 · ≤ 9007199254740991
hasPrevPage boolean required
hasNextPage boolean required
page integer required
≥ -9007199254740991 · ≤ 9007199254740991
totalPages integer required
≥ -9007199254740991 · ≤ 9007199254740991
prevPage integer required
≥ -9007199254740991 · ≤ 9007199254740991
nextPage integer required
≥ -9007199254740991 · ≤ 9007199254740991
{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "email": "[email protected]",
                "firstName": "string",
                "lastName": "string",
                "picture": "string",
                "kind": "employee",
                "role": "user",
                "has2FAActive": true,
                "ssoUser": true,
                "activityTrace": {
                    "lastLogin": {
                        "dashboard": "string",
                        "sdk": "string",
                        "store": "string"
                    },
                    "lastAction": {
                        "dashboard": "string",
                        "sdk": "string",
                        "store": "string"
                    }
                },
                "entries": [
                    {
                        "id": "string",
                        "createdBy": "string",
                        "kind": "employee",
                        "scope": "organization",
                        "role": "owner",
                        "tags": [
                            "string"
                        ],
                        "application": {
                            "id": "string",
                            "name": "string",
                            "description": "string",
                            "picture": "string",
                            "slug": "string"
                        },
                        "type": "traditional",
                        "from": "store",
                        "temporal": true,
                        "lastDetected": "string",
                        "detected": {},
                        "createdAt": "string"
                    }
                ],
                "createdAt": "string",
                "updatedAt": "string"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}