Get list of people paginated

GET

/v1/organizations/:organizationId/people/

Get list of people paginated

Required Permission: base.people.management.list

Get list of people paginated

Request

Add parameter in 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

admin adminViewer user serviceAccount

has2FAActive boolean optional

ssoUser boolean optional

activityTrace object optional

lastLogin object optional

dashboard string optional

sdk string optional

store string optional

lastAction object optional

dashboard string optional

sdk string optional

store string optional

entries array [object] required

id string required

Match pattern: ^[a-fA-F0-9]{24}$

createdBy string required

Match pattern: ^[a-fA-F0-9]{24}$

kind string required

employee collaborator

scope string required

organization application

role string optional

owner admin editor viewer unassigned

tags array required

application object optional

id string required

Match pattern: ^[a-fA-F0-9]{24}$

name string required

≤ 256 characters

description string required

≤ 500 characters

picture string required

≤ 500 characters

slug string required

≤ 128 characters · ≥ 3 characters · Match pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]$

type string optional

traditional ldap saml customLogin temporal

from string optional

store sdk dashboard integrationApi emm adm scim agent win

temporal boolean optional

lastDetected string optional

≤ 128 characters

detected object optional

createdAt string required

≤ 128 characters

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": "admin",
                "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"
    }
}