Skip to main content
Before registering employees, the organization needs its structure created: Branches, Sectors and Positions. The combination of these three forms the hierarchy the employee will be assigned to.
Prerequisite: the company’s organization_id. Find it in List my organizations.
1

Find the organization_id

List the organizations your x-api-key has access to and keep the organization_id.
2

Create Branches

Create each work site with organization_id, display_name and cnpj. Keep the returned id (or use client_integration_code to map to your system).
3

Create Sectors

Create each area/department with organization_id, name and description.
4

Create Positions

Create each role with organization_id and name (and cbo, when available).
5

Ready for employees

With Branch, Sector and Position registered, you can register employees — the hierarchy is resolved automatically from these three IDs.
Use client_integration_code on Branches, Sectors and Positions to map each record to the ID in your system. It also works as a list filter — useful for idempotent syncs. See How to use.