Skip to main content

Collaborators API (1.0.0)

Download OpenAPI specification:Download

Employee

Employee by ID

Employee by ID

path Parameters
EmployeeId
required
string
Example: 19016b80-2f9f-472d-acb9-4cd696a492d9
header Parameters
AccountId
string
Example: 19016b80-2f9f-472d-acb9-4cd696a492d9

Responses

Employee by ID

Employee by ID

path Parameters
EmployeeId
required
string
Example: 19016b80-2f9f-472d-acb9-4cd696a492d9
header Parameters
accountid
string
Example: d97bb410-4502-4bb9-a69e-7ed550795527
Request Body schema: application/json
active
boolean
object
birthdate
string
department
string
id
string
identificator
string
identificatorType
string
inactivated_at
string
name
string
phone
string
role
string
unit
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "admission": {
    },
  • "birthdate": "1990-07-10T00:00:00Z",
  • "department": "a3cf20e4-6932-4a59-b219-ca2875e6adb3",
  • "id": "8b8c2eae-8faf-49fc-a730-37b72a0e6856",
  • "identificator": "05478411086",
  • "identificatorType": "cpf",
  • "inactivated_at": "0001-01-01T00:00:00Z",
  • "name": "Mia Gregory",
  • "phone": "11945086704",
  • "role": "40dbbcb0-e2cd-44c7-b37d-2dc2b0b2d979",
  • "unit": "1adb4644-3524-47bd-9bc0-187a6b1123f0"
}

List Signs

List Signs

path Parameters
EmployeeId
required
string
Example: 19016b80-2f9f-472d-acb9-4cd696a492d9
header Parameters
accountid
string
Example: d97bb410-4502-4bb9-a69e-7ed550795527

Responses

Get activity by employee

Get activity by employee

path Parameters
EmployeeId
required
string
Example: 19016b80-2f9f-472d-acb9-4cd696a492d9
query Parameters
sortOrder
string
Example: sortOrder=desc
header Parameters
accountid
string
Example: 19016b80-2f9f-472d-acb9-4cd696a492d9
Request Body schema: application/json
roles
number

Responses

Request samples

Content type
application/json
{
  • "roles": 1
}

Status by ID

Status by ID

path Parameters
EmployeeId
required
string
Example: 19016b80-2f9f-472d-acb9-4cd696a492d9
header Parameters
accountid
string
Example: d97bb410-4502-4bb9-a69e-7ed550795527
Request Body schema: application/json
active
boolean

Responses

Request samples

Content type
application/json
{
  • "active": false
}

Status Many by ID

Status Many by ID

header Parameters
AccountId
string
Example: 18d96f11-eca5-4057-bdf4-a9d8cc76ac8b
Request Body schema: application/json
active
boolean
employeeIDs
Array of strings

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "employeeIDs": [
    ]
}

IDs by filter

IDs by filter

header Parameters
Accountid
string
Example: 18d96f11-eca5-4057-bdf4-a9d8cc76ac8b
Request Body schema: application/json
departments
Array of any
roles
Array of any
status
boolean
units
Array of any

Responses

Request samples

Content type
application/json
Example
{
  • "departments": [ ],
  • "roles": [ ],
  • "status": true,
  • "units": [ ]
}

Get Employees

Get Employees

query Parameters
page
string
Example: page=1
pageSize
string
Example: pageSize=10
active
string
Example: active=true
order
string
Example: order=asc
header Parameters
accountid
string
Example: 19016b80-2f9f-472d-acb9-4cd696a492d9

Responses

List

List

query Parameters
page
string
Example: page=1
pageSize
string
Example: pageSize=10
order
string
Example: order=asc
active
string
Example: active=true
header Parameters
accountid
string
Example: d97bb410-4502-4bb9-a69e-7ed550795527
Accountid
string
Example: 18d96f11-eca5-4057-bdf4-a9d8cc76ac8b
Request Body schema: application/json
cpf
string
email
string
employeeCode
string
name
string
phone
string
situation
boolean

Responses

Request samples

Content type
application/json
Example
{
  • "status": true
}

Create from Onboarding

Create from Onboarding

header Parameters
accountid
string
Example: 18d96f11-eca5-4057-bdf4-a9d8cc76ac9a
Request Body schema: application/json
admissionDate
string
birthdate
string
cpf
string
departmentID
string
email
string
employeeCode
string
name
string
organizationID
string
phone
string
position
string
relation
string
roleID
string
salary
string
unit
string

Responses

Request samples

Content type
application/json
{
  • "admissionDate": "2022-12-08T03:00:00.000Z",
  • "birthdate": "1990-07-03T00:00:00.000Z",
  • "cpf": "2987436394",
  • "departmentID": "62a8c500-4aa1-4bae-bf0c-52cd38d7cfb6",
  • "email": "squad.produtorh+homer.simpson@acesso.io",
  • "employeeCode": "9123123332",
  • "name": "Marcos Collab",
  • "organizationID": "896ffd1d-a3a9-43df-a2e8-eed057fe40e6",
  • "phone": "5511973839473",
  • "position": "58cfef3f-4095-4d55-bf05-bbce9b913f19",
  • "relation": "clt",
  • "roleID": "f80360a8-f858-4714-ad2b-6a5b8329a79e",
  • "salary": "1110",
  • "unit": "82930d53-e99a-4927-b31e-4fdc7090395d"
}

Search

Search

header Parameters
AccountId
string
Example: 18d96f11-eca5-4057-bdf4-a9d8cc76ac9a
Request Body schema: application/json
account
string
departments
Array of any
roles
Array of any
search
string
status
boolean
units
Array of any

Responses

Request samples

Content type
application/json
{
  • "account": "18d96f11-eca5-4057-bdf4-a9d8cc76ac9a",
  • "departments": [ ],
  • "roles": [ ],
  • "search": "",
  • "status": true,
  • "units": [ ]
}

Import

list import file

list import file

query Parameters
account
string
Example: account=4514c4d4-d8dc-4595-8c03-b255f4e0f478
header Parameters
accountid
string
Example: 4514c4d4-d8dc-4595-8c03-b255f4e0f478

Responses

ImportFile

ImportFile

query Parameters
account
string
Example: account=4514c4d4-d8dc-4595-8c03-b255f4e0f478
header Parameters
accountid
string
Example: 4514c4d4-d8dc-4595-8c03-b255f4e0f478
Request Body schema: multipart/form-data
file
string <binary>

Responses

get import file

get import file

path Parameters
ProtocolId
required
string
Example: 19016b80-2f9f-472d-acb9-4cd696a492d9
query Parameters
account
string
Example: account=4514c4d4-d8dc-4595-8c03-b255f4e0f478
header Parameters
accountid
string
Example: 4514c4d4-d8dc-4595-8c03-b255f4e0f478

Responses

get url error file

get url error file

path Parameters
ProtocolId
required
string
Example: 19016b80-2f9f-472d-acb9-4cd696a492d9
query Parameters
account
string
Example: account=19016b80-2f9f-472d-acb9-4cd696a492d9
header Parameters
accountid
string
Example: 4514c4d4-d8dc-4595-8c03-b255f4e0f478

Responses

webhook

Get Configuration

Get Configuration

header Parameters
accountid
string
Example: 4514c4d4-d8dc-4595-8c03-b255f4e0f478

Responses

Create Configuration

Create Configuration

header Parameters
accountid
string
Example: 4514c4d4-d8dc-4595-8c03-b255f4e0f478
Request Body schema: application/json
endpoint
string
events
Array of strings
object

Responses

Request samples

Content type
application/json
{}

Transport-Voucher

Capta/Amendment

Capta/Amendment

Request Body schema: application/json
codigo
number
object
msg
string
protocolo
number

Responses

Request samples

Content type
application/json
{
  • "codigo": 0,
  • "dadosConsulta": {
    },
  • "msg": "Processamento concluído",
  • "protocolo": 280376
}