Get list of employees

GET

/v1/organizations/:organizationId/apps/:applicationId/employees/

Get list of employees

Required Permission: base.people.applicationEmployee.list

Get list of employees

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,}))$

applicationId 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

Ordering criteria using a field-to-direction mapping to organize results based on specific attributes like creation date, name, or status.

Match pattern: ^[\w.]*((:asc)|(:desc))?$

email string

optional

≤ 256 characters

tags array

optional

Responses

200 Response application/json

status boolean optional

data object optional

items array [object] optional

id string optional

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

organization string optional

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

application string optional

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

employee object optional

_id string optional

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

email string optional

≤ 256 characters · Format: email

firstName string optional

≤ 128 characters

lastName string optional

≤ 128 characters

tags array [string] optional

type string optional

traditional ldap saml customLogin temporal

from string optional

store sdk dashboard integrationApi emm adm scim agent win

detected object optional

createdBy string optional

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

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

totalDocs integer optional

limit integer optional

hasPrevPage boolean optional

hasNextPage boolean optional

page integer optional

totalPages integer optional

prevPage integer optional

nextPage integer optional

lean boolean optional

{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "organization": "string",
                "application": "string",
                "employee": {
                    "_id": "string",
                    "email": "[email protected]",
                    "firstName": "string",
                    "lastName": "string"
                },
                "tags": [
                    "string"
                ],
                "type": "traditional",
                "from": "store",
                "detected": {},
                "createdBy": "string",
                "updatedAt": "2024-01-01T00: 00:00Z",
                "createdAt": "2024-01-01T00: 00:00Z"
            }
        ],
        "totalDocs": 0,
        "limit": 0,
        "hasPrevPage": true,
        "hasNextPage": true,
        "page": 0,
        "totalPages": 0,
        "prevPage": 0,
        "nextPage": 0,
        "lean": true
    }
}

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"
    }
}