Skip to content

x-calamari-is-deprecated
Get all employees.

Request

Get all employees.

Security
basicAuth
Bodyapplication/json
employeestring

Employee identifier. You can use e-mail or external identifier in format (externalNumber:ABC123)

Example:"john.white@mycompany.com"
contractTypesArray of strings

List of contract types names or identifiers to search. As a result there will be employees who have one of selected contract types assigned. Example: ["Employment Contract", "B2B"]

Example:
[
  "Employment Contract"
]
positionsArray of strings

List of positions names or identifiers to search. As a result there will be employees who have one of provided positions. Example: ["Developer", "Support", "Architect"]

Example:
[
  "Developer"
]
teamsArray of strings

List of teams names or identifiers to search. As a result the result will contain employees who are members of at least one of provided teams. Example: ["First Team", "Second Team", "Third Team"]

Example:
[
  "First Team"
]
withArchivedboolean

Should return also archived employees?

curl -i -X POST \
  -u '<username>:<password>' \
  https://awesome-company.calamari.io/api/employees/v1/search \
  -H 'Content-Type: application/json' \
  -d '{
    "employee": "john.white@mycompany.com",
    "contractTypes": [
      "Employment Contract"
    ],
    "positions": [
      "Developer"
    ],
    "teams": [
      "First Team"
    ],
    "withArchived": true
  }'

Responses

successful operation

Response
No content