We have released a whole new time-off API which makes it even easier to add, update, and review employee PTO. The new API uses worker_id as the identifier vs contract_id.
Sample Request
Create a time-off request using the following format
We have moved the OAuth server to the same domain as the Deel app. You can now use app.deel.com/oauth2/... for all of your OAuth-related requests to Deel.
For example, the API call to exchange and auth grant for an access token will look like this:
We're excited to announce the launch of our latest feature, allowing you to retrieve a list of people in your Deel account.
Programmatically fetch, analyze, and leverage a comprehensive list of individuals associated with your organization to enhance team management and strategic decision-making.
To ensure your employees receive this benefit, make sure to include a new pension object while creating an EOR Contract quote (using the POST /eor endpoint). This will allow you to set the preferred pension provider for the employees.
This new pension object has two properties:
id: Pension provider's id
contribution: You should send this value when the pension provider that you choose has a contribution object.
The contribution property should have a value between the minimum and maximum given.
"pension": {
"id": "0",
"contribution": "7.00"
}
SCIM API Filters
We have added email and name filters to the Deel HR SCIM API Users endpoint. Now you can search for a user based on their email, givenName, or familyName.
To search for someone based on their email format the request like this:
We're excited to announce the launch of our latest feature that allows developers to seamlessly integrate Deel with their existing systems.
With the Deel API, you can now add client users (managers) to your Deel accounts and effortlessly list existing managers.
The key impacts of this feature include streamlined integration, enhanced efficiency in user management, scalability, improved user experience, and future expansions in functionality such as role assignment and user removal.
Simplify your onboarding and user management with Deel API Manager Integration.
Create candidates in Deel with a simple and minimal API call. Deel partners don't need extensive information to create people in Deel. Whether you're an ATS or a job board, you can use Deel Onboarding API to create candidates in Deel.
Candidates created with the API will show up in Deel at the top of the People list. Clients can click the "Review & Onboard" button to onboard candidates.
SCIM API: Edit User
You can now edit users in Deel HR SCIM API. The latest PATCH User endpoint enables you to edit a user's work email and manager.
Improved
OAuth app creation flow
We have changed the OAuth app creation flow to make it easy for you to get started with OAuth.
Sandbox: All OAuth apps created in Sandbox/Demo will be automatically published. You don't need to wait for our approval anymore.
Production: All OAuth apps created in production will be automatically submitted for review. Once reviewed the app will be published.
We are introducing a new type of API access token: Organization Token. This token unlike the Personal access token is not tied to a read user. Hence this token transcends user permissions and can access all data in an organization. This token remains valid even if the user account that generated this token becomes deactivated.
Head to Developer Center to generate an organization token for your organization.
Sandbox in API Playground
You can now call Sandbox API from the Deel API reference page. Click on the BASE URL option in the right toolbar to select the server you want to use.
Add Document Endpoint
You can now attach documents to a contract using Deel API. If you have the need to add additional documents to a contract, use this endpoint. Head to the API reference to see this endpoint.
We have added app type to OAuth. Now you can choose whether to create a personal or organization app. The organization app generates organization access tokens whereas the personal app generates a personal access token.
If you are building on SCIM API, you must create an organization app as SCIM API only works with organization tokens. Learn more.
In this release we are introducing the following endpoints:
Add external Id to a contract.
Preview contract agreement.
We have also made the following updates:
Added employments to SCIM API response schema.
Added country and state to SCIM API response schema.
Add external Id to a contract
You can now add an external id to a contract. This enables you to add a 3rd-party platform's reference id to a Deel contract so that you can search for this contract later using the external id.
Adding the external Id is simple. Below is a cURL example of this request:
