List Employees - Documentação DEVMOB

{ "data": [ { "employeeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "membershipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "membership": { "membershipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z" }, "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "user": { "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "email": "jsmith@example.com", "phoneIso": "<string>", "phoneDdi": "<string>", "phoneNumber": "<string>", "phoneVerified": true, "emailVerified": true, "avatar": "<string>" }, "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "employeeCode": "<string>", "jobTitle": "<string>", "department": "<string>", "activatedAt": "2023-11-07T05:31:56Z", "suspendedAt": "2023-11-07T05:31:56Z", "revokedAt": "2023-11-07T05:31:56Z", "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z", "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deletedAt": "2023-11-07T05:31:56Z" } ], "meta": { "page": 1, "limit": 20, "total": 125, "totalPages": 7 } }

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

number

default:10

Items per page

Required range: 1 <= x <= 100

Example:

10

page

number

default:1

Page number

Required range: x >= 1

Example:

1

status

enum<string>

Employee status.

Available options:

ACTIVE,

SUSPENDED,

REVOKED

filter

string

Generic filter.

sortBy

enum<string>

default:createdAt

Field to sort by

Available options:

createdAt,

activatedAt

Example:

"createdAt"

sortOrder

enum<string>

default:desc

Sort order

Available options:

asc,

desc

Example:

"desc"

fields

string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

data

object[]

required

Show child attributes