Get Employees

Description

Allows you to obtain a list of employees registered in the system. You can apply optional filters by ID, name, or email, as well as control the pagination of the results.

NOTE. Available for use with branch access key and also with General ADM access key.

🔑 Query Parameters

This endpoint supports optional filters through query parameters to refine the results.

Parameter	Type	Required	Description
idEmployee	int32	No	Unique ID of the staff member to be searched.
name	string	No	Name of the staff member. Can be a partial value for approximate search.
email	string	No	Email of the staff member.
take	int32	No	Total number of records to be returned. Default value is 50.
skip	int32	No	Total number of records to be ignored. Default value is 0.

📤 Response Structure

The response returns a list of registered staff members, containing personal, professional, and branch affiliation information.

Field	Type	Description
idEmployee	int32	Unique identifier of the staff member.
idBranch	int32	ID of the branch to which the staff member is affiliated.
branchName	string	Name of the branch associated with the staff member.
name	string	Full name of the staff member.
cpf	string	CPF of the staff member.
accessProfile	string	Access profile assigned to the staff member in the system.
status	string	Current status of the staff member (e.g., `Active`, `Inactive`, `Blocked`).
currentEmail	string	Current registered email of the staff member.
login	string	Login used by the staff member to access the system.
lastAccessDate	Datetime	Date and time of the last access of the staff member to the system.
permission	string	Description of the permissions associated with the staff member.
jobPosition	string	Position or role held by the staff member.
telephone	string	Contact phone number of the staff member.
photoUrl	string	URL of the staff member's profile picture (if available).

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

[
    {
        "idEmployee": 0,
        "idBranch": 0,
        "branchName": "string",
        "name": "string",
        "cpf": "string",
        "accessProfile": "string",
        "status": "string",
        "currentEmail": "string",
        "login": "string",
        "lastAccessDate": "2019-08-24T14:15:22.123Z",
        "permission": "string",
        "jobPosition": "string",
        "telephone": "string",
        "photoUrl": "string"
    }
]

🟠400Bad Request

Get employees

Get Employees#

Description#

🔑 Query Parameters#