To start working with the API, you need to generate an API key. This can be done in Settings -> API Keys (under Security) -> Generate.

If you want to create/edit employee compensation via API - provide the appropriate permission in the key generation window.

PeopleForce API has a limitation in the number of requests per minute. To get acquainted with current requirements follow the link. Take this limitation into account to avoid errors.

All resources that return the list of records have unified pagination. You can familiarize yourself with the format by clicking the following link.

You can import the OpenAPI configuration into Postman or other HTTP client for convenient work with the API.

You can see an example of API response for each endpoint in the corresponding block:

PeopleForce API has a limitation in the number of requests per minute. To get acquainted with current requirements follow the link. Take this limitation into account to avoid errors.

All resources that return the list of records have unified pagination. You can familiarize yourself with the format by clicking the following link.

You can import the OpenAPI configuration into Postman or other HTTP client for convenient work with the API.

You can see an example of API response for each endpoint in the corresponding block:

1. Creating/updating/receiving departments

2. Create/update/receive divisions

3. Creating/receiving locations

4. Create/update/receive positions

5. Create/update/receive employment types

6. Creation/updating/receipt of work schedules

Create a database of current employees with required fields from personal information, work information, etc. After creating an account, to display position, salary and employment data, and especially the chronology of changes, you need to further enter this data by referring to the points below (points 2-4).

1. Creating an employee's profile

2. Adding an employment record

3. Adding a position record

4. Adding a compensation record

5. Creating/receiving tasks by employee

6. Creating a document for an employee

You can also use synchronization to update employee information in PeopleForce or terminate an employee in the system.

Additionally, you can transfer other employee information that is not listed here. More actions are available and spelled out in the documentation.

Before setting up this type of integration, make sure absence types and policies are created in the system and assigned to employees. If there are any issues with this - please contact your CS manager.

Data transfer from PeopleForce to 1C:

Getting the list of all vacation requests by company

Requests can be filtered by dates, employees, statuses, etc. by passing corresponding parameters.

Data transfer from 1C to PeopleForce:

Before creating requests, employees already have

Creating a new request

Among the mandatory parameters to create a vacation request is the leave type - leave_type_id. To get it, use the endpoint

Please note - requests created via API should be matched in the same way as regular requests - via PeopleForce web interface. For one-time addition of historical data use the corresponding import.

Create an asset and assign the asset to the employee

Endpoints for working with and assigning assets

Optional: Webhooks to get real-time changes from PeopleForce

Webhooks allow you to receive all changes in PeopleForce without having to request them separately. For example, if any fields in an employee's profile change, we will send the corresponding event with up-to-date information on the employee.

Adding a new webhook

A list of all webhooks

For detailed information about a webhook, as well as sample data, select the desired webhook in the navigation menu on the left:

Please note - requests created via API should be coordinated in the same way as regular requests - via PeopleForce web interface. For one-time addition of historical data, use the corresponding import.