Knit

Jan 5, 2026

JazzHR ATS API Directory

JazzHR ATS is a purpose-built applicant tracking system designed to simplify and automate hiring for small and mid-sized organizations. It centralizes job posting, applicant management, interview workflows, and compliance tracking into a single system, reducing manual effort and improving hiring velocity.

Beyond its core ATS capabilities, JazzHR provides a well-structured API that allows teams to integrate recruitment data with external HR systems, analytics platforms, background verification tools, and internal workflows. The JazzHR ATS API enables controlled access to hiring data, allowing organizations to extend JazzHR’s capabilities without disrupting existing processes. For teams aiming to operationalize hiring data across systems, the API becomes a critical enabler rather than a nice-to-have.

Key Highlights of JazzHR ATS API

Centralized access to hiring data
Retrieve applicants, jobs, users, activities, and hiring outcomes from a single API surface.
Automates high-volume recruiting workflows
Programmatically create applicants, map them to jobs, upload files, add notes, and track hiring actions.
Reliable real-time visibility
Activities, tasks, hires, and updates can be fetched continuously to keep external systems in sync.
Flexible integration model
Designed for custom integrations with HRIS, onboarding tools, analytics systems, and job boards.
Secure access control
API key–based authentication ensures controlled and auditable access to recruitment data.
Scales with hiring growth
Pagination, filtering, and structured endpoints support growing applicant and job volumes.
Webhook and event-driven readiness
Supports near–real-time updates through activity tracking and webhook-style workflows.

JazzHR ATS API Endpoints

Activities

GET https://api.resumatorapi.com/v1/activities
GET https://api.resumatorapi.com/v1/activities/{activityID}

Applicants

POST https://api.resumatorapi.com/v1/applicants
GET https://api.resumatorapi.com/v1/applicants/{applicantID}

Applicants2Jobs

POST https://api.resumatorapi.com/v1/applicants2jobs
GET https://api.resumatorapi.com/v1/applicants2jobs/{applicants2jobsID}

Categories2Applicants

GET https://api.resumatorapi.com/v1/categories2applicants
GET https://api.resumatorapi.com/v1/categories2applicants/{categories2applicantsID}

Contacts

GET https://api.resumatorapi.com/v1/contacts
GET https://api.resumatorapi.com/v1/contacts/{contactsID}

Files

POST https://api.resumatorapi.com/v1/files
GET https://api.resumatorapi.com/v1/files/{filesID}

Hires

GET https://api.resumatorapi.com/v1/hires

Jobs

GET https://api.resumatorapi.com/v1/jobs
GET https://api.resumatorapi.com/v1/jobs/{jobID}

Notes

POST https://api.resumatorapi.com/v1/notes

Questionnaire Answers

POST https://api.resumatorapi.com/v1/questionnaire_answers
GET https://api.resumatorapi.com/v1/questionnaire_answers/pages/{page_id}

Questionnaire Questions

GET https://api.resumatorapi.com/v1/questionnaire_questions/questionnaire_id/questionnaire_20240715163409_5EYUGO8YULDRJOAE

Tasks

GET https://api.resumatorapi.com/v1/tasks
GET https://api.resumatorapi.com/v1/tasks/{taskID}

Users

GET https://api.resumatorapi.com/v1/users
GET https://api.resumatorapi.com/v1/users/{userID}

FAQs

1. What are common use cases for the JazzHR ATS API?
Automating applicant ingestion, syncing hiring data to HRIS or payroll systems, building hiring dashboards, and integrating background checks or assessments.

2. How is authentication handled in the JazzHR API?
All endpoints require an API key, passed either as a query parameter or header depending on the endpoint.

3. Can applicants be created and assigned to jobs via API?
Yes. Applicants can be created using the Applicants endpoint and mapped to jobs using the Applicants2Jobs endpoint.

4. Does the API support pagination for large datasets?
Yes. Most list endpoints support pagination with configurable page sizes, typically up to 100 records per page.

5. Can files like resumes and documents be uploaded programmatically?
Yes. The Files API allows uploading Base64-encoded files and linking them to applicants.

6. How can hiring activity be tracked in real time?
The Activities and Tasks endpoints provide detailed logs of user actions, applicant movements, and workflow updates.

7. Is the JazzHR API suitable for enterprise-scale integrations?
It is well-suited for SMB and mid-market scale. For higher volumes, careful rate management and pagination handling are recommended.

Get Started with JazzHR ATS API Integration

While the JazzHR ATS API is powerful, managing authentication, versioning, retries, and long-term maintenance adds operational overhead. Platforms like Knit API abstract these complexities by providing a single, standardized integration layer. With one integration to Knit, teams can access JazzHR data without managing API-specific logic, enabling faster deployment and lower maintenance cost.

The bottom line: if JazzHR is your system of record for hiring, its API is the backbone for scaling recruitment operations across tools, teams, and workflows.

Jan 4, 2026

AlexisHR API Directory

AlexisHR is a cloud-based human resources software designed for small to medium-sized businesses that want to centralize and automate their people operations. It brings together employee data management, onboarding, performance reviews, time tracking, and payroll reporting into a single system, reducing manual work and administrative overhead for HR teams.

A key differentiator of AlexisHR is its built-in use of artificial intelligence, including chatbots that integrate directly with tools like Slack and Microsoft Teams. These features improve day-to-day employee interactions and help HR teams respond faster with accurate information. To fully leverage AlexisHR across an organization’s tech stack, the AlexisHR API plays a critical role, enabling structured data access, system-to-system sync, and workflow automation.

This blog provides a clear overview of what the AlexisHR APIs offer, the key capabilities they enable, and a comprehensive list of available endpoints.

Key highlights of AlexisHR APIs

Central employee data access
Read and update employee records from a single source instead of maintaining duplicate HR data across systems.
Compensation and payroll inputs via API
Manage salary, bonus, and additional compensation data programmatically to reduce manual payroll preparation.
Leave and time tracking data
Access leave balances, leave transactions, timesheets, and time entries in structured formats for payroll and reporting.
Clear org structure management
Departments, teams, cost centers, and offices can be created and updated to keep HR and finance aligned.
Bulk data operations
Most endpoints support filtering, pagination, and sorting, making it practical to work with large employee datasets.
Event-based sync with webhooks
Get notified when employee-related changes happen instead of polling APIs repeatedly.
Secure access control
All APIs use Bearer token authentication, making permissions and access management predictable.

AlexisHR API Endpoints

Additional Compensation

FAQs

1. What authentication method does AlexisHR API use?
AlexisHR APIs use Bearer token–based authentication for all requests.

2. Can I fetch employee data in bulk?
Yes. Most “Get Many” endpoints support filters, pagination, sorting, and field selection.

3. Are compensation and bonus updates supported via API?
Yes. Salary, bonus, and additional compensation can be created and updated programmatically.

4. Can AlexisHR APIs be used for payroll reporting?
Yes. Timesheets, leave data, and compensation endpoints are commonly used for payroll inputs.

5. Does AlexisHR support real-time updates?
Yes. Webhooks can notify connected systems when employee-related events occur.

6. Can I manage org structures like departments and cost centers?
Yes. APIs are available for departments, teams, cost centers, offices, and reporting hierarchies.

7. Is AlexisHR suitable for multi-system HR stacks?
Yes. The API is designed to integrate AlexisHR with ATS, payroll systems, IT provisioning, and analytics tools.

Get Started with AlexisHR API Integration

If you want faster access to the AlexisHR APIs without building and maintaining each integration yourself, Knit API provides a streamlined option. With a single integration to Knit, authentication, authorization, and long-term maintenance are handled centrally, reducing engineering effort and integration risk while keeping your AlexisHR data reliably in sync.

Jan 4, 2026

Recruitee API Directory

Recruitee is a cloud-based recruitment platform built for small to midsized businesses that want a cleaner, more structured hiring process. It brings job posting, applicant tracking, and hiring collaboration into one place, so you’re not juggling spreadsheets, inbox threads, and five different tools to move one candidate forward.

As an ATS, Recruitee helps you manage candidate profiles, track progress across stages, and keep the hiring team aligned with notes, evaluations, and shared communication. You also get customizable pipelines, analytics, and career site tools to strengthen employer branding. If you’re planning an integration, the Recruitee API is what turns Recruitee from “the tool recruiters use” into “a system that syncs with the rest of your stack”, HRIS, payroll, background checks, BI dashboards, Slack, and more.

Key highlights of Recruitee APIs

Create and manage candidates programmatically
Add candidates directly from your sourcing tools, referral forms, or internal systems, without manual entry.
Keep candidate documents in sync
Upload CVs, cover letters, and attachments or update them later, so the ATS stays the source of truth.
Support custom data capture at scale
Add custom fields to candidate profiles (skills, source tags, screening outcomes) to match your hiring workflow.
Automate hiring communications
Manage templates (like auto-replies and event invitations) so messaging stays consistent across roles and teams.
Pull collaboration context like notes
Fetch candidate notes to power internal dashboards, manager views, or audit-ready hiring trails.
Enable cleanup and compliance workflows
Delete candidates, documents, templates, and other records when needed—useful for GDPR-style retention policies.
Connect interview operations to your scheduling layer
Manage interview calendars, events, schedules, meeting rooms, and related templates through APIs.
Track performance and attribution
Use analytics endpoints to measure campaign performance and understand what sources are driving quality applicants.

Recruitee API endpoints

Attachments

POST https://api.recruitee.com/c/{company_id}/attachments : This API endpoint allows users to upload files to either an offer or a candidate profile in the Recruitee system. The request is made to the URL 'https://api.recruitee.com/c/{company_id}/attachments' using the POST method. The request must include a 'Content-Type' header set to 'multipart/form-data' and an 'Authorization' header with a Bearer token. The 'company_id' is a required path parameter. The body of the request should contain an 'attachment' object, which can include a 'remote_file_url' (required), 'candidate_id', and 'offer_id'. The response will include details about the uploaded attachment, such as 'admin_id', 'candidate_id', 'created_at', 'file_url', and more. If authentication fails, a 401 error is returned. If the file is not provided, a 422 error is returned.

Auto Reply Templates

DELETE https://api.recruitee.com/c/{company_id}/auto_reply_templates/{id} : The Delete Auto Reply Template API allows users to delete a specific auto-reply template by providing the company ID and the template ID as path parameters. The request requires the 'Content-Type' header to be set to 'application/json'. Upon successful deletion, the API returns a 200 response code with details of the deleted auto-reply template, including its ID, title, position, and timestamps for creation and last update.

Candidates

POST https://api.recruitee.com/c/{company_id}/candidates : This API endpoint allows users to manually add a candidate to their account in Recruitee. The candidate will not receive an auto-confirmation email, and their profile will indicate they were manually added by the user whose API token was used. The request requires a company ID as a path parameter and a JSON body containing candidate details such as name, emails, phones, social links, and an optional offer ID. The response includes the created candidate's details or an error message if the creation fails.
DELETE https://api.recruitee.com/c/{company_id}/candidates/{id} : This API endpoint allows you to delete a candidate by their ID from the Recruitee platform. It requires the company ID and candidate ID as path parameters, and an authorization token in the headers. The DELETE method is used, and it will permanently remove the candidate if found. The response includes a detailed JSON object of the deleted candidate if successful, or an error message if the candidate is not found.
DELETE https://api.recruitee.com/c/{company_id}/candidates/{id}/delete_cover_letter : The 'Delete Candidate's Cover Letter File' API allows you to delete the cover letter file of a specific candidate in a company. The API requires the company ID and candidate ID as path parameters. The request must include the 'Content-Type: application/json' header. Upon successful deletion, the API returns a 200 response code with detailed information about the candidate, including their ID, name, email, and other attributes. The cover letter field will be set to null, indicating that the cover letter file has been successfully deleted.
DELETE https://api.recruitee.com/c/{company_id}/candidates/{id}/delete_cv : The 'Delete Candidate's CV' API allows you to delete a candidate's CV from the system. It requires the company ID and candidate ID as path parameters. Optionally, you can specify whether to delete data previously extracted from the CV file using the 'delete_parsed_data' query parameter. The request must include the 'Content-Type' header set to 'application/json'. The response returns a detailed JSON object containing the candidate's information, including their last activity, ratings, fields, and GDPR status, among other details.
GET https://api.recruitee.com/c/{company_id}/candidates/{id}/notes : This API endpoint retrieves notes for a specific candidate identified by the candidate ID. The request requires a valid Bearer token for authorization and the company ID and candidate ID as path parameters. The response includes a list of notes, each containing details such as the admin ID, attachments, body content in various formats (HTML, JSON), creation and update timestamps, reactions, replies, and visibility settings. Additionally, the response provides references to the admins involved, including their contact information and profile pictures.
PATCH https://api.recruitee.com/c/{company_id}/candidates/{id}/update_cv : This API endpoint allows updating a candidate's CV file, either by uploading a local file or providing a remote URL. The request requires a PATCH method to the specified URL with the company ID and candidate ID as path parameters. The request headers must include an Authorization token and a Content-Type of 'multipart/form-data'. The body can include a 'candidate' object with a 'remote_cv_url' for the CV file. The response returns the updated candidate details, including the CV URL and update timestamp. If authentication fails, a 401 error is returned.
POST https://api.recruitee.com/c/{company_id}/custom_fields/candidates/{id}/fields : This API allows adding profile fields to a candidate with a specified ID. The request requires the company ID and candidate ID as path parameters. The request body must include the field details, such as the field name, values, and kind, which specifies the input type (e.g., single_line, multi_line, boolean, etc.). The response returns the added field details if successful, or an error message if the request fails.

Devices

DELETE https://api.recruitee.com/c/{company_id}/devices/ : This API endpoint allows the deletion of an admin's device for push notifications. It requires the company ID as a path parameter and the request must include the 'Content-Type' header set to 'application/json'. The response returns a JSON object containing details of the deleted device, including its ID, kind, token, UID, and app type.

Disqualify Reasons

DELETE https://api.recruitee.com/c/{company_id}/disqualify_reasons/{id} : The Delete Disqualify Reason API allows you to delete a specific disqualify reason from the system. It requires the company ID and the disqualify reason ID as path parameters. Optionally, you can provide a fallback disqualify reason ID as a query parameter to replace in OpenQuestionOptions. The request must include the 'Content-Type: application/json' header. The response returns a 200 status code with details of the deleted disqualify reason, including its ID, name, position, and any associated action templates.

Email Templates

DELETE https://api.recruitee.com/c/{company_id}/event_invitation_templates/{id} : The Delete Email Template API allows users to delete an email template by specifying the company ID and the template ID in the URL path parameters. The request requires a 'Content-Type' header set to 'application/json'. The response returns a 200 status code with details of the deleted email template, including its ID, position, title, admin ID, subject, timestamps for creation and last update, HTML body, and any template attachment assignments.

Imports

DELETE https://api.recruitee.com/c/{company_id}/imports/{id} : The Delete Import API allows you to delete an import record from the Recruitee system. It requires the company ID and the import ID as path parameters. The request must include the 'Content-Type' header set to 'application/json'. The response returns a detailed structure of the deleted import, including its ID, status, file name, columns, and associated references. The response body provides information about the import's columns, such as matched fields and values, and details about the admin who performed the import.
DELETE https://api.recruitee.com/c/{company_id}/imports/{import_id}/cvs/{id} : The Delete Import CV API allows users to delete a specific CV from an import in the Recruitee system. The API requires the company ID, import ID, and the CV ID as path parameters. The request must include the 'Content-Type' header set to 'application/json'. The response returns a 200 status code with details of the deleted CV, including its ID, file name, and URLs. The 'import_candidate_id' may be null if not associated with a candidate.

Interview

DELETE https://api.recruitee.com/c/{company_id}/interview/calendars/{id} : The Delete Interview Calendar API allows users to delete an interview calendar by specifying the company ID and the interview calendar ID in the path parameters. The request requires the 'Content-Type' header to be set to 'application/json'. Upon successful deletion, the API returns a response with details of the deleted interview calendar, including its access level, name, status, type, associated admin ID, provider, last sync time, external calendar ID, and a list of external calendars associated with it. The response also indicates whether the subscription for the calendar was active.
DELETE https://api.recruitee.com/c/{company_id}/interview/events/{id} : This API endpoint allows you to delete an interview event and optionally send a notification to the candidate. The endpoint requires the company ID and interview event ID as path parameters. You can also include optional query parameters such as a message to be sent to the candidate and a boolean to notify the candidate. The request must include a 'Content-Type' header set to 'application/json'. The response includes details about the references related to the interview event and the interview event itself, such as the event URL, start time, and associated candidate and admin information.
DELETE https://api.recruitee.com/c/{company_id}/interview/meeting_rooms/{id} : The Delete Meeting Room API allows users to delete a specific meeting room by its ID for a given company. The API requires the company ID and the meeting room ID as path parameters. The request must include the 'Content-Type' header set to 'application/json'. The API does not require a request body. Upon successful deletion, the API returns a 200 response code. No response body is provided.
DELETE https://api.recruitee.com/c/{company_id}/interview/request_links/{id} : The Delete Interview Request Link API allows users to delete a specific interview request link using the DELETE HTTP method. The API requires two URI parameters: 'id', which is the interview request link ID, and 'company_id', which is the company ID. Both parameters are required and must be integers. There are no request headers, query parameters, or request body needed for this API. The response does not specify any headers or body content.
DELETE https://api.recruitee.com/c/{company_id}/interview/result_requests/{id} : The Delete Interview Result Request API allows users to delete a specific interview result request identified by its ID for a given company. The API requires two URI parameters: 'id', which is the interview result request ID, and 'company_id', which is the company ID. Both parameters are required and must be integers. There are no request headers, query parameters, or request body needed for this API. The response does not specify any headers or body content.
DELETE https://api.recruitee.com/c/{company_id}/interview/schedules/{id} : The Delete Interview Schedule API allows users to delete an existing interview schedule by specifying the company ID and interview schedule ID in the URL path parameters. The request requires a 'Content-Type' header set to 'application/json'. The response returns a status code of 200 and includes details of the deleted interview schedule and related references. The response body contains information such as the interview schedule ID, name, location, and other attributes, as well as a list of references associated with the schedule.
DELETE https://api.recruitee.com/c/{company_id}/interview/templates/{id} : The Delete Interview Template API allows users to delete a specific interview template by providing the company ID and interview template ID in the URL path parameters. The request requires a 'Content-Type' header set to 'application/json'. Upon successful deletion, the API returns a 200 response code with details of the deleted interview template, including references and interview questions. The response includes information such as the template's name, category, kind, and associated questions with their options and hints.

Languages

DELETE https://api.recruitee.com/c/{company_id}/lang/languages/ : The Delete Language API allows you to delete a language for a specific company identified by the company_id. The API uses the DELETE HTTP method and requires the company_id as a path parameter. There are no request headers, query parameters, or request body required for this API. The response details, including response headers and body, are not specified in the documentation.

Locations

DELETE https://api.recruitee.com/c/{company_id}/locations/{id} : The Delete Location API allows you to delete a specific location by its ID for a given company. The request requires the company_id and location id as path parameters. The request header must include 'Content-Type: application/json'. The response returns a detailed JSON object of the location that was deleted, including its ID, name, validity, state name, translations, language code, timestamps, note, city, state code, country code, street, postal code, active offers and requisitions count, deletability, and full address.

Mailbox

DELETE https://api.recruitee.com/c/{company_id}/mailbox/messages/{id} : The Delete Message API allows you to delete a specific message from the mailbox of a company using the Recruitee platform. The API requires the company_id as a path parameter, which is mandatory, and optionally the id of the message to be deleted. There are no request headers or body required for this API. The response details are not provided in the documentation.

OAuth

DELETE https://api.recruitee.com/c/{company_id}/oauth/personal_tokens/{id} : The Delete Personal Token API allows you to delete a personal token associated with a specific company. The API requires the company ID and the token ID as path parameters. The request must include the 'Content-Type' header set to 'application/json'. The response does not include a body, and a successful deletion is indicated by a 200 response code.

Offers

DELETE https://api.recruitee.com/c/{company_id}/offers/{offer_id}/fieldsets/fields/{id} : The 'Delete Field from Fieldset' API allows users to delete a specific field from a fieldset associated with an offer in a company. The API requires the company ID, offer ID, and fieldset ID as path parameters. The field ID is optional. The request must include a JSON body with the source fieldset ID. The Content-Type header must be set to 'application/json'. Upon successful deletion, the API returns a 200 response code. No response body is provided.
DELETE https://api.recruitee.com/c/{company_id}/offers/{offer_id}/open_question_templates/open_questions/{id} : The 'Delete Open Question from a Template' API allows users to delete an open question from a specified template within a company's offer. The API requires the company ID, offer ID, and optionally the open question ID as path parameters. The request must include a JSON body with the source template ID. The request header must specify 'Content-Type' as 'application/json'. Upon successful deletion, the API returns a 200 response code with no response body.
GET https://{yourcompany}.recruitee.com/api/offers/ : This API endpoint retrieves a collection of published job offers from a company's careers site. The offers can be filtered by department or tag using query parameters. The response includes detailed information about each job offer, such as the job title, description, requirements, location, and application URLs. It also includes metadata like the job's status, creation and update timestamps, and various options related to the application process. The response can also include open questions that applicants need to answer. The API returns a 404 error if the requested resource is not found.
GET https://{yourcompany}.recruitee.com/api/offers/{id} : This API endpoint retrieves the details of a specific company offer (job) using the provided ID or slug. The request requires the 'id' path parameter, which is mandatory. The response includes detailed information about the job offer, such as its title, description, requirements, location, and other attributes. It also includes translations and open questions related to the job offer. If the offer is not found, a 404 error with a 'Not Found' message is returned.
POST https://{yourcompany}.recruitee.com/api/offers/{offer_slug}/candidates : This API endpoint allows you to apply for a job offer by creating a candidate. The required fields by default are name, phone, email, and cv, but you can adjust these requirements in the offer's settings. The API also supports answering job-related questions by attaching a list of answers to the request. The endpoint requires the 'offer_slug' as a path parameter to identify the job offer. The request body should include candidate details such as name, email, phone, and optionally a remote CV URL and referrer. Upon successful creation, a confirmation email is sent to the candidate. The response includes the candidate's details such as ID, name, emails, phones, and URLs for the photo and CV.

Open Questions

DELETE https://api.recruitee.com/c/{company_id}/open_questions/template/{id} : The Delete Open Question Template API allows users to delete a specific open question template identified by its ID for a given company. The API requires the company ID and the template ID as path parameters. The request must include the 'Content-Type' header set to 'application/json'. Upon successful deletion, the API returns a response with details of the deleted open question template, including its ID, title, category, and timestamps for creation and last update.
DELETE https://api.recruitee.com/c/{company_id}/open_questions/template/{template_id}/open_questions/{id} : This API endpoint allows the user to delete an open question from a specified template within a company. The request requires the company ID, template ID, and open question ID as path parameters. The request header must include 'Content-Type: application/json'. The API does not require a request body and returns a 200 response code with no response body upon successful deletion.

Past Subdomains

DELETE https://api.recruitee.com/c/{company_id}/past_subdomains/{id} : The 'Delete a Past Subdomain' API allows users to delete a specific past subdomain associated with a company. The API requires the company ID and the past subdomain ID as path parameters. The request must include the 'Content-Type' header set to 'application/json'. Upon successful deletion, the API returns a 200 response code with details of the deleted past subdomain, including its ID, name, and timestamps for when it was created and last updated.

Pipeline Templates

DELETE https://api.recruitee.com/c/{company_id}/pipeline_templates/{id} : The Delete Pipeline Template API allows users to delete a specific pipeline template identified by its ID for a given company. The request requires the company ID and the pipeline template ID as path parameters. The request header must include 'Content-Type' as 'application/json'. The API returns a 422 response code if there are assigned offers still associated with the pipeline template, along with an error message detailing the issue.

Placements

DELETE https://api.recruitee.com/c/{company_id}/placements/{id} : The Delete Placement API allows you to delete a specific placement by its ID for a given company. The API requires the company ID and placement ID as path parameters. The request must include a 'Content-Type' header set to 'application/json'. The response returns a 200 status code with details of the references and the placement that was deleted, including information such as reference ID, position, status, type, and other related details.

Reactions

DELETE https://api.recruitee.com/c/{company_id}/reactions/notes/{note_id} : The Delete Note Reaction API allows you to remove a reaction from a note using a specified emoji. The API requires the company ID and note ID as path parameters, and the emoji as a request body parameter. The request must include the 'Content-Type' header set to 'application/json'. Upon successful deletion, the API returns a 200 response code with details of the deleted reaction, including the reaction ID, emoji, base emoji, admin ID, company ID, creation timestamp, and note ID.

Requisitions

DELETE https://api.recruitee.com/c/{company_id}/requisitions/settings/approval_flows/{approval_flow_id} : The Delete Approval Flow API allows you to delete an existing approval flow in the Recruitee system. It requires the company ID and the approval flow ID as path parameters. The request must include the 'Content-Type' header set to 'application/json'. The response returns the details of the deleted approval flow, including its ID, title, position, and other attributes.
DELETE https://api.recruitee.com/c/{company_id}/requisitions/settings/form/{field_name} : The 'Delete Non-Custom Form Field by Name' API allows users to delete a specific non-custom form field by its name from a company's requisition settings. The API requires the company ID and the field name as path parameters. The request must include the 'Content-Type' header set to 'application/json'. Upon successful deletion, the API returns a response with the remaining form fields and a 'pristine' status indicating whether the form is in its original state.

DELETE https://api.recruitee.com/c/{company_id}/share/containers/{id} : The Delete Container API allows users to delete a specific container identified by its ID within a company. The API requires the company_id and container id as path parameters. The request must include the 'Content-Type: application/json' header. The response returns a status code of 200 and provides details about the references and the container that was deleted, including information such as reference IDs, types, emails, and container attributes like active status, token, visibility options, and more.
DELETE https://api.recruitee.com/c/{company_id}/share/guests/{id} : The Delete Guest API allows you to remove a guest from the system using their unique guest ID and company ID. The API requires the 'Content-Type' header to be set to 'application/json'. The endpoint is structured with the company ID and guest ID as path parameters. Upon successful deletion, the API returns a 200 response code with details of the deleted guest, including their ID, name, email, authentication token, and other attributes.
DELETE https://api.recruitee.com/c/{company_id}/shared_email_providers/{id} : The 'Delete Archived Shared Email Provider' API allows users to delete a shared email provider that has been archived. This API requires two URI parameters: 'company_id', which is the ID of the company, and 'id', which is the ID of the shared email provider to be deleted. Both parameters are required and must be integers. There are no request headers or body required for this API. The response does not specify any headers or body content.
DELETE https://api.recruitee.com/share/containers/{token}/notes/{id} : The Delete Note API allows users to delete a specific note identified by its ID within a container identified by a token. The request requires the note ID and container token as path parameters, and a guest token as a query parameter. The request header must include 'Content-Type: application/json'. The response returns a 200 status code with details of the deleted note, including its ID, text, HTML body, creation timestamp, guest details, and other metadata.
DELETE https://api.recruitee.com/share/containers/{token}/results/{id} : The 'Delete Interview Result for Candidate' API allows users to delete an interview result for a specific candidate. The API requires the interview result ID and container token as URI parameters. The request must include the 'Content-Type' header set to 'application/json'. The response returns a 200 status code with details of the deleted interview result, including the interview result ID, kind, associated offer details, admin information, timestamps, guest details, stage information, and rating.
DELETE https://api.recruitee.com/share/interview/questionnaire/attachments/{id} : The Delete Attachment API allows users to delete an attachment by specifying its ID in the path parameters. The request requires a 'Content-Type' header set to 'application/json'. The response returns a status code of 200 upon successful deletion, along with details of the deleted attachment, including its ID, status, filename, extension, creation timestamp, and URLs for the file, image thumbnail, and image.

Texting

DELETE https://api.recruitee.com/c/{company_id}/texting/messages/ : The 'Delete Failed or Scheduled Message' API allows users to delete a message that is either failed or scheduled. The API requires the company ID as a path parameter and uses the DELETE HTTP method. The request must include the 'Content-Type' header set to 'application/json'. The response returns a message object containing details such as the message ID, status, text, receiver, sender, and timestamps for creation and last update. The response also includes additional information like unread message IDs, thread ID, and segment count.

Tracking

DELETE https://api.recruitee.com/c/{company_id}/tracking/slack_integrations/{id} : The 'Delete Company Slack Integration' API allows users to remove a specific Slack integration from a company's tracking system. It requires two URI parameters: 'id', which is the SlackIntegration ID, and 'company_id', which is the Company ID. Both parameters are mandatory. There are no request headers or body required for this API call. The response details are not provided in the documentation.

Analytics

POST https://api.s.recruitee.com/i/p/{partner}/analytics : This API endpoint retrieves aggregate campaign data for specified campaigns. It uses the POST method to handle potentially long arrays of campaign identifiers. The request requires a partner path parameter and optionally includes a secret query parameter for authentication. The request body should contain an array of campaign IDs under 'utm_campaigns'. The response includes detailed analytics for each campaign, such as active and disqualified statuses, unique visits, and total visits. If unauthorized, a 401 error is returned, and if parameters are invalid, a 422 error is returned.

Sample

POST https://api.example.com/v1/sample : This API endpoint processes user data and returns a success message.

FAQs for Recruitee API Integration

Do I need a company_id for every API call?
For most company-scoped endpoints, yes. It’s a required path parameter and determines which Recruitee workspace you’re operating on.
How do I authenticate with the Recruitee API?
Most endpoints expect an Authorization: Bearer <token> header. Make sure your token management is secure and rotated as needed.
What’s the difference between the careers site offers APIs and the company APIs?
Careers site offer endpoints use the {yourcompany}.recruitee.com domain and are focused on published job offers and applications. Company APIs use api.recruitee.com and cover admin-side operations like candidates, templates, interviews, etc.
Can I upload CVs and other files via the API?
Yes. Use multipart/form-data endpoints like attachments and CV update endpoints to upload or link remote files.
How should I handle deletes safely (candidates, templates, notes, etc.)?
Treat delete operations as irreversible unless your internal systems retain a backup. Use role-based access and strict logging around delete calls.
Is there webhook support for real-time updates?
Your highlights reference webhook syncing. If you rely on real-time flows, align your integration around event-driven updates instead of constant polling.
What should I do if I hit rate limits or see 401/422 errors?
401 usually means auth/token issues. 422 typically means validation problems (missing required fields, wrong body shape). For rate limits, implement retries with backoff and reduce noisy polling.

Get Started with Recruitee API Integration

If you want a faster path to production, Knit API can sit in front of your Recruitee integration so you don’t burn cycles on auth, token refresh, edge cases, and ongoing maintenance. Integrate once, and standardize how you connect to Recruitee across workflows, cleaner operations, fewer breakages, and a lot less integration debt.

‍

Jan 3, 2026

Workable API Directory

Workable is a cloud-based recruitment and HR platform built to run the day-to-day mechanics of hiring, job posting, applicant tracking, interview coordination, and related HR operations. Teams use it to keep sourcing, screening, and hiring workflows in one place, instead of juggling spreadsheets, inbox threads, and scattered tools.

Where Workable becomes especially useful is when you connect it to the rest of your stack, your careers site, assessment and background check providers, HRIS/payroll tools, BI dashboards, and internal systems. The Workable API gives you the plumbing for this: you can pull hiring data, push candidates into jobs, move them through stages, trigger events via webhooks, and keep your systems in sync without manual effort.

Key highlights of Workable APIs

Push candidates into the right job pipeline automatically
Create candidates against a job shortcode, map them to the correct stage, and reduce recruiter admin time.
Move, disqualify, revert, and tag candidates from external systems
If your workflow starts in a sourcing tool or internal referral portal, you can still control candidate lifecycle actions in Workable.
Trigger assessments, interviews, and background checks programmatically
Create assessment/check/interview requests and track results through callback URLs, no “copy-paste into vendor portals”.
Stream hiring activity for visibility and audit trails
Pull job activity streams to understand who did what, when, useful for compliance, leadership reporting, and debugging process bottlenecks.
Build dynamic application forms that match Workable’s job configuration
Use the application form and questions endpoints to render the correct form on a custom careers experience.
Support multi-stakeholder hiring teams cleanly
Fetch job members, recruiters, and combined hiring teams to align roles, responsibilities, and permissions in your internal tooling.
Use subscriptions/webhooks to reduce polling and keep systems fresh
Subscribe to event notifications instead of hammering the API every few minutes.
Scale with structured account-level objects
Pull departments, legal entities, work schedules, custom attributes, so downstream HR ops and analytics don’t run on half-baked data.

Workable API Endpoints

Candidate Management

POST https://${BASE_URL}/assessments : The Create Candidate Assessment API allows Workable to create an assessment for a candidate by sending a POST request to the Assessments Provider. The request must include an authorization header with a Bearer token, and a JSON body containing the test ID, job title, callback URL, and candidate information. The Assessments Provider responds with a 201 status and an assessment ID. This ID can be used to track the assessment status and results. The API facilitates the integration between Workable and the Assessments Provider, enabling seamless candidate assessment management.
POST https://${BASE_URL}/checks : This API endpoint allows Workable to create a background check request for a candidate by sending a POST request to the Background Check Provider. The request must include an authorization header with a Bearer token, and a JSON body containing the package ID, job title, callback URL, candidate information, and optional preferences. Upon successful creation, the API returns a 201 status with a background check ID. The callback URL is used by the Background Check Provider to publish the results once the background check is completed.
POST https://${BASE_URL}/interviews : This API endpoint allows Workable to create an interview invitation for a candidate using a Video Interview Provider. The POST request is sent to the /interviews endpoint with a payload containing the interview template ID, job details, callback URL, candidate information, and optional preferences. The request must include an Authorization header with a Bearer token for authentication. Upon successful creation, the API responds with a 201 status and an interview ID. The callback URL is used by the Video Interview Provider to publish interview results back to Workable.
POST https://subdomain.workable.com/spi/v3/employee_events : The Employee Events Notification API is used to notify an SPI Client about various employee-related events such as creation, update, onboarding completion, and publication. When an event occurs, the Workable SPI sends a notification to the SPI Client with relevant employee data. The API requires a POST request with headers for content type and authorization. The request body includes details about the employee and the event type. The response indicates the success or failure of the event processing.
POST https://workable.readme.io/docs/job-candidates-show : The Candidate Events API is triggered when an event related to a candidate occurs. It provides detailed information about the candidate, including personal details, education, experience, and social profiles. The API accepts a payload containing candidate data, event type, and event metadata. The response includes the same data structure, confirming the event details. This API is useful for tracking candidate progress and managing recruitment workflows.
POST https://workable.readme.io/page/assessment-providers : The Assessments & Video Interviews API allows Assessment Providers, Video Interview Providers, and Background Check Providers to integrate their services with Workable. This API enables providers to inject assessments, video interviews, and background check results directly into a candidate's timeline on Workable. The API requires an Authorization header with a bearer token for authentication and a Content-Type header. The request body must include the candidate's unique identifier, the type of assessment or interview, the provider's name, and optionally, the results of the assessment or interview. The response includes the status and a message indicating the success or failure of the integration.
POST https://{subdomain}.workable.com/spi/v3/candidates/{id}/comments : This API creates a attachment for an application using comments API.
POST https://{subdomain}.workable.com/spi/v3/candidates/{id}/copy : This API endpoint allows you to copy a candidate to another job within the Workable platform. It requires a POST request to the specified URL with the candidate's ID and the target job's shortcode. The request must include a Bearer token for authorization. The body of the request should contain the member ID performing the action, the target job shortcode, and optionally the target stage. Upon success, it returns the ID and URL of the newly created candidate. If the request fails, it returns an error message.
POST https://{subdomain}.workable.com/spi/v3/candidates/{id}/disqualify : This API disqualifies a candidate using the POST method. It requires the 'w_candidates' scope and is accessible with all token types. The endpoint is 'https://{subdomain}.workable.com/spi/v3/candidates/{id}/disqualify'. The request must include the Authorization header with a Bearer token, and the Content-Type and Accept headers set to 'application/json'. The path parameters include 'subdomain' for the account subdomain and 'id' for the candidate's id. The body must include 'member_id', the id of the member performing the disqualification, and optionally 'disqualification_reason'. The response can be a 200 status code with an empty body for success, a 401 status code with an error message for unauthorized access, or a 404 status code with an error message if the candidate is not found.
POST https://{subdomain}.workable.com/spi/v3/candidates/{id}/move : This API endpoint allows moving a candidate to another stage in the hiring process. It requires the 'w_candidates' scope and is accessible with all token types. The endpoint is 'https://{subdomain}.workable.com/spi/v3/candidates/{id}/move' and uses the POST method. The request optionally includes the target_stage to move the candidate to. If the hiring plan is enabled and the candidate is being moved to the 'hired' stage, additional requisition information may be required. The response will be empty on success, or contain an error message if the request fails.
POST https://{subdomain}.workable.com/spi/v3/candidates/{id}/ratings : This API creates a rating for a candidate. It requires the 'w_candidates' scope and is accessible with all token types. The endpoint requires a subdomain and candidate ID as path parameters. The request body must include the member ID of the person performing the rating, and optionally a comment and score. The API returns a 201 status code on success, a 401 status code if unauthorized, and a 404 status code if the candidate is not found.
POST https://{subdomain}.workable.com/spi/v3/candidates/{id}/relocate : This API endpoint relocates a candidate to another job within the Workable platform. It requires the 'w_candidates' scope and is accessible with all token types. The request must include the subdomain and candidate ID as path parameters, and the member ID, target job shortcode, and optionally the target stage in the request body. The response will include the new candidate's ID and URL if successful, or an error message if not.
POST https://{subdomain}.workable.com/spi/v3/candidates/{id}/revert : This API reverts a candidate's disqualification in the Workable system. It requires the 'w_candidates' scope and is accessible with all token types. The request must include the account subdomain and candidate's id as path parameters, and the member_id of the person performing the action in the request body. The request headers must include 'Content-Type' as 'application/json', 'Authorization' with a Bearer token, and 'Accept' as 'application/json'. A successful request returns a 201 status code with no content. If the request is unauthorized, a 401 status code with an error message is returned. If the candidate is not found, a 404 status code with an error message is returned.
PUT https://{subdomain}.workable.com/spi/v3/candidates/{id}/tags : This API updates the tags of a candidate in the Workable system. It requires the 'w_candidates' scope and can be accessed with all token types. The API endpoint is 'https://{subdomain}.workable.com/spi/v3/candidates/{id}/tags'. The request must include the 'Content-Type', 'Authorization', and 'Accept' headers. The 'subdomain' and 'id' are required path parameters. The request body must contain a 'tags' array, which will replace the candidate's current tags. If the array is empty, all tags will be removed. A successful request returns a 202 status code with the updated tags. If unauthorized, a 401 status code with an error message is returned. If the candidate is not found, a 404 status code with an error message is returned.
PATCH https://{subdomain}.workable.com/spi/v3/candidates/{id}/update_custom_attribute_value : This API endpoint allows updating a custom attribute value for a candidate in the Workable system. It requires the 'r_jobs' scope and is accessible with all token types. The endpoint URL is structured with a subdomain and candidate ID as path parameters. The request must include an Authorization header with a Bearer token, and the Content-Type and Accept headers set to 'application/json'. The request body varies based on the type of custom attribute being updated, such as boolean, short text, free text, numeric, file (base64 or URL), date, dropdown, or multiple choice. The response includes detailed candidate information if successful, or an error message if unauthorized or not found.

Job Management

GET https://<subdomain>.workable.com/spi/v3/jobs : The Partner Token Integration for Workable API allows third-party providers to access specific endpoints using a Partner Token. This token is used for authorization and is associated with specific scopes determined during integration development. To use this API, the request must include headers for Content-Type, Authorization with the Partner Token, and X-WORKABLE-CLIENT-ID with the Client ID (UID). The API endpoint retrieves jobs filtered by their state, such as 'published'. The response includes a list of job objects with details like job ID, title, and state.
GET https://{subdomain}.workable.com/spi/v3/jobs : This API endpoint retrieves a collection of jobs associated with your account from Workable. It requires the 'r_jobs' scope and is accessible with all token types. The endpoint supports various query parameters to filter the jobs based on state, creation date, update date, and more. The response includes an array of job objects, each containing details such as job ID, title, department, location, and salary. The response also includes paging information to navigate through multiple pages of results.
GET https://{subdomain}.workable.com/spi/v3/jobs/{shortcode} : The Get Job Details API retrieves detailed information about a specific job using its shortcode. It requires an authorization bearer token with the 'r_jobs' scope. The API endpoint is 'https://{subdomain}.workable.com/spi/v3/jobs/{shortcode}', where 'shortcode' is a required path parameter representing the job's unique code. The response includes comprehensive job details such as the job's title, state, department, location, description, requirements, benefits, employment type, industry, function, experience, education, keywords, and salary information. The API returns a JSON object with all these details, and it can respond with error messages if the request is unauthorized or if the job is not found.
GET https://{subdomain}.workable.com/spi/v3/jobs/{shortcode}/activities : The Get Job Activity Stream API retrieves the activity stream of a specified job using its shortcode. It requires the 'r_candidates' scope and is accessible with all token types. The API endpoint is 'https://{subdomain}.workable.com/spi/v3/jobs/{shortcode}/activities'. The request must include a Bearer token in the Authorization header. The 'shortcode' path parameter is required to specify the job. Optional query parameters include 'limit' to specify the number of activities per page, 'since_id' to filter activities with an ID greater than or equal to the specified ID, and 'max_id' to filter activities with an ID less than or equal to the specified ID. The response includes an array of activities, each containing details such as action, stage name, creation timestamp, candidate information, member information, and activity body. Possible response status codes include 200 (success), 401 (not authorized), and 404 (not found).
GET https://{subdomain}.workable.com/spi/v3/jobs/{shortcode}/application_form : This API endpoint retrieves the application form details for a specified job using the job's shortcode. It requires a Bearer token for authorization and the 'r_jobs' scope. The endpoint returns a JSON object containing two arrays: 'form_fields' and 'questions'. The 'form_fields' array includes details about each form field, such as key, label, type, and whether it is required. The 'questions' array includes details about each question, such as id, body, type, and whether an answer is required. This API is useful for building dynamic application forms that adhere to the rules defined in the Job Editor's 'Application Form' tab.
POST https://{subdomain}.workable.com/spi/v3/jobs/{shortcode}/candidates : This API endpoint allows you to create a candidate for a specific job in Workable. It is useful for integrating custom application forms, migrating existing candidates, or integrating with other systems. The API requires a POST request to the specified URL with a JSON body containing candidate details such as name, email, headline, summary, and more. You can also include additional information like education, experience, skills, social profiles, and a resume. The 'sourced' flag determines if the candidate is considered as uploaded or applied. The response includes the status of the creation and details of the created candidate.
GET https://{subdomain}.workable.com/spi/v3/jobs/{shortcode}/combined_members_recruiters : This API endpoint retrieves a combined list of account members and external recruiters associated with a specific job, identified by its shortcode. It requires an authorization bearer token and the job's shortcode as a path parameter. The response includes details about each member, such as their ID, name, headline, email, role, and collaboration role within the hiring team, as well as a list of external recruiters with their ID, name, and email address. If the request is unauthorized or the job is not found, an error message is returned.
GET https://{subdomain}.workable.com/spi/v3/jobs/{shortcode}/custom_attributes : This API endpoint retrieves a collection of custom attributes relevant to a specific job identified by its shortcode. The request requires a Bearer token for authorization and the job's shortcode as a path parameter. The response includes an array of custom attributes, each with details such as id, type, label, hint, and choices for multiple_choice types. The API returns a 200 status code with the custom attributes on success, and error messages with status codes 401 or 404 for unauthorized or not found errors, respectively.
GET https://{subdomain}.workable.com/spi/v3/jobs/{shortcode}/members : This API endpoint retrieves a collection of account members associated with a specific job, identified by its shortcode. It requires an authorization bearer token with the 'r_jobs' scope. The endpoint returns details about each member, including their ID, name, headline, email, role, and collaboration role within the hiring team. The roles are defined at the account level and include admin, simple, recruiter, and reviewer. The collaboration roles are specific to the job and include admin, recruiting_admin, hiring_manager, simple, reviewer, and recruiter. The API returns a 200 status code with member details on success, a 401 status code if not authorized, and a 404 status code if the job is not found.
GET https://{subdomain}.workable.com/spi/v3/jobs/{shortcode}/questions : The Get Job Questions API retrieves a list of questions associated with a specific job identified by its shortcode. This API requires the 'r_jobs' scope and is accessible with all token types. The request must include an Authorization header with a Bearer token and a Content-Type header set to 'application/json'. The endpoint returns a JSON array of questions, each containing details such as the question's ID, body, type, and whether it is required. Additional fields may include choices for dropdown or multiple choice questions, supported file types, and maximum file size for file upload questions. The API can return a 401 status code if not authorized or a 404 status code if the job is not found.
GET https://{subdomain}.workable.com/spi/v3/jobs/{shortcode}/recruiters : This API endpoint retrieves a collection of external recruiters associated with a specific job in your account. It requires a valid Bearer token for authorization and the job's shortcode as a path parameter. The response includes a list of recruiters, each with an ID, name, and email address. If the request is unauthorized or the job is not found, an error message is returned.
GET https://{subdomain}.workable.com/spi/v3/jobs/{shortcode}/stages : This API endpoint retrieves a collection of recruitment pipeline stages for a specific job identified by its shortcode. It requires an authorization bearer token with the 'r_jobs' scope. The response includes details of each stage such as its unique slug, name, type, and position in the pipeline. Possible response status codes include 200 for success, 401 for unauthorized access, and 404 if the job is not found.

Account Management

GET https://api.workable.com : The Workable API provides access to recruiting data, allowing users to extract information about their account, hiring members, pipeline stages, jobs, scheduled events, and job or candidate activities. It also enables managing candidates by fetching, creating, updating, and executing various actions on them. Additionally, it allows managing employees by listing, getting information, creating, and updating employee records and documents. The API does not support CORS and uses different resource IDs for non-disclosure reasons.
GET https://app.merge.dev/signup : The 'Integrate with Workable via Merge' API allows developers to seamlessly integrate their applications with Workable using Merge's Unified API for Applicant Tracking Systems. This API provides a standardized data model to facilitate data exchange between your product and various platforms, including HRIS/Payroll, ATS, Accounting, CRM, and more. Merge handles the integration process end-to-end, offering tools for data sync control, webhook configuration, and issue resolution. Key features include easy onboarding through Merge Link, continuous real-time data syncing, bi-directional data flow, and access to custom fields. Developers can manage integrations using a comprehensive suite of tools provided by Merge. To get started, sign up for a free account or schedule a demo to explore how Merge can support your integration needs.
GET https://workable.com/spi/v3/accounts : This API endpoint retrieves a collection of all accounts that the authenticated user has access to. It requires the 'r_jobs' scope and is accessible with all token types. The request must include an Authorization header with a Bearer token and a Content-Type header set to 'application/json'. The response includes a list of accounts, each with details such as id, name, subdomain, description, summary, and website URL. If the request is unauthorized, a 401 status code with an error message is returned.
GET https://workable.com/spi/v3/accounts/{subdomain} : The Get Account Details API retrieves information about a specific account using the subdomain as a path parameter. It requires an authorization bearer token with the 'r_jobs' scope. The response includes details such as the account's unique ID, name, subdomain, description, summary, and website URL. If the request is unauthorized or the account is not found, appropriate error messages are returned.
GET https://www.workable.com/api/accounts/{subdomain} : This API endpoint retrieves a collection of public jobs for a specified account on Workable. The endpoint requires a path parameter 'subdomain' which is the account's subdomain. An optional query parameter 'details' can be included to fetch job descriptions. The response includes the account's name, description, and a list of public jobs. Each job contains detailed information such as title, code, location, department, telecommuting status, publication date, URLs, description, employment type, industry, function, experience, and education requirements. A 404 status code is returned if the account is not found.
GET https://www.workable.com/api/accounts/{subdomain}/departments : This API endpoint retrieves a collection of departments for the public jobs of a specified account. The request requires a path parameter 'subdomain' which is the account subdomain. The response includes a list of departments, each containing the department's name, the number of public jobs in that department, and a URL. If the account is not found, a 404 status code is returned with an error message.
GET https://www.workable.com/api/accounts/{subdomain}/locations : This API endpoint retrieves a collection of locations where public jobs are available for a specified account. The request requires a path parameter 'subdomain' which is the account's subdomain. The response includes a list of locations, each with a 2-letter country code, the name of the country, the count of public jobs in that country, and a URL for location-specific jobs. If the account is not found, a 404 status code is returned with an error message.
GET https://{subdomain}.workable.com/spi/v3/custom_attributes : This API endpoint retrieves a collection of custom attributes associated with an account. It requires the 'r_jobs' scope and is accessible with all token types. The endpoint URL is 'https://{subdomain}.workable.com/spi/v3/custom_attributes', where 'subdomain' is a required path parameter representing the account's subdomain. The request must include an 'Authorization' header with a Bearer token and a 'Content-Type' header set to 'application/json'. The response includes an array of custom attributes, each with details such as 'id', 'type', 'enabled', 'label', 'hint', and for multiple_choice types, 'choices' with 'id', 'body', 'hint', and 'translations'. Possible response status codes include 200 (success), 401 (not authorized), and 404 (not found).
GET https://{subdomain}.workable.com/spi/v3/departments : This API endpoint retrieves a collection of departments associated with your account. It requires the 'r_account' scope, which can be enabled through the Integrations section in the Settings menu. The endpoint is accessible for accounts with Employee Management features enabled. The request must include a Bearer token in the Authorization header and the account subdomain as a path parameter. The response returns a list of departments, each with an 'id', 'name', 'parent_id', and 'archived' status. If the request is unauthorized, a 401 status code with an error message is returned. If the endpoint is not found, a 404 status code with an error message is returned.
GET https://{subdomain}.workable.com/spi/v3/legal_entities : This API endpoint retrieves a collection of legal entities associated with your account. It requires the 'r_account' scope, which can be enabled through the Integrations section in the Settings menu. The endpoint is accessible only for accounts with Employee Management features enabled. The request must include a Bearer token for authorization and specify the account subdomain as a path parameter. The response includes an array of legal entities, each with details such as id, name, legal_name, type, parent_id, and display_name. The API returns a 200 status code with the list of entities on success, a 401 status code if not authorized, and a 404 status code if the resource is not found.
GET https://{subdomain}.workable.com/spi/v3/members : The Get Account Members API retrieves a collection of members associated with your account. It requires the 'r_jobs' scope and can be accessed using account or user tokens. The API endpoint is 'https://{subdomain}.workable.com/spi/v3/members'. The request must include an Authorization header with a Bearer token and a Content-Type header set to 'application/json'. Optional query parameters include 'limit', 'since_id', 'max_id', 'role', and 'shortcode' to filter the results. The response includes a list of members with details such as 'id', 'name', 'headline', 'email', 'role', and 'hris_role'. Possible roles include 'admin', 'simple', and 'reviewer', while hris roles include 'hris_admin' and 'hris_employee'. The API returns a 200 status code on success, and error messages for 401 (Not authorized) and 404 (Not found) status codes.
GET https://{subdomain}.workable.com/spi/v3/work_schedules : The Get Account Work Schedules API endpoint retrieves a collection of work schedules associated with a specific account. It requires the 'r_account' scope for authorization, which can be enabled through the Integrations section in the Settings menu. The endpoint is accessed via a GET request to 'https://{subdomain}.workable.com/spi/v3/work_schedules', where 'subdomain' is a required path parameter representing the account subdomain. The request must include an Authorization header with a Bearer token and an 'accept' header specifying 'application/json'. The response is a JSON array of work schedule objects, each containing an 'id', 'name', 'status', 'work_days', 'week_starts_on', and 'work_hours'. The 'work_days' field is an array detailing the work hours and intervals for each day of the week. The API returns a 200 status code with the work schedules on success, a 401 status code if not authorized, and a 404 status code if the resource is not found.

Offer Management

GET https://{subdomain}.workable.com/spi/v3/offers/{id} : The Get Offer Details API retrieves detailed information about a specific offer using its ID. The API requires a GET request to the endpoint https://{subdomain}.workable.com/spi/v3/offers/{id} with a Bearer token for authorization. The path parameter 'id' is required to specify the offer ID. The response includes details such as candidate information, offer creation date, document variables, related documents, and the state of the offer. The API returns a JSON object with requisition details, including job, department, location, hiring manager, salary range, employment type, and approval groups. In case of errors, it returns appropriate error messages such as 'Not authorized' or 'Not found'.
PATCH https://{subdomain}.workable.com/spi/v3/offers/{id}/approve : The Approve Offer API allows users to approve an offer that is in a compatible state. This API requires the 'w_offers' scope and is accessible only with user tokens. The endpoint is 'https://{subdomain}.workable.com/spi/v3/offers/{id}/approve' and uses the PATCH method. The request must include the 'Authorization' header with a Bearer token and the 'Content-Type' header set to 'application/json'. The 'id' path parameter is required to specify the offer to be approved. The response includes a JSON representation of the offer, detailing requisitions, job information, department, location, hiring manager, owner, salary range, employment type, requisition attributes, and approval groups. Possible error responses include 'Not authorized' (401) and 'Not found' (404).
PATCH https://{subdomain}.workable.com/spi/v3/offers/{id}/reject : The 'Reject an Offer' API allows users to reject an offer that is in a compatible state. It requires the 'w_offers' scope and is accessible only with user tokens. The API endpoint is 'https://{subdomain}.workable.com/spi/v3/offers/{id}/reject' and uses the PATCH method. The request must include an Authorization header with a Bearer token and a Content-Type header set to 'application/json'. The path parameter 'id' is required to specify the offer ID. The request body can optionally include a 'rejection_reason'. The response returns a JSON representation of the offer, including details such as candidate information, offer state, document variables, and related documents. Possible response status codes include 200 (success), 401 (not authorized), and 404 (not found).

Requisition Management

POST https://{subdomain}.workable.com/spi/v3/requisitions : The Create Requisition API allows users to create a new requisition in the system. It requires a POST request to the specified endpoint with the necessary authorization header. The request must include the subdomain as a path parameter and a JSON body containing details such as the requisition code, owner ID, hiring manager ID, job title, and plan date. Optional fields include job ID, department ID, location details, employment type, experience, salary range, and custom attributes. The response returns a JSON object with the requisition details, including job, department, location, hiring manager, owner, salary range, employment type, reason, state, requisition attributes, and approval groups. The API requires the 'w_requisitions' scope and is accessible with user tokens only.
GET https://{subdomain}.workable.com/spi/v3/requisitions/{code} : The Get Requisition Details API retrieves detailed information about a specific requisition identified by its code. It requires a Bearer token for authorization and returns a comprehensive JSON object containing details such as job information, department, location, hiring manager, owner, salary range, employment type, and more. The API also provides information on requisition attributes and approval groups. The response includes the requisition's state, reason, and other relevant details. In case of errors, it returns appropriate error messages.
PATCH https://{subdomain}.workable.com/spi/v3/requisitions/{code}/approve : The Approve Requisition API allows users to approve a requisition that is in a compatible state. This API requires the 'w_requisitions' scope and is accessible with user tokens only. The endpoint is 'https://{subdomain}.workable.com/spi/v3/requisitions/{code}/approve' and uses the PATCH method. The request must include an Authorization header with a Bearer token and a Content-Type header set to 'application/json'. The path parameter 'code' is required and specifies the code of the requisition to be approved. Upon successful approval, the API returns a full requisition JSON object containing details such as job, department, location, hiring manager, owner, plan date, salary range, employment type, reason, state, requisition attributes, and approval groups. Possible response status codes include 200 (success), 401 (not authorized), and 404 (not found).
PATCH https://{subdomain}.workable.com/spi/v3/requisitions/{code}/reject : The 'Reject a Requisition' API allows users to reject a requisition that is in a compatible state. This API requires the 'w_requisitions' scope and is accessible with user tokens only. The endpoint is 'https://{subdomain}.workable.com/spi/v3/requisitions/{code}/reject' and uses the PATCH method. The request must include a Bearer token for authorization and the requisition code as a path parameter. An optional rejection reason can be provided in the request body. Upon successful rejection, the API returns the full requisition JSON object, which includes details such as job, department, location, hiring manager, owner, plan date, salary range, employment type, reason, state, requisition attributes, and approval groups. If the request fails, an error message is returned.
PATCH https://{subdomain}.workable.com/spi/v3/requisitions/{id} : The Update Requisition API allows users to update an existing requisition in the Workable system. This API requires a PATCH request to the endpoint https://{subdomain}.workable.com/spi/v3/requisitions/{id} with the necessary authorization header. The path parameters include the subdomain and the requisition ID. The request body can include various fields such as owner_id, hiring_manager_id, location details, employment type, experience, salary details, reason, notes, plan date, and custom attributes. The response returns the full requisition JSON object, including details like job, department, location, hiring manager, owner, salary range, employment type, reason, state, requisition attributes, and approval groups. The API requires the 'w_requisitions' scope and is accessible with user tokens only.

Subscription Management

POST https://{subdomain}.workable.com/spi/v3/subscriptions : This API allows you to subscribe to specific events in the Workable system by registering your service with a target URL. The request requires a Bearer token for authorization and includes a subdomain path parameter. The body of the request must specify a target URL and an event type, with optional arguments for further filtering. The response will include the subscription ID if successful, or an error message if not.
DELETE https://{subdomain}.workable.com/spi/v3/subscriptions/{id} : This API endpoint allows users to unsubscribe from an event by deleting a subscription. It requires the 'r_candidates' or 'r_employees' scope and is accessible with all token types. The endpoint is used to delete obsolete subscriptions, especially for third-party integrations. The request must include the account subdomain and the ID of the webhook subscription as path parameters. The request headers must include 'Content-Type', 'Authorization', and 'Accept'. A successful request returns a 200 status code with an empty body. If the authorization fails, a 401 status code with an error message is returned. If the subscription is not found, a 404 status code with an error message is returned.

Time Off Management

GET https://{subdomain}.workable.com/spi/v3/timeoff/balances : The Get Time Off Balances API endpoint retrieves a collection of time off balances for all time off categories for a specific employee. It requires the 'r_timeoff' scope, which can be enabled through the Integrations section in the Settings menu. The endpoint requires a Bearer token for authorization and accepts an optional 'employee_id' query parameter if an account level token is used. The response includes details such as available units, units carried over, units used, and whether the category has unlimited time off, along with category ID, tracking unit, name, and description.
GET https://{subdomain}.workable.com/spi/v3/timeoff/categories : The List Time Off Categories API endpoint retrieves all time off categories configured for a specific account. It requires the 'r_timeoff' scope, which can be enabled through the Integrations section in the Settings menu. The endpoint requires a Bearer token for authorization and the account subdomain as a path parameter. The response includes a collection of time off categories, each with a unique identifier, name, type (either 'paid' or 'unpaid'), and a description. Possible response status codes include 200 for success, 401 for unauthorized access, and 404 if the resource is not found.
POST https://{subdomain}.workable.com/spi/v3/timeoff/requests : This API endpoint allows users to create a new time off request. It requires a user-level token with the 'w_timeoff' scope for authorization. The request body must include the category_id, from_date, and to_date as required fields. Optional fields include half_days, which is an array of objects specifying half days, and a note with a maximum of 140 characters. The response will include details of the created time off request, such as the id, dates, state, and category name. If the request is unauthorized or the endpoint is not found, appropriate error messages will be returned.

FAQs

1) What’s the fastest way to start integrating with Workable?

Start with the basics: list jobs, fetch job details, and create candidates into a job pipeline. That gives you immediate value and a clear data model for the rest.

2) Do I need webhooks, or can I just poll the API?

If you want reliable “near real-time” updates without burning rate limits, use subscriptions/webhooks. Polling is fine for low-volume use cases, but it doesn’t scale cleanly.

3) How do I build a custom application form that matches Workable?

Use the application form and questions endpoints for the job shortcode, and render those fields exactly. This avoids drift between what Workable expects and what your form captures.

4) What’s the cleanest way to automate candidate progression through stages?

Create the candidate, then use the move endpoint to route them based on events (assessment complete, interview submitted, hiring manager review, etc.). Keep your stage mapping in one config file so it’s maintainable.

5) How do I sync hiring team access and accountability?

Pull job members, recruiters, and combined members/recruiters so your internal tooling knows who’s on the loop, and who should approve, review, or act.

6) What should I track for debugging and audit?

Track request IDs, timestamps, the candidate/job identifiers you used, and webhook delivery outcomes. Most integration “mystery bugs” are just missing correlation across systems.

7) Can I integrate Workable with multiple HR tools without building everything from scratch?

Yes, but you’ll end up maintaining auth, mappings, webhooks, retries, and edge cases across every connector. That’s the real cost, engineering time and operational drag.

Get started with Workable API integration using Knit

If you want quick and seamless access to Workable APIs without spending weeks on authentication, authorization, retries, and ongoing maintenance, use Knit. Integrate once with Knit, and standardize how you connect to Workable, so your team focuses on shipping workflows, not babysitting integrations.

‍

Jan 3, 2026

Zoho Recruit API Directory

Zoho Recruit is a cloud-based applicant tracking system built to handle the real mechanics of hiring, candidates, job openings, interviews, submissions, and reviews, without forcing teams into rigid workflows. It’s widely used by HR teams, recruitment agencies, and staffing firms that need control over hiring pipelines, not just a pretty UI.

Where Zoho Recruit really scales is through its API layer. The Zoho Recruit API allows you to plug recruiting data directly into your internal systems, HRIS, payroll, BI tools, CRMs, or custom hiring dashboards, so hiring stops being a siloed function and becomes part of your core operations.

Key Highlights of Zoho Recruit APIs

Full control over hiring data
Read, create, update, and delete candidates, job openings, interviews, applications, and submissions programmatically—no UI dependency.
Bulk data operations at scale
Export or ingest up to hundreds of thousands of records using bulk read and write APIs, ideal for migrations, audits, or analytics pipelines.
End-to-end hiring workflow automation
Move candidates across stages, schedule or cancel interviews, submit candidates to clients, and update application statuses automatically.
Resume parsing and candidate enrichment
Upload resumes directly to Zoho Recruit’s parser and convert documents into structured candidate records.
Real-time syncing across systems
Keep Zoho Recruit in sync with CRMs, HRMS, or internal tools so recruiters and leadership always see the same data.
Strong access control and security
OAuth-based authentication, role-based access, rate limits, and scoped permissions protect sensitive candidate information.
Highly modular and extensible
Work with standard modules (Candidates, Job Openings, Interviews) or custom modules without changing your integration strategy.
Built for production use
Sandbox environments, versioned APIs, error handling, and logging make it safe to build, test, and scale integrations.

Zoho Recruit API Endpoints

Bulk Operations

POST https://recruit.zoho.com/recruit/bulk/v2/read
GET https://recruit.zoho.com/recruit/bulk/v2/read/{job_id}
GET https://recruit.zoho.com/recruit/bulk/v2/read/{job_id}/result
POST https://recruit.zoho.com/recruit/bulk/v2/write
GET https://recruit.zoho.com/recruit/bulk/v2/write/{job_id}

Assessments

POST https://recruit.zoho.com/recruit/v2.1/Assessments
PUT https://recruit.zoho.com/recruit/v2.1/Assessments/{record_id}

Applications

PUT https://recruit.zoho.com/recruit/v2/Applications/status
POST https://recruit.zoho.com/recruit/v2/Applications/{application_id}/Attachments

Candidates

PUT https://recruit.zoho.com/recruit/v2/Candidates/actions/associate
POST https://recruit.zoho.com/recruit/v2/Candidates/actions/import_document
POST https://recruit.zoho.com/recruit/v2/Candidates/{record_id}/actions/add_tags

Interviews

POST https://recruit.zoho.com/recruit/v2/Interviews
PUT https://recruit.zoho.com/recruit/v2/Interviews/{record_id}/action/cancel

Job Openings

POST https://recruit.zoho.com/recruit/v2/JobOpenings

Notes

PUT https://recruit.zoho.com/recruit/v2/Notes
DELETE https://recruit.zoho.com/recruit/v2/Notes/{note_id}

Reviews

POST https://recruit.zoho.com/recruit/v2/Reviews
PUT https://recruit.zoho.com/recruit/v2/Reviews/{record_id}

Submissions

POST https://recruit.zoho.com/recruit/v2/Submissions
PUT https://recruit.zoho.com/recruit/v2/Submissions/{record_id}/actions/status

Organization

GET https://recruit.zoho.com/recruit/v2/org

Settings & Metadata

GET https://recruit.zoho.com/recruit/v2/settings/modules
GET https://recruit.zoho.com/recruit/v2/settings/fields?module={module_api_name}
GET https://recruit.zoho.com/recruit/v2/settings/custom_views?module={module_api_name}
GET https://recruit.zoho.com/recruit/v2/settings/roles
GET https://recruit.zoho.com/recruit/v2/settings/profiles

Records (Generic)

POST https://recruit.zoho.com/recruit/v2/{module_api_name}
GET https://recruit.zoho.com/recruit/v2/{module_api_name}/search
PUT https://recruit.zoho.com/recruit/v2/{module_api_name}/{record_id}
DELETE https://recruit.zoho.com/recruit/v2/{module_api_name}?ids={record_id}

(India-specific .zoho.in endpoints remain unchanged and should be used for region-bound accounts.)

FAQs

1. What can I build using the Zoho Recruit API?
Anything from custom ATS dashboards and recruiter tools to HRIS integrations, analytics pipelines, and automated hiring workflows.

2. Does the API support bulk data migration?
Yes. Bulk Read and Bulk Write APIs are designed specifically for large-scale exports, imports, and migrations.

3. How is authentication handled?
All APIs use Zoho OAuth 2.0 with scoped access tokens. Permissions are enforced at both user and module levels.

4. Are there rate limits?
Yes. Rate limits vary by API, with stricter limits on bulk operations to prevent abuse.

5. Can I automate interview scheduling and status changes?
Yes. Interviews, applications, and submissions can all be updated programmatically.

6. Is there support for custom modules?
Yes. Custom modules are treated like first-class citizens and can be accessed via the same API patterns.

7. Can I test integrations safely?
Zoho provides sandbox environments so you can build and validate integrations without touching production data.

Get Started with Zoho Recruit API Integration

Integrating directly with the Zoho Recruit API gives you power, but also complexity around OAuth, retries, schema changes, and long-term maintenance.

If you want speed and reliability without building everything from scratch, Knit lets you integrate with Zoho Recruit once and handle authentication, versioning, error handling, and ongoing upkeep automatically. You focus on product logic. Knit keeps the pipes running.

Dec 30, 2025

Zoho People API Directory

Zoho People is a cloud-based HRMS that helps organizations run core HR operations, employee records, attendance, leave, onboarding, learning, and internal HR support, without turning HR into a manual ops team. But the real leverage shows up when Zoho People is connected to the rest of your stack (payroll, ITSM, finance, analytics, collaboration tools) so data doesn’t sit in silos and processes don’t depend on human follow-ups.

That’s exactly what the Zoho People API enables. You can sync employee data, automate repetitive workflows, orchestrate onboarding, and operationalize LMS + leave + attendance processes across systems. Done right, this becomes an integration layer that reduces cycle time, improves accuracy, and strengthens auditability.

Key highlights of Zoho People APIs

Employee data as a system-of-record
Pull structured employee details and identifiers (like erecno) to keep downstream apps aligned.
Workflow automation via triggers + webhooks
Automate key actions such as onboarding triggers, notifications, and cross-system updates.
LMS operations via API-first control
Manage courses, batches, modules, sessions, enrollments, and learning activity states programmatically.
Attendance + leave sync for payroll and workforce ops
Keep time and leave signals updated across payroll, analytics, and operational dashboards.
HR case management integration
Create and track HR requests with categories, status, SLA indicators, and assignment visibility.
Designed for predictable bulk sync patterns
Pagination and limits (like fetching 200 records at a time) encourage stable integration design.
OAuth-based access and scope-driven control
Token-based authentication supports controlled access and traceable integrations.
Enterprise extensibility across modules
Supports multi-module integration patterns without forcing a one-size-fits-all workflow.

Zoho People API Endpoints

Learning Management System (LMS)

Courses

GET http://people.zoho.com/api/v1/courses//batches//modules//sessions : The Fetch Module Sessions API is used to retrieve session details for specific modules within batches in a Learning Management System (LMS). The API requires the courseId, batchId, and moduleId as path parameters to specify the context of the sessions being fetched. An optional query parameter, startIndex, can be used to specify the starting point for fetching records, with a default value of 0. The API requires an Authorization header with a Zoho OAuth token. The response includes details about each session, such as session name, start and end times, description, and trainer information, along with metadata like the total number of learners and whether the session is completed. The response also indicates if there are more records to fetch.
POST http://people.zoho.com/api/v1/courses//batches//unenroll?erecnosList= : The Unenroll Learner From Batch API allows you to unenroll a learner from a specific batch in the LMS. It requires the course ID and batch ID as path parameters, and a list of employee erec numbers as a query parameter. The request must include an Authorization header with a valid Zoho OAuth token. The response includes a status code, a list of learners with their unenrollment status, and a success message.
DELETE http://people.zoho.com/api/v1/courses//settings/precourseactivities/onlineTests/ : This API is used to delete an online test from pre-learning activities in a specified course. The request requires the course ID and the test ID as path parameters, and an authorization header with a Zoho OAuth token. The API supports two scopes: ZOHOPEOPLE.training.ALL for complete access and ZOHOPEOPLE.training.DELETE for delete-only access. Upon successful deletion, the API returns a response with a code, the test ID, and a success message.
GET http://people.zoho.com/api/v1/courses/{Course ID}/batches/{Batch ID}/learners/{Learner ID}/lockedEntities/{Locked Entity ID} : The List Requisite Course Entities API is used to retrieve a list of course entities that must be completed to unlock the current course entity. It requires the course ID, batch ID, learner ID, and locked entity ID as path parameters. The batch ID should be '0' for self-paced learning. The request must include an Authorization header with a valid Zoho OAuth token. The response includes a list of locked entities with their names, IDs, and types, along with a response code and message.
POST https://people.zoho.com/api//triggerOnboarding : The Trigger Onboarding API is used to initiate the onboarding process for an existing candidate or employee in the Zoho People system. The API requires an OAuth token for authorization, which should be included in the request headers. The request body must contain the 'userId', which is the record ID of the candidate or employee for whom the onboarding is to be triggered. The API has a threshold limit of 30 requests per minute, with a lock period of 5 minutes before consecutive requests can be made. Upon successful execution, the API returns a response message indicating success.

Announcements

POST https://people.zoho.com/api/announcement/addAnnouncementComment : The Add Announcement Comment API allows users to add a comment to a specific announcement. The API requires an OAuth token for authorization, and the announcement ID and comment text as query parameters. The response includes the status and message of the operation, and if successful, details about the comment added. In case of an error, an error code and message are provided. The API has a threshold limit of 20 requests per minute, with a lock period of 5 minutes.
DELETE https://people.zoho.com/api/announcement/deleteAnnouncement : The Delete Announcements API allows users to delete a posted announcement by providing the announcement ID. The request requires an authorization token in the header and the announcement ID as a query parameter. The API has a threshold limit of 20 requests per minute and a lock period of 5 minutes. A successful response returns a status of 0 and a message of 'Success', while an error response returns a status of 1 and an error message.
DELETE https://people.zoho.com/api/announcement/deleteAnnouncementComment : The Delete Announcement Comment API allows users to delete a specific comment from an announcement. The API requires an OAuth token for authorization, provided in the request header. The commentId, which is the ID of the comment to be deleted, must be included as a query parameter. The API returns a success message with the ID of the deleted comment if the operation is successful. In case of an error, such as insufficient permissions, an error message is returned. The API has a threshold limit of 20 requests per minute, with a lock period of 5 minutes.
POST https://people.zoho.com/api/announcement/enableDisableAnnouncement : The Enable or Disable Announcements API allows users to enable or disable an announcement by providing the announcement ID. The API requires an OAuth token for authorization. If the announcement is currently enabled, providing the ID will disable it, and vice versa. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes. The response includes a status code and message indicating success or failure, with additional result data if applicable.

Attendance

GET https://people.zoho.com/api/attendance/fetchLatestAttEntries : The Fetch Last Attendance Entries API retrieves the latest attendance entries, including regularisation entries, that have been added or updated within a specified duration in minutes. This API is accessible only by admin and data admin users. The request requires an OAuth token for authorization and accepts query parameters for the duration and date-time format. The response includes details of single and multi regularisation entries, as well as attendance entries added through other means. The API has a threshold limit of 30 requests per minute and a lock period of 5 minutes.

Candidate

POST https://people.zoho.com/api/candidate/reopen : The Reopen Onboarding API is used to reopen the onboarding process for a candidate in the Zoho People system. The API requires an authorization header with a Zoho OAuth token. The request can include either the candidate's email or candidate ID in the body to identify the candidate whose onboarding needs to be reopened. The API has a threshold limit of 30 requests per minute, with a lock period of 5 minutes before consecutive requests can be made. A successful response returns a message indicating success, a response code of 7000, and the candidate ID. In case of failure, an error message and code 7033 are returned.

Files

POST https://people.zoho.com/api/files/addFolder : The Add and Edit Folder API allows users to add new folders or edit existing folders in the file modules of Zoho People. The API requires an OAuth token for authorization. Users can specify the new folder name using the 'newCatName' parameter. If the folder is to be placed under an existing folder, the 'parentCatId' parameter should be used. To rename an existing folder, the 'catId' parameter should be provided. The response includes the folder ID, parent folder ID, folder name, a message, the URI of the API endpoint, and a status code.

HR Cases

POST https://people.zoho.com/api/hrcases/addcase : The Add Case API is used to add new cases in the system. It requires an authentication token in the header and mandatory query parameters such as categoryId and subject. The description is optional. The API returns a success response with details of the created case, including the record ID and case ID, or an error response if the operation fails. The API has a threshold limit of 30 requests per minute with a lock period of 5 minutes.
GET https://people.zoho.com/api/hrcases/getRequestedCases : The View Case Listing API allows users to list various cases based on different criteria. Users can request cases that are assigned to them, unassigned cases, open cases, or all cases. The API requires an authorization header with a Zoho OAuth token. Query parameters include 'index' (mandatory), 'status', 'categoryId', 'query', 'requestorErecno', and 'periodOfTime'. The response includes a list of cases with details such as agent information, subject, SLA status, category, requestor details, and more. The API has a threshold limit of 30 requests per minute with a lock period of 5 minutes.
GET https://people.zoho.com/api/hrcases/listCategory : The View List of Categories API is used to retrieve a list of categories that a user can raise queries to. The request requires an Authorization header with a Zoho OAuth token. The response includes details about each category such as whether the user is an agent, the category icon, whether the category is enabled, a short description, service ID, applicable locations, category name, and category ID. The API has a threshold limit of 30 requests per minute and a lock period of 5 minutes.
GET https://people.zoho.com/api/hrcases/viewcase : The View Case Details API allows users to retrieve detailed information about a specific case using its record ID. The API requires an OAuth token for authentication and the record ID as a query parameter. The response includes details about the case such as the agent, requestor, status, category, and any attached files. It also provides information on whether the user can change the case category or status, and SLA details if applicable. The API has a threshold limit of 30 requests per minute with a lock period of 5 minutes.

Leave

POST https://people.zoho.com/api/leave/addBalance : The Add Leave Balance API is used to modify an employee's leave balance by adding or subtracting a specified count. The API requires an authorization header with a Zoho OAuth token and accepts query parameters including 'balanceData', a JSON string detailing the employee's leave balance data, and 'dateFormat', which specifies the date format. The response includes the number of leave balances successfully added, any errors encountered, and a status message. The API has a threshold limit of 30 requests per minute with a lock period of 5 minutes.

Time Tracker

GET https://people.zoho.com/api/timetracker/addJobSchedule : The Add Job Schedule API is used to add a new job schedule in Zoho People. It requires authorization via a Zoho OAuth token. The API accepts several query parameters including jobId, date, fromtime, totime, description, isPublish, assignedTo, isRepeat, repeatInterval, repeatType, repeatUntil, skipMaxLogHrsValidation. The jobId, date, fromtime, and totime are mandatory parameters. The API returns a response containing the jobScheduleId of the newly added schedule, a success message, the URI of the API endpoint, and a status code. Error codes and messages are provided for various failure scenarios.
DELETE https://people.zoho.com/api/timetracker/deleteJobSchedule : The Delete Job Schedule API is used to delete job schedules in Zoho People. It requires the jobScheduleId as a mandatory query parameter to specify which job schedule to delete. Optionally, the isDeleteRepeat and delRepeatType parameters can be used to delete repeat series of schedules. The API requires an Authorization header with a Zoho OAuth token. The response includes the ID of the deleted job schedule and a success message. Error responses include error codes and messages. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
POST https://people.zoho.com/api/timetracker/editJobSchedule : The Edit Job Schedule API allows users to modify existing job schedules in Zoho People. The API requires an OAuth token for authentication and accepts various query parameters to specify the details of the job schedule to be edited, such as jobScheduleId, jobId, date, fromtime, totime, description, and more. The API supports repeating schedules and allows for editing repeat series with options like isEditRepeat and editRepeatType. The response includes the edited jobScheduleId and a success message. Error codes are provided for handling issues such as permission denial and invalid parameters.
GET https://people.zoho.com/api/timetracker/getJobSchedule : The Get Job Schedule API is used to retrieve the list of job schedules for employees within a specified date range. The API requires an OAuth token for authorization and supports query parameters such as user, sIndex, limit, fromDate, toDate. The fromDate and toDate parameters are mandatory and must be in the yyyy-MM-dd format. The API returns a list of job schedules, including details such as employee ID, job name, schedule date, and more. The response also indicates if more data is available with the isNextAvailable flag. Error codes are provided for permission issues, missing parameters, and incorrect date formats.
GET https://people.zoho.com/api/timetracker/getPayPeriodDetails : The Fetch Pay Period Details API is used to retrieve details about pay periods for specified users or locations. The API requires an Authorization header with a Zoho OAuth token. It accepts optional query parameters such as userErecNo, locationName, locationId to filter the pay period details. If no parameters are provided, all pay period data will be fetched. The response includes details such as location list, start and end dates, pay period name and ID, freeze status, frequency. The API is accessible only to admins and has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
GET https://people.zoho.com/api/timetracker/getpayrollreport : The Payroll Report API provides payroll data for specified users within a given date range. It requires an authorization token and supports various query parameters such as userErecNo, fromDate, toDate, and others to filter the data. The API returns detailed payroll information including regular hours, overtime, paid leave, total amounts. It also handles errors with specific error codes and messages. The API has a threshold limit of 20 requests per minute with a lock period of 5 minutes.
GET https://people.zoho.com/api/timetracker/publishJobSchedule : The Publish Job Schedule API is used to publish job schedules for specified users within a given date range. The API requires an authorization header with a Zoho OAuth token. The query parameters include 'user' to specify the user (ERECNO, Email-ID, Employee-ID, or 'all'), 'fromDate' to specify the start date, and 'toDate' to specify the end date for publishing job schedules. The API returns a success message if the job schedules are published successfully, or an error message with an error code if there is an issue. The API has a threshold limit of 20 requests per minute and a lock period of 5 minutes.

Common pitfalls (what usually breaks integrations)

Ignoring rate limits and lock periods: You’ll get throttled or locked; design retries with backoff and respect module-specific thresholds.
Not handling pagination properly: Many endpoints assume batch reads; implement startIndex/limit patterns consistently.
Over-scoping OAuth permissions: Too-broad scopes increase security exposure; use least privilege.
Weak identifier strategy: Standardize on stable identifiers (like erecno/record IDs) and map them cleanly across systems.
No error logging discipline: Without structured logging, you’ll lose time diagnosing “random failures” that are actually predictable.
Assuming admin-only APIs work for every token: Some endpoints are explicitly admin/data admin only, plan role access early.

FAQs

What’s the biggest practical use of the Zoho People API?
Automating HR workflows and syncing HR data across payroll, IT provisioning, LMS, and reporting, so processes don’t depend on manual updates.
How does authentication work for Zoho People APIs?
The endpoints use Zoho OAuth tokens in the Authorization header, with access governed by scopes.
What should I plan for when syncing large datasets?
Pagination and record caps (for example, fetching up to 200 records at a time) and module-specific rate limits.
Are all endpoints available to all users?
No. Some endpoints are restricted to admin/data admin users (for example, certain attendance APIs).
How do I avoid getting rate-limited?
Implement request throttling, exponential backoff retries, and respect threshold + lock-period behavior per endpoint.
What identifiers should I use to link users across systems?
Use stable platform identifiers like record IDs and erecno, and maintain a mapping layer in your integration.
Can Zoho People API be used for LMS automation end-to-end?
Yes, based on the endpoints listed, you can manage course creation, enrollments, sessions, attendance marking, publishing states, and related settings.

Get Started with Zoho People API Integration

For quick and seamless access to zoho-people API, Knit API offers a convenient solution. By integrating with Knit just once, you can streamline the entire process. Knit takes care of all the authentication, authorization, and ongoing integration maintenance, this approach not only saves time but also ensures a smooth and reliable connection to your zoho-people API.

Dec 29, 2025

Zenefits API Directory

Zenefits is a cloud-based HR platform purpose-built for small and mid-sized businesses that need to run HR operations with discipline, speed, and compliance baked in. It centralizes payroll, benefits administration, time tracking, onboarding, and compliance into a single system, eliminating fragmented tools and manual workarounds that don’t scale.

Where Zenefits truly becomes enterprise-ready is through its APIs. The Zenefits API exposes core HR, workforce, time, and platform data in a structured, secure manner, allowing teams to integrate HR directly into payroll engines, finance systems, IT provisioning workflows, analytics stacks, and third-party SaaS products. For teams building serious HR automation, the API is not optional; it’s foundational.

Key Highlights of Zenefits APIs

Authoritative HR Data Access
Retrieve canonical company, employee, department, and employment data directly from Zenefits as the system of record.
Employee Lifecycle Coverage
Programmatically track hires, role changes, compensation history, and terminations without relying on manual exports.
Payroll & Banking Integrations
Secure access to company and employee bank account data to support payroll runs, reimbursements, and financial controls.
Custom Field Extensibility
Capture and sync organization-specific attributes using custom fields at both company and individual levels.
Time & Attendance Visibility
Pull granular work-hour data, approval states, and exceptions to ensure payroll accuracy and compliance.
Leave & PTO Synchronization
Integrate vacation types and PTO requests into scheduling, payroll, and workforce planning systems.
Platform & App Lifecycle Control
Manage application installs, subscriptions, flows, and status changes for Zenefits marketplace integrations.
Secure, OAuth-Based Access Model
Token-based authentication with scoped permissions, logging, and audit-friendly access patterns.

Zenefits API Endpoints

Core

GET https://api.zenefits.com/core/companies
This API endpoint retrieves information about companies. It requires an authorization header with a bearer token. Optional query parameters include 'name' to filter by the common name of the company and 'includes' to specify additional information such as departments, locations, or company banks. The response includes detailed information about each company, including legal name, address, EIN, logo URL, and references to related entities such as departments and locations.
GET https://api.zenefits.com/core/companies/{:company_id}/company_banks
The Company Bank Accounts API retrieves information about a company's bank accounts. It requires a company ID as a path parameter and an authorization bearer token in the headers. The response includes details such as account number, account type (checking or savings), bank name, company reference, and routing number. The response is structured with meta information and may include a URL for the next set of results if pagination is applicable.
GET https://api.zenefits.com/core/companies/{:company_id}/locations
This API endpoint retrieves a list of locations for a specified company. The request requires an Authorization header with a Bearer token and a path parameter for the company_id. The response includes details about each location such as city, country, name, phone, state, street address, and zip code. It also provides references to the company and people associated with each location.
GET https://api.zenefits.com/core/companies/{:company_id}/people
This API endpoint retrieves information about all employees of a specified company. The request requires an authorization header with a bearer token and a path parameter for the company ID. Optional query parameters can be used to filter the results by fields such as first name, last name, and employment status. The response is paginated and includes a next_url for subsequent pages.
GET https://api.zenefits.com/core/companies/{:company_id}/people/{:id}
The Get Employee by ID API endpoint retrieves detailed information about a specific employee. It includes personal information, employment details, administrative roles, and related metadata.
GET https://api.zenefits.com/core/companies/{:id}/departments
Retrieves a list of departments for a specified company, including department names, IDs, and associated people.
GET https://api.zenefits.com/core/custom_fields
Retrieves company-level custom fields, supporting filtering by name and pagination.
GET https://api.zenefits.com/core/labor_group_types
Provides information about a company's labor group types and associated labor groups.
GET https://api.zenefits.com/core/labor_group_types/{:labor_group_type_id}/labor_groups
Retrieves labor groups associated with a specific labor group type, including assigned members.
GET https://api.zenefits.com/core/me
Returns information about the currently authorized user, including company context, OAuth scopes, and token status.
GET https://api.zenefits.com/core/people/{:person_id}/banks
Retrieves an employee’s bank account details, including paycheck distribution priority.
GET https://api.zenefits.com/core/people/{:person_id}/employments
Retrieves historical employment records, including salary, compensation type, hire date, and termination details.
GET https://api.zenefits.com/core/person/{:person_id}/custom_field_values
Retrieves custom field values for a specific employee with pagination support.

Platform

Time & Attendance

GET https://api.zenefits.com/time_attendance/time_durations
Retrieves detailed time and attendance records including hours worked, activity type, approval status, and exceptions.

Time Off

GET https://api.zenefits.com/time_off/vacation_requests
Retrieves PTO vacation requests with filtering by status, dates, creator, and employee.
GET https://api.zenefits.com/time_off/vacation_types
Retrieves company PTO types and their associated configurations.

FAQs

Is Zenefits a system of record for HR data?
Yes. Zenefits is typically treated as the authoritative source for employee, employment, and benefits data.
Does the API support pagination?
Yes. Many endpoints are paginated and return a next_url, this must be handled explicitly.
How is authentication handled?
All APIs require OAuth-based bearer token authentication with scoped permissions.
Can custom fields be accessed via the API?
Yes. Both custom field definitions and employee-level values are available.
Is real-time syncing supported?
Near real-time workflows are possible using platform flows and subscription events, but polling or scheduled syncs are still common.
Can Zenefits be embedded into third-party products?
Yes. The Platform APIs are designed specifically for marketplace apps and embedded HR workflows.
Is the API suitable for payroll and finance integrations?
Yes, but teams should be explicit about data ownership and reconciliation between Zenefits and downstream systems.

Get Started with Zenefits API Integration

If you want fast, reliable access to Zenefits without managing OAuth flows, token refreshes, pagination, and schema changes yourself, Knit API offers a pragmatic alternative. Integrate once with Knit, and it handles authentication, authorization, normalization, and long-term maintenance, so your team can focus on building workflows, not decoding integrations.

Dec 29, 2025

WorQ API Directory

WorQ is a cutting-edge platform engineered to optimize efficiency and ensure compliance in workforce and asset management. As a lightweight business rules engine, WorQ is specifically tailored to meet the demands of compliance, regulation, and audit-intensive processes. It offers a comprehensive suite of functionalities, including workforce management, asset management, and fleet management, making it an indispensable tool for organizations operating in sectors that require strict adherence to regulatory standards.

Designed to serve domains such as public works, community development, and local government operations, WorQ software is ideal for industries that demand robust compliance and regulation frameworks. Additionally, it provides efficient solutions for workforce and asset management, ensuring that organizations can streamline their operations while maintaining high standards of compliance. The WorQ API plays a crucial role in this ecosystem, facilitating seamless integration with existing systems and enabling organizations to leverage its powerful features to enhance operational efficiency.

Key Highlights of WorQ APIs

Compliance-Grade Workforce Data Access
Retrieve employee and attendance data designed for auditability, traceability, and regulatory reporting, not just HR convenience.
Rule-Driven Automation
Supports automation workflows aligned with business rules engines, ideal for regulated processes and exception-heavy operations.
Change-Based Data Retrieval
Fetches newly created and updated employee records within defined time windows, reducing redundant data pulls.
Operational Attendance Intelligence
Delivers detailed attendance attributes such as shift names, loss-of-pay flags, approvals, and total working hours.
Secure, Token-Based Access
Enforces authenticated access with customer codes and scoped tokens, aligning with enterprise security expectations.
Integration-Ready Architecture
Designed to plug into downstream systems like payroll, compliance dashboards, and reporting tools without transformation overhead.
Built for Public-Sector Scale
Handles workforce and attendance volumes typical of municipal and government-backed operations.

WorQ API Endpoints

Employee Data

POST
https://employee-mss.heptagon.tech/api/v1/get-employee-data
This API fetches employee data from the WorQ Application, including newly created employees and existing employees with changes in their tier profile information. The API requires an authentication token, customer code, start date, and end date as mandatory fields in the request body. The response includes a status indicating success or failure, the total count of employees, and detailed employee data such as name, contact information, work location, and employment details. In case of an error, an appropriate message is returned.

Attendance Data

POST
https://employee-mss.heptagon.tech/api/v1/get-attendance-data
The Get Employee Attendance Data API allows clients to retrieve attendance data for a specific employee over a specified date range. The request requires a valid access token, employee ID, start date, and end date. The response includes detailed attendance records for each day within the specified range, including attendance status, shift name, loss of pay status, approval status, day type, and total working hours. The API returns a success status with employee data or an error message if the request fails.

FAQs

1. Who should use the WorQ API?

Organizations operating in compliance-intensive environments such as public sector bodies, utilities, infrastructure services, and regulated workforce operations.

2. Does the API support incremental data sync?

Yes. Employee data can be fetched based on creation or update windows using start and end dates.

3. What kind of attendance details are available?

Shift name, attendance status, approval state, loss-of-pay indicators, day type, and total working hours.

4. Is the WorQ API suitable for payroll integration?

Yes. Attendance and employee datasets are structured to support downstream payroll and compliance calculations.

5. How secure is access to the WorQ API?

Access is token-based and requires customer identification, aligning with enterprise and public-sector security norms.

6. Can the API handle large workforce volumes?

Yes. The API is designed for government and large operational environments where scale is non-negotiable.

7. Why use Knit instead of direct integration?

Knit abstracts authentication, versioning, and maintenance, reducing long-term integration risk and engineering effort.

Get Started with WorQ API Integration

If you want speed, reliability, and minimal engineering drag, don’t over-engineer the integration. Knit API offers a pragmatic shortcut.

Integrate once with Knit, and it handles authentication, authorization, token refresh, and long-term API maintenance for WorQ. This reduces operational overhead, limits breakage from upstream changes, and keeps your teams focused on actual business outcomes instead of plumbing.

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Dec 8, 2025

Full list of Knit's Accounting API Guides

About this directory

At Knit, we regularly publish guides and tutorials to make it easier for developers to build their API integrations. However, we realize finding the information spread across our growing resource section can be a challenge.

To make it simpler, we collect and organise all the guides in lists specific to a particular category. This list is about all the Accounting API guides we have published so far to make Accounting Integration simpler for developers.

It is divided into two sections - In-depth integration guides for various Accounting platforms and Accounting API directories. While in-depth guides cover the more complex APPs in detail, including authentication, use cases, and more, the API directories give you a quick overview of the common API end points for each APP, which you can use as a reference to build your integrations.

We hope the developer community will find these resources useful in building out API integrations. If you think that we should add some more guides or you think some information is missing/ outdated, please let us know by dropping a line to hello@getknit.dev. We’ll be quick to update it - for the benefit of the community!

In-Depth Accounting API Integration Guides

Accounting API Directories

About Knit

Knit is a Unified API platform that helps SaaS companies and AI agents offer out-of-the-box integrations to their customers. Instead of building and maintaining dozens of one-off integrations, developers integrate once with Knit’s Unified API and instantly unlock connectivity with 100+ tools across categories like CRM, HRIS & Payroll, ATS, Accounting, E-Sign, and more.

Whether you’re building a SaaS product or powering actions through an AI agent, Knit handles the complexity of third-party APIs—authentication, data normalization, rate limits, and schema differences—so you can focus on delivering a seamless experience to your users.

Build once. Integrate everywhere.

All our Directories

Accounting Integration is just one category we cover. Here's our full list of our directories across different APP categories:

Dec 8, 2025

Full list of Knit's ATS API Guides

About this directory

To make it simpler, we collect and organise all the guides in lists specific to a particular category. This list is about all the ATS API guides we have published so far to make ATS Integration simpler for developers.

It is divided into two sections - In-depth integration guides for various ATS platforms and ATS API directories. While in-depth guides cover the more complex APPs in detail, including authentication, use cases, and more, the API directories give you a quick overview of the common API end points for each APP, which you can use as a reference to build your integrations.

In-Depth ATS API Integration Guides

Greenhouse API Integration In-Depth

ATS API Directories

About Knit

Build once. Integrate everywhere.

All our Directories

ATS Integration is just one category we cover. Here's our full list of our directories across different APP categories:

Dec 8, 2025

Full list of Knit's CRM API Guides

About this directory

To make it simpler, we collect and organise all the guides in lists specific to a particular category. This list is about all the CRM API guides we have published so far to make CRM Integration simpler for developers.

It is divided into two sections - In-depth integration guides for various CRM platforms and CRM API directories. While in-depth guides cover the more complex APPs in detail, including authentication, use cases, and more, the API directories give you a quick overview of the common API end points for each APP, which you can use as a reference to build your integrations.

In-Depth CRM API Integration Guides

Salesforce API Integration In-Depth

CRM API Directories

About Knit

Build once. Integrate everywhere.

All our Directories

CRM Integration is just one category we cover. Here's our full list of our directories across different APP categories:

Nov 12, 2025

Salesforce API Directory

This guide is part of our growing collection on CRM integrations. We’re continuously exploring new apps and updating our CRM Guides Directory with fresh insights.

Salesforce is a leading cloud-based platform that revolutionizes how businesses manage relationships with their customers. It offers a suite of tools for customer relationship management (CRM), enabling companies to streamline sales, marketing, customer service, and analytics.

With its robust scalability and customizable solutions, Salesforce empowers organizations of all sizes to enhance customer interactions, improve productivity, and drive growth.

Salesforce also provides APIs to enable seamless integration with its platform, allowing developers to access and manage data, automate processes, and extend functionality. These APIs, including REST, SOAP, Bulk, and Streaming APIs, support various use cases such as data synchronization, real-time updates, and custom application development, making Salesforce highly adaptable to diverse business needs.

For an in-depth guide on Salesforce Integration, visit our Salesforce API Integration Guide for developers

Key highlights of Salesforce APIs are as follows:

Versatile Options: Supports REST, SOAP, Bulk, and Streaming APIs for various use cases.
Scalability: Handles large data volumes with the Bulk API.
Real-time Updates: Enables event-driven workflows with the Streaming API.
Ease of Integration: Simplifies integration with external systems using REST and SOAP APIs.
Custom Development: Offers Apex APIs for tailored solutions.
Secure Access: Ensures data protection with OAuth 2.0.

‍

This article will provide an overview of the SalesForce API endpoints. These endpoints enable businesses to build custom solutions, automate workflows, and streamline customer operations. For an in-depth guide on building Salesforce API integrations, visit our Salesforce Integration Guide (In-Depth)

‍

‍SalesForce API Endpoints‍

Here are the most commonly used API endpoints in the latest REST API version (Version 62.0) -

Authentication

/services/oauth2/token

Data Access

/services/data/v62.0/sobjects/
/services/data/v62.0/query/
/services/data/v62.0/queryAll/

Search

/services/data/v62.0/search/
/services/data/v62.0/parameterizedSearch/

Chatter

/services/data/v62.0/chatter/feeds/
/services/data/v62.0/chatter/users/
/services/data/v62.0/chatter/groups/

Metadata and Tooling

/services/data/v62.0/tooling/
/services/data/v62.0/metadata/

Analytics

/services/data/v62.0/analytics/reports/
/services/data/v62.0/analytics/dashboards/

Composite Resources

/services/data/v62.0/composite/
/services/data/v62.0/composite/batch/
/services/data/v62.0/composite/tree/

Event Monitoring

/services/data/v62.0/event/

Bulk API 2.0

/services/data/v62.0/jobs/ingest/
/services/data/v62.0/jobs/query/

Apex REST

/services/apexrest/<custom_endpoint>

User and Profile Information

/services/data/v62.0/sobjects/User/
/services/data/v62.0/sobjects/Group/
/services/data/v62.0/sobjects/PermissionSet/
/services/data/v62.0/userInfo/
/services/data/v62.0/sobjects/Profile/

Platform Events

/services/data/v62.0/sobjects/<event_name>/
/services/data/v62.0/sobjects/<event_name>/events/

Custom Metadata and Settings

/services/data/v62.0/sobjects/CustomMetadata/
/services/data/v62.0/sobjects/CustomObject/

External Services

/services/data/v62.0/externalDataSources/
/services/data/v62.0/externalObjects/

Process and Approvals

/services/data/v62.0/sobjects/ProcessInstance/
/services/data/v62.0/sobjects/ProcessInstanceWorkitem/
/services/data/v62.0/sobjects/ApprovalProcess/

Files and Attachments

/services/data/v62.0/sobjects/ContentVersion/
/services/data/v62.0/sobjects/ContentDocument/

Custom Queries

/services/data/v62.0/query/?q=<SOQL_query>
/services/data/v62.0/queryAll/?q=<SOQL_query>

Batch and Composite APIs

/services/data/v62.0/composite/batch/
/services/data/v62.0/composite/tree/
/services/data/v62.0/composite/sobjects/

Analytics (Reports and Dashboards)

/services/data/v62.0/analytics/reports/
/services/data/v62.0/analytics/dashboards/
/services/data/v62.0/analytics/metrics/

Chatter (More Resources)

/services/data/v62.0/chatter/topics/
/services/data/v62.0/chatter/feeds/

Account and Contact Management

/services/data/v62.0/sobjects/Account/
/services/data/v62.0/sobjects/Contact/
/services/data/v62.0/sobjects/Lead/
/services/data/v62.0/sobjects/Opportunity/

Activity and Event Management

/services/data/v62.0/sobjects/Event/
/services/data/v62.0/sobjects/Task/
/services/data/v62.0/sobjects/CalendarEvent/

Knowledge Management

/services/data/v62.0/sobjects/KnowledgeArticle/
/services/data/v62.0/sobjects/KnowledgeArticleVersion/
/services/data/v62.0/sobjects/KnowledgeArticleType/

Custom Fields and Layouts

/services/data/v62.0/sobjects/<object_name>/describe/
/services/data/v62.0/sobjects/<object_name>/compactLayouts/
/services/data/v62.0/sobjects/<object_name>/recordTypes/

Notifications

/services/data/v62.0/notifications/
/services/data/v62.0/notifications/v2/

Task and Assignment Management

/services/data/v62.0/sobjects/Task/
/services/data/v62.0/sobjects/Assignment/

Platform and Custom Objects

/services/data/v62.0/sobjects/<custom_object_name>/
/services/data/v62.0/sobjects/<custom_object_name>/fields/

Data Synchronization and External Services

/services/data/v62.0/sobjects/ExternalDataSource/
/services/data/v62.0/sobjects/ExternalObject/

AppExchange Resources

/services/data/v62.0/appexchange/
/services/data/v62.0/appexchange/packages/

Querying and Records

/services/data/v62.0/sobjects/RecordType/
/services/data/v62.0/sobjects/<object_name>/getUpdated/
/services/data/v62.0/sobjects/<object_name>/getDeleted/

Security and Access Control

/services/data/v62.0/sobjects/PermissionSetAssignment/
/services/data/v62.0/sobjects/SharingRules/

Reports and Dashboards

/services/data/v62.0/analytics/reports/
/services/data/v62.0/analytics/dashboards/
/services/data/v62.0/analytics/metricValues/

Data Import and Bulk Operations

/services/data/v62.0/jobs/ingest/
/services/data/v62.0/jobs/query/
/services/data/v62.0/jobs/queryResults/

Content Management

/services/data/v62.0/sobjects/ContentDocument/
/services/data/v62.0/sobjects/ContentVersion/
/services/data/v62.0/sobjects/ContentNote/

Platform Events

/services/data/v62.0/sobjects/PlatformEvent/
/services/data/v62.0/sobjects/PlatformEventNotification/

Task Management

/services/data/v62.0/sobjects/Task/
/services/data/v62.0/sobjects/Event/

Contract

/services/data/v62.0/sobjects/Case/
/services/data/v62.0/sobjects/Contract/
/services/data/v62.0/sobjects/Quote/

Here’s a detailed reference to all the SalesForce API Endpoints.

SalesForce API FAQs‍

Here are the frequently asked questions about SalesForce APIs to help you get started:

‍

What are SalesForce API limits? Answer
What is the batch limit for Salesforce API? Answer
How many batches can run at a time in Salesforce? Answer
How do I see bulk API usage in Salesforce? Answer
Is Salesforce API limit inbound or outbound? Answer
How many types of API are there in Salesforce? Answer

‍

Find more FAQs here.

Get started with SalesForce API

To access Salesforce APIs, you need to create a Salesforce Developer account, generate an OAuth token, and obtain the necessary API credentials (Client ID and Client Secret) via the Salesforce Developer Console. However, if you want to integrate with multiple CRM APIs quickly, you can get started with Knit, one API for all top HR integrations.

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Nov 12, 2025

Overcoming the Hurdles: Common Challenges in AI Agent Integration (& Solutions)

Integrating AI agents into your enterprise applications unlocks immense potential for automation, efficiency, and intelligence. As we've discussed, connecting agents to knowledge sources (via RAG) and enabling them to perform actions (via Tool Calling) are key. However, the path to seamless integration is often paved with significant technical and operational challenges.

Ignoring these hurdles can lead to underperforming agents, unreliable workflows, security risks, and wasted development effort. Proactively understanding and addressing these common challenges is critical for successful AI agent deployment.

This post dives into the most frequent obstacles encountered during AI agent integration and explores potential strategies and solutions to overcome them.

Return to our main guide: The Ultimate Guide to Integrating AI Agents in Your Enterprise

1. Challenge: Data Compatibility and Quality

AI agents thrive on data, but accessing clean, consistent, and relevant data is often a major roadblock.

The Problem: Enterprise data is frequently fragmented across numerous siloed systems (CRMs, ERPs, databases, legacy applications, collaboration tools). This data often exists in incompatible formats, uses inconsistent terminologies, and suffers from quality issues like duplicates, missing fields, inaccuracies, or staleness. Feeding agents incomplete or poor-quality data directly undermines their ability to understand context, make accurate decisions, and generate reliable responses.
The Impact: Inaccurate insights, flawed decision-making by the agent, poor user experiences, erosion of trust in the AI system.
Potential Solutions:
- Data Governance & Strategy: Implement robust data governance policies focusing on data quality standards, master data management, and clear data ownership.
- Data Integration Platforms/Middleware: Use tools (like iPaaS or ETL platforms) to centralize, clean, transform, and standardize data from disparate sources before it reaches the agent or its knowledge base.
- Data Validation & Cleansing: Implement automated checks and cleansing routines within data pipelines.
- Careful Source Selection (for RAG): Prioritize connecting agents to curated, authoritative data sources rather than attempting to ingest everything.

2. Challenge: Complexity of Integration

Connecting diverse systems, each with its own architecture, protocols, and quirks, is inherently complex.

The Problem: Enterprises rely on a mix of modern cloud applications, legacy on-premise systems, and third-party SaaS tools. Integrating an AI agent often requires dealing with various API protocols (REST, SOAP, GraphQL), different authentication mechanisms (OAuth, API Keys, SAML), diverse data formats (JSON, XML, CSV), and varying levels of documentation or support. Achieving real-time or near-real-time data synchronization adds another layer of complexity. Building and maintaining these point-to-point integrations requires significant, specialized engineering effort.
The Impact: Long development cycles, high integration costs, brittle connections prone to breaking, difficulty adapting to changes in connected systems.
Potential Solutions:
- Unified API Platforms: Leverage platforms (like Knit, mentioned in the source) that offer pre-built connectors and a single, standardized API interface to interact with multiple backend applications, abstracting away much of the underlying complexity.
- Integration Platform as a Service (iPaaS): Use middleware platforms designed to facilitate communication and data flow between different applications.
- Standardized Internal APIs: Develop consistent internal API standards and gateways to simplify connections to internal systems.
- Modular Design: Build integrations as modular components that can be reused and updated independently.

3. Challenge: Scalability Issues

AI agents, especially those interacting with real-time data or serving many users, must be able to scale effectively.

The Problem: Handling high volumes of data ingestion for RAG, processing numerous concurrent user requests, and making frequent API calls for tool execution puts significant load on both the agent's infrastructure and the connected systems. Third-party APIs often have strict rate limits that can throttle performance or cause failures if exceeded. External service outages can bring agent functionalities to a halt if not handled gracefully.
The Impact: Poor agent performance (latency), failed tasks, incomplete data synchronization, potential system overloads, unreliable user experience.
Potential Solutions:
- Scalable Cloud Infrastructure: Host agent applications on cloud platforms that allow for auto-scaling of resources based on demand.
- Asynchronous Processing: Use message queues and asynchronous calls for tasks that don't require immediate responses (e.g., background data sync, non-critical actions).
- Rate Limit Management: Implement logic to respect API rate limits (e.g., throttling, exponential backoff).
- Caching: Cache responses from frequently accessed, relatively static data sources or tools.
- Circuit Breakers & Fallbacks: Implement patterns to temporarily halt calls to failing services and define fallback behaviors (e.g., using cached data, notifying the user).

4. Challenge: Building AI Actions for Automation

Enabling agents to reliably perform actions via Tool Calling requires careful design and ongoing maintenance.

The Problem: Integrating each tool involves researching the target application's API, understanding its authentication methods (which can vary widely), handling its specific data structures and error codes, and writing wrapper code. Building robust tools requires significant upfront effort. Furthermore, third-party APIs evolve – endpoints get deprecated, authentication methods change, new features are added – requiring continuous monitoring and maintenance to prevent breakage.
The Impact: High development and maintenance overhead for each new action/tool, integrations breaking silently when APIs change, security vulnerabilities if authentication isn't handled correctly.
Potential Solutions:
- Unified API Platforms: Again, these platforms can significantly reduce the effort by providing pre-built, maintained connectors for common actions across various apps.
- Framework Tooling: Leverage the tool/plugin/skill abstractions provided by frameworks like LangChain or Semantic Kernel to standardize tool creation.
- API Monitoring & Contract Testing: Implement monitoring to detect API changes or failures quickly. Use contract testing to verify that APIs still behave as expected.
- Clear Documentation & Standards: Maintain clear internal documentation for custom-built tools and wrappers.

5. Challenge: Monitoring and Observability Gaps

Understanding what an AI agent is doing, why it's doing it, and whether it's succeeding can be difficult without proper monitoring.

The Problem: Agent workflows often involve multiple steps: LLM calls for reasoning, RAG retrievals, tool calls to external APIs. Failures can occur at any stage. Without unified monitoring and logging across all these components, diagnosing issues becomes incredibly difficult. Tracing a single user request through the entire chain of events can be challenging, leading to "silent failures" where problems go undetected until they cause major issues.
The Impact: Difficulty debugging errors, inability to optimize performance, lack of visibility into agent behavior, delayed detection of critical failures.
Potential Solutions:
- Unified Observability Platforms: Use tools designed for monitoring complex distributed systems (e.g., Datadog, Dynatrace, New Relic) and integrate logs/traces from all components.
- Specialized LLM/Agent Monitoring: Leverage platforms like LangSmith (mentioned in the source alongside LangChain) specifically designed for tracing, debugging, and evaluating LLM applications and agent interactions.
- Structured Logging: Implement consistent, structured logging across all parts of the agent and integration points, including unique trace IDs to follow requests.
- Health Checks & Alerting: Set up automated health checks for critical components and alerts for key failure conditions.

6. Challenge: Versioning and Compatibility Drift

Both the AI models and the external APIs they interact with are constantly evolving.

The Problem: A new version of an LLM might interpret prompts differently or have changed function calling behavior. A third-party application might update its API, deprecating endpoints the agent relies on or changing data formats. This "drift" can break previously functional integrations if not managed proactively.
The Impact: Broken agent functionality, unexpected behavior changes, need for urgent fixes and rework.
Potential Solutions:
- Version Pinning: Explicitly pin dependencies to specific versions of libraries, models (where possible), and potentially API versions.
- Change Monitoring & Testing: Actively monitor for announcements about API changes from third-party vendors. Implement automated testing (including integration tests) that run regularly to catch compatibility issues early.
- Staged Rollouts: Test new model versions or integration updates in a staging environment before deploying to production.
- Adapter/Wrapper Patterns: Design integrations using adapter patterns to isolate dependencies on specific API versions, making updates easier to manage.

Conclusion: Plan for Challenges, Build for Success

Integrating AI agents offers tremendous advantages, but it's crucial to approach it with a clear understanding of the potential challenges. Data issues, integration complexity, scalability demands, the effort of building actions, observability gaps, and compatibility drift are common hurdles. By anticipating these obstacles and incorporating solutions like strong data governance, leveraging unified API platforms or integration frameworks, implementing robust monitoring, and maintaining rigorous testing and version control practices, you can significantly increase your chances of building reliable, scalable, and truly effective AI agent solutions. Forewarned is forearmed in the journey towards successful AI agent integration.

Consider solutions that simplify integration: Explore Knit's AI Toolkit

Nov 12, 2025

Full list of Knit's Payroll API Guides

About this directory

To make it simpler, we collect and organise all the guides in lists specific to a particular category. This list is about all the Payroll API guides we have published so far to make Payroll Integration simpler for developers.

It is divided into two sections - In-depth integration guides for various Payroll platforms and Payroll API directories. While in-depth guides cover the more complex APPs in detail, including authentication, use cases, and more, the API directories give you a quick overview of the common API end points for each APP, which you can use as a reference to build your integrations.

In-Depth Payroll API Integration Guides

ADP API Integration In-Depth

Payroll API Directories

About Knit

Build once. Integrate everywhere.

All our Directories

Payroll Integration is just one category we cover. Here's our full list of our directories across different APP categories:

MS Dynamics API Directory

Microsoft Dynamics CRM is a comprehensive customer relationship management solution that helps businesses manage sales, customer service, and marketing activities. Part of the Microsoft Dynamics 365 suite, it offers tools for automating workflows, tracking customer interactions, and gaining actionable insights to drive growth.

Microsoft Dynamics CRM APIs provide developers with powerful tools to integrate and extend CRM functionalities. These APIs support operations like managing accounts, contacts, leads, and opportunities, as well as customizing workflows and accessing analytics. With RESTful endpoints, secure authentication via OAuth 2.0, and robust documentation, they enable seamless integration with other applications and services.

Key Highlights of Microsoft Dynamics CRM APIs are as follows:

Comprehensive Access: Manage entities like accounts, contacts, leads, and opportunities.
RESTful Design: Easy-to-use APIs with standardized HTTP methods.
Secure Authentication: Supports OAuth 2.0 for secure access.
Customizable Workflows: Enable custom processes and automations.
Integration Flexibility: Seamlessly connect with other Microsoft services and third-party applications.
Advanced Querying: Utilize OData queries for filtering, sorting, and retrieving data.
Real-Time Operations: Access and update CRM data instantly.
Rich Documentation: Comprehensive guides and resources for developers.
Scalable: Suitable for small-scale and enterprise-level applications.
Insights and Analytics: Retrieve reports and business intelligence for data-driven decisions.

This article gives an overview of the most commonly used Microsoft Dynamics CRM API endpoints.

Microsoft Dynamics CRM API Endpoints

General Entity Management

GET /api/data/v9.0/accounts
POST /api/data/v9.0/accounts
PATCH /api/data/v9.0/accounts({account_id})
DELETE /api/data/v9.0/accounts({account_id})
GET /api/data/v9.0/contacts
POST /api/data/v9.0/contacts
PATCH /api/data/v9.0/contacts({contact_id})
DELETE /api/data/v9.0/contacts({contact_id})
GET /api/data/v9.0/leads
POST /api/data/v9.0/leads
PATCH /api/data/v9.0/leads({lead_id})
DELETE /api/data/v9.0/leads({lead_id})
GET /api/data/v9.0/opportunities
POST /api/data/v9.0/opportunities
PATCH /api/data/v9.0/opportunities({opportunity_id})
DELETE /api/data/v9.0/opportunities({opportunity_id})
GET /api/data/v9.0/tasks
POST /api/data/v9.0/tasks
PATCH /api/data/v9.0/tasks({task_id})
DELETE /api/data/v9.0/tasks({task_id})

Activities

GET /api/data/v9.0/activities
POST /api/data/v9.0/activities
PATCH /api/data/v9.0/activities({activity_id})
DELETE /api/data/v9.0/activities({activity_id})

System Users

GET /api/data/v9.0/systemusers
GET /api/data/v9.0/systemusers({user_id})

Metadata and Custom Entities

GET /api/data/v9.0/EntityDefinitions
GET /api/data/v9.0/EntityDefinitions({entity_name})
GET /api/data/v9.0/{custom_entity_name}
POST /api/data/v9.0/{custom_entity_name}
PATCH /api/data/v9.0/{custom_entity_name}({record_id})
DELETE /api/data/v9.0/{custom_entity_name}({record_id})

‍

Metadata Management

GET /api/data/v9.0/GlobalOptionSetDefinitions
GET /api/data/v9.0/GlobalOptionSetDefinitions({optionset_id})
GET /api/data/v9.0/AttributeMetadata
GET /api/data/v9.0/EntityDefinitions({entity_name})/Attributes

Solutions and Customization

GET /api/data/v9.0/Solutions
GET /api/data/v9.0/Solutions({solution_id})
GET /api/data/v9.0/PublishAllXml

Workflow Management

GET /api/data/v9.0/workflows
GET /api/data/v9.0/workflows({workflow_id})
POST /api/data/v9.0/workflows({workflow_id})/Execute

Teams and Security Roles

GET /api/data/v9.0/teams
GET /api/data/v9.0/teams({team_id})
GET /api/data/v9.0/securityroles
GET /api/data/v9.0/securityroles({role_id})

Business Units

GET /api/data/v9.0/businessunits
GET /api/data/v9.0/businessunits({businessunit_id})

Audit Logs

GET /api/data/v9.0/audits
GET /api/data/v9.0/audits({audit_id})

Marketing Lists

GET /api/data/v9.0/lists
POST /api/data/v9.0/lists
PATCH /api/data/v9.0/lists({list_id})
DELETE /api/data/v9.0/lists({list_id})

Email and Communication

GET /api/data/v9.0/emails
POST /api/data/v9.0/emails
PATCH /api/data/v9.0/emails({email_id})
POST /api/data/v9.0/emails({email_id})/send

Cases and Service Management

GET /api/data/v9.0/incidents
POST /api/data/v9.0/incidents
PATCH /api/data/v9.0/incidents({incident_id})
DELETE /api/data/v9.0/incidents({incident_id})

Scheduling and Resources

GET /api/data/v9.0/resources
GET /api/data/v9.0/calendars
GET /api/data/v9.0/resourcegroups

Reports and Dashboards

GET /api/data/v9.0/reports
GET /api/data/v9.0/reports({report_id})
GET /api/data/v9.0/dashboards
GET /api/data/v9.0/dashboards({dashboard_id})

Additional Miscellaneous Endpoints

GET /api/data/v9.0/roles
GET /api/data/v9.0/queues
GET /api/data/v9.0/queueitems
POST /api/data/v9.0/merge
GET /api/data/v9.0/settings
GET /api/data/v9.0/WhoAmI
GET /api/data/v9.0/RetrieveDuplicates
GET /api/data/v9.0/ExecuteFunction
POST /api/data/v9.0/ExecuteAction

Here’s a detailed reference to all the MS Dynamics CRM API Endpoints.

MS Dynamics CRM API FAQs‍

Here are the frequently asked questions about MS Dynamics CRM APIs to help you get started:

How to retrieve more than 5000 records in Dynamics CRM using Web API? Answer
What is the attachment size limit for Dynamics CRM 365? Answer
What is the maximum number of users for Dynamics 365? Answer
What is the maximum length of multiple lines of text in CRM? Answer
What is the field limit in Dynamics 365? Answer‍

Find more FAQs here.

Get started with MS Dynamics CRM API‍

To access Microsoft Dynamics CRM APIs, register an application in Azure AD, configure API permissions, generate a client secret, authenticate using OAuth 2.0 to obtain an access token, and use the token to interact with the API endpoints.

However, if you want to integrate with multiple CRM APIs quickly along with MS Dynamics API, you can get started with Knit, one API for all top CRM integrations.

To sign up for free, click here. To check the pricing, see our pricing page.

Teamtailor API Directory

Teamtailor is a comprehensive recruitment software designed to streamline the hiring process, making it an indispensable tool for human resources and recruitment professionals. This all-in-one platform offers a suite of features that enhance the recruitment experience for both teams and candidates. By providing tools for job posting, candidate tracking, and communication, Teamtailor ensures a seamless and efficient hiring journey. Its user-friendly interface and robust functionalities make it a preferred choice for organizations looking to optimize their recruitment strategies.

The Teamtailor API provides developers with robust tools to integrate and automate various recruitment and talent acquisition processes within their applications. Below are the key highlights of the Teamtailor API:

Key Features of the Teamtailor API:

Data Management: The API provides endpoints to import, edit, and export information from your Teamtailor account, including jobs, candidates, departments, and locations. Teamtailor Support
Authentication: Access is secured via API keys, which can be generated in the Teamtailor account settings under "Integrations" > "API keys." There are three types of keys with varying permissions
- Public: Access to all public data available on the career site.
- Internal: Access to public and internal data, such as unlisted jobs.
- Admin: Full access to all account data.
Each key can have read, write, or read/write permissions.
Partner and Job Board Integrations: Teamtailor provides specialized APIs for partners and job boards: partner.teamtailor.com
- Partner API: Allows partners to retrieve webhooks with candidate data or update assessment results.
- Job Board API: Enables job boards to integrate with Teamtailor using HTTP webhooks or XML feeds.

Getting Started with the Teamtailor API:

Generate an API Key:
- Navigate to "Settings" > "Integrations" > "API keys" in your Teamtailor account.
- Click "+ New API Key" and select the appropriate permissions and scopes.
- Once created, the API key cannot be edited, only deleted.
Explore the API Documentation:
- Review the official Teamtailor API documentation to understand available endpoints and data structures. Teamtailor API
Implement API Calls:
- Use standard HTTP methods (GET, POST, PATCH, DELETE) to interact with the API.
- Include the API key in the Authorization header of your requests.
- Ensure your application handles responses and errors appropriately.

‍

Teamtailor API Endpoints

Activities

GET https://api.teamtailor.com/v1/activities/{id} : The 'Retrieve List of Activities' API allows users to fetch details of a specific activity by its ID.

Answers

POST https://api.teamtailor.com/v1/answers : This API endpoint allows the creation of a new answer for a candidate to a specific question.
GET https://api.teamtailor.com/v1/answers/{id} : This API endpoint is used to retrieve lists of audit events for a specific answer identified by its ID.

Audit Events

GET https://api.teamtailor.com/v1/audit-events : This API retrieves lists of audit events from the Teamtailor platform.
GET https://api.teamtailor.com/v1/audit-events/{id} : This API retrieves a specific audit event by its ID.

Candidates

POST https://api.teamtailor.com/v1/candidates : This API endpoint allows you to create a new candidate in the Teamtailor system.
GET https://api.teamtailor.com/v1/candidates/{candidate_id} : The List Candidates API allows users to retrieve a list of candidates from the Teamtailor platform.
PATCH https://api.teamtailor.com/v1/candidates/{id} : This API allows you to change the attributes or relationships of a candidate in the Teamtailor system.

Company

PATCH https://api.teamtailor.com/v1/company : This API endpoint allows you to update the details of a company associated with the current API key.

Custom Field Options

GET https://api.teamtailor.com/v1/custom-field-options : This API endpoint allows the creation of a new custom field option in the Teamtailor system.
PATCH https://api.teamtailor.com/v1/custom-field-options/{custom-field-option_id} : This API endpoint allows you to update a custom field option in the Teamtailor system.

Custom Field Selects

POST https://api.teamtailor.com/v1/custom-field-selects : This API endpoint allows you to create a new custom field select in the Teamtailor system.
PATCH https://api.teamtailor.com/v1/custom-field-selects/{id} : The 'Update Custom Field Selects' API allows you to update the details of a specific custom field select by its ID.

Custom Field Values

POST https://api.teamtailor.com/v1/custom-field-values : This API endpoint allows the creation of a new custom field value in the Teamtailor system.
PATCH https://api.teamtailor.com/v1/custom-field-values/{id} : The 'Update Custom Field Value' API allows you to update the value of a custom field for a specific resource in Teamtailor.

Custom Fields

GET https://api.teamtailor.com/v1/custom-fields : The List Custom Fields API allows you to retrieve a list of custom fields from the Teamtailor platform.
GET https://api.teamtailor.com/v1/custom-fields/{id} : This API retrieves a specific custom field by its ID.

Departments

GET https://api.teamtailor.com/v1/departments : The List Departments API retrieves a list of departments from the Teamtailor platform.
DELETE https://api.teamtailor.com/v1/departments/{id} : The Delete Department API allows you to delete a department by its ID.

Files

POST https://api.teamtailor.com/v1/files : This API uploads a file to temporary storage and returns a transient URI that can be used in place of a public URL in some endpoints.

Job Applications

POST https://api.teamtailor.com/v1/job-applications : This API endpoint allows the creation of a new job application in the Teamtailor system.
PATCH https://api.teamtailor.com/v1/job-applications/{id} : This API allows you to change a candidate's attributes and relationships for a specific job application.

Job Offers

GET https://api.teamtailor.com/v1/job-offers : This API endpoint retrieves lists of job offers from the Teamtailor platform.
GET https://api.teamtailor.com/v1/job-offers/{id} : The Show Job Offer API retrieves details of a specific job offer using its unique ID.

Jobs

GET https://api.teamtailor.com/v1/jobs : The 'Create a New Job' API allows users to create a new job listing on the Teamtailor platform.
GET https://api.teamtailor.com/v1/jobs/{id} : The 'Retrieve a Specific Job' API allows users to fetch detailed information about a specific job using its unique ID.

Locations

GET https://api.teamtailor.com/v1/locations : The List Locations API retrieves a list of locations from the Teamtailor platform.
PATCH https://api.teamtailor.com/v1/locations/{id} : This API endpoint allows updating a location's details in the Teamtailor system.

Notes

POST https://api.teamtailor.com/v1/notes : This API endpoint allows the creation of a new note for a candidate in the Teamtailor system.
GET https://api.teamtailor.com/v1/notes/{id} : This API endpoint retrieves a single note from the Teamtailor system.

Notification Settings

GET https://api.teamtailor.com/v1/notification-settings : The List Notification Settings API allows clients to retrieve a list of notification settings for a user.
GET https://api.teamtailor.com/v1/notification-settings/{id} : The Show Notification Setting API retrieves the notification settings for a specific user by ID.

NPS Responses

GET https://api.teamtailor.com/v1/nps-response/{id} : The Show NPS Response API retrieves the details of a specific NPS (Net Promoter Score) response using its unique identifier.
GET https://api.teamtailor.com/v1/nps-responses : The List NPS Responses API allows you to retrieve a list of Net Promoter Score (NPS) responses from the Teamtailor platform.

Partner Results

GET https://api.teamtailor.com/v1/partner-results : The List Partner Results API allows users to retrieve a list of partner results from the Teamtailor platform.
GET https://api.teamtailor.com/v1/partner-results/<partner result uuid> : This API retrieves lists of answers by fetching partner results using a unique partner result UUID.

Picked Questions

GET https://api.teamtailor.com/v1/picked-questions : The List Picked Questions API retrieves a list of picked questions from the Teamtailor platform.

Questions

GET https://api.teamtailor.com/v1/questions : This API endpoint retrieves a list of questions from the Teamtailor platform.

Referrals

GET https://api.teamtailor.com/v1/referrals : The List Referrals API allows users to retrieve a list of referrals from the Teamtailor platform.
GET https://api.teamtailor.com/v1/referrals/{id} : The Show Region API retrieves details of a specific referral by its ID.

Regions

POST https://api.teamtailor.com/v1/regions : This API endpoint allows the creation of a new region in the system.

Reject Reasons

POST https://api.teamtailor.com/v1/reject-reasons : The Create Reject Reason API allows users to create a new reject reason in the system.
DELETE https://api.teamtailor.com/v1/reject-reasons/{id} : The Delete Reject Reason API allows you to delete a specific reject reason by its ID.

Requisition Step Verdicts

GET https://api.teamtailor.com/v1/requisition-step-verdicts/{id} : The 'Show Requisition Step Verdicts' API retrieves the details of a specific requisition step verdict by its ID.

Requisitions

GET https://api.teamtailor.com/v1/requisitions : The List Requisitions API allows users to retrieve a list of job requisitions from the Teamtailor platform.
GET https://api.teamtailor.com/v1/requisitions/{id} : The Show Requisition Details API retrieves detailed information about a specific requisition identified by its unique ID.

Roles

GET https://api.teamtailor.com/v1/roles : The List Roles API allows users to retrieve a list of roles from the Teamtailor platform.
DELETE https://api.teamtailor.com/v1/roles/{id} : This API endpoint is used to delete a role in the system.

Stage Types

GET https://api.teamtailor.com/v1/stage-types : The List Stage Types API retrieves a list of stage types from the Teamtailor platform.
GET https://api.teamtailor.com/v1/stage-types/{id} : The 'Show Stage Type' API retrieves details of a specific stage type identified by its ID.

Stages

GET https://api.teamtailor.com/v1/stages : This API endpoint retrieves lists of stages from the Teamtailor platform.
GET https://api.teamtailor.com/v1/stages/{id} : The Get Stage Details API retrieves detailed information about a specific stage in the Teamtailor system.

Team Memberships

GET https://api.teamtailor.com/v1/team-memberships : The List Team Memberships API allows you to retrieve a list of team memberships from the Teamtailor platform.
GET https://api.teamtailor.com/v1/team-memberships/{id} : The Show Team Membership API retrieves details of a specific team membership by its ID.

Teams

GET https://api.teamtailor.com/v1/teams : The List Teams API allows you to retrieve a list of teams from the Teamtailor platform.
DELETE https://api.teamtailor.com/v1/teams/{id} : This API endpoint is used to delete a team from the system.

Todos

POST https://api.teamtailor.com/v1/todos : The Create Todo API allows users to create a new todo item in the system.
PATCH https://api.teamtailor.com/v1/todos/{id} : The Update Todo API allows you to update the details of a specific todo item by its ID.

Triggers

GET https://api.teamtailor.com/v1/triggers : This API endpoint retrieves lists of triggers from the Teamtailor platform.

Uploads

GET https://api.teamtailor.com/v1/uploads : This API endpoint retrieves lists of uploads from the Teamtailor platform.

Users

POST https://api.teamtailor.com/v1/users : This API endpoint allows the creation of a new user in the Teamtailor system.
DELETE https://api.teamtailor.com/v1/users/{id} : The Delete User API allows an admin to delete a user from the system.

Teamtailot API FAQ's

How can I access the Teamtailor API?

Answer: To access the Teamtailor API, you need to generate an API key within your Teamtailor account. Navigate to Settings > Integrations > API Keys and click on + New API Key. Choose the appropriate permissions and scopes for your key. Note that this action requires Company Admin access.

What authentication method does the Teamtailor API use?

Answer: The Teamtailor API uses token-based authentication. Include your secret API key in the Authorization header of your HTTP requests, formatted as Authorization: Token abc123abc123, replacing abc123abc123 with your actual API key.

Are there rate limits for the Teamtailor API?

Answer: The official documentation does not specify explicit rate limits for the Teamtailor API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.

Can I retrieve job listings using the Teamtailor API?

Answer: Yes, the Teamtailor API provides endpoints to retrieve job listings. For example, you can use the /jobs endpoint to fetch a list of all jobs, including their details such as titles, descriptions, and application links.

Does the Teamtailor API support webhooks for real-time data updates?

Answer: Yes, Teamtailor supports webhooks, allowing you to receive real-time notifications for specific events, such as candidate data updates or assessment results. You can configure webhook subscriptions to specify which events you want to receive notifications for.

Leverage Knit for Teamtailor API Integration

For quick and seamless access to Teamtailor API, Knit API offers a convenient Unified API solution. By integrating with Knit just once, you can go live with multiple ATS integrations in one go. Knit takes care of all the authentication, authorization, and ongoing integration maintenance, this approach not only saves time but also ensures a smooth and reliable connection to your Teamtailor API.

Cyberark API Directory

CyberArk software is a leading cybersecurity solution specializing in identity security and privileged access management (PAM). It plays a crucial role in protecting organizations from cyber threats by securing privileged accounts, credentials, and secrets. As cyber threats continue to evolve, CyberArk's robust security measures ensure that sensitive data and critical infrastructure remain safeguarded. Its comprehensive approach to identity security makes it an essential tool for businesses across various industries, aiming to protect their most valuable assets.

One of the key features of CyberArk is its ability to integrate seamlessly with existing IT environments through its API. The CyberArk API facilitates smooth integration, enabling organizations to enhance their security posture without disrupting their current operations. By leveraging the CyberArk API, businesses can automate security processes, streamline identity management, and ensure compliance with industry regulations. This integration capability not only strengthens security but also optimizes operational efficiency, making CyberArk a preferred choice for enterprises seeking advanced cybersecurity solutions.

Key highlights of Cyberark APIs

The CyberArk API suite provides powerful tools to integrate and automate privileged access management (PAM) functionalities. Below are the key highlights of the CyberArk APIs:

Core Functionalities:

Account Management: Create, retrieve, update, and delete privileged accounts to ensure efficient and secure management of credentials.
User Management: Manage users, roles, and permissions to enforce strict access control policies.
Session Management: Initiate, monitor, and terminate privileged sessions with support for session recording for auditing purposes.
Policy Management: Define, update, and apply security policies for password rotation, access controls, and compliance requirements.

Integration Use Cases:

Automated Credential Rotation: Enable seamless credential updates for critical systems as per security policies.
Incident Response Automation: Integrate with SIEM tools to automate detection and response to security events.
Compliance Audits: Extract detailed logs and session recordings to meet regulatory requirements.

Supported Protocols:

RESTful API: CyberArk APIs are REST-compliant, using standard HTTP methods for resource interaction.

Authentication Mechanisms:

Session Token Authentication: Secure API access by using session tokens obtained via the login endpoint.
OAuth 2.0: Where supported, OAuth 2.0 can be used for enhanced security in integrations.

Rate Limiting Policies:

Call Limits: Best practices include limiting excessive API calls and handling 429 (Too Many Requests) responses effectively.

For comprehensive information, refer to the official CyberArk API documentation.

‍

Cyberark API Endpoints

CDirectoryService

post https://{tenant_url}/CDirectoryService/ChangeUser : The Update Base Profile Identity API allows authorized users to update information for a specified cloud user.
post https://{tenant_url}/CDirectoryService/ChangeUserState : The Change User State - Identity API allows authorized users to change the state of a user from disabled to active or vice versa.
post https://{tenant_url}/CDirectoryService/ExemptUserFromMfa : This API allows a system administrator or a user with user management permissions to exempt a user from Multi-Factor Authentication (MFA) login for a specified amount of time.
post https://{tenant_url}/CDirectoryService/GetTechSupportUser : The Fetch Technical Support User Identity API allows system administrators or users with user management permissions to retrieve information about a technical support user.
post https://{tenant_url}/CDirectoryService/GetUser : The Get User Details API allows system administrators, users with user management rights, or the user itself to fetch details of a specific existing user in the cloud directory.
post https://{tenant_url}/CDirectoryService/GetUserAttributes : The 'Get User Attributes - Identity API' allows clients to retrieve detailed information about a cloud user.
post https://{tenant_url}/CDirectoryService/GetUserByName : The 'Get User Details by Name - Identity API' allows you to retrieve details of a cloud user by their username.
post https://{tenant_url}/CDirectoryService/GetUsers : The 'Get Users Details - Identity API' allows system administrators and users with user management rights to fetch a list of all existing users in the cloud directory.
post https://{tenant_url}/CDirectoryService/GetUsersFromCsvFile : This API is used to initiate the bulk user import in the CyberArk Identity cloud directory.
post https://{tenant_url}/CDirectoryService/SetUserPicture : This API allows setting a user's picture/photo for a particular user.
post https://{tenant_url}/CDirectoryService/SetUserState : The Set User State API in CyberArk Identity allows system administrators and users with user management permissions to lock, disable, or set a Cloud Directory account to expired.
post https://{tenant_url}/CDirectoryService/SubmitUploadedFile : The Advance Bulk User Import - Identity API allows system administrators and users with user management rights to create users in bulk in the CyberArk Identity cloud directory.

Core

post https://{tenant_url}/Core/GetUserSettings : The 'Get User Settings - Identity API Reference' API allows clients to retrieve user settings based on the specified user ID and setting type.

ExtData

post https://{tenant_url}/ExtData/GetColumns : This API is used to retrieve the list of all current attributes and their values for a CyberArk Identity user.
post https://{tenant_url}/ExtData/GetSchema : The Get Schema - Identity API Reference is used to obtain a list of the current attributes (columns) for a table in the Tenant's extended schema.
post https://{tenant_url}/ExtData/SetColumns : This API is used to update the extended attribute values for a CyberArk Identity user.
post https://{tenant_url}/ExtData/UpdateSchema : This API allows system administrators to add new attributes to the tenant schema or update existing attributes.

Org

post https://{tenant_url}/Org/ChangeMemberShip : The Update Organization Membership API allows you to add or delete members for an organization.
post https://{tenant_url}/Org/Create : The Create Organization Identity API allows system administrators to create a new organization by providing a name and an optional description.
post https://{tenant_url}/Org/Delete : The Delete Organization - Identity API allows a system administrator to delete an organization by providing the unique organization ID.
post https://{tenant_url}/Org/Get : This API is used to retrieve details of a specific organization by providing its unique ID.
post https://{tenant_url}/Org/GetAdministrators : This API is used to retrieve the list of administrators for a specified organization.
post https://{tenant_url}/Org/GetPermission : The 'Get Administrative Rights - Identity API' allows users with AdminUI task permission to retrieve administrative rights for a specified organization.
post https://{tenant_url}/Org/GetRoles : This API is used to retrieve the roles for a specific organization by providing the organization's unique ID.
post https://{tenant_url}/Org/ListAll : This API is used to retrieve a list of all organizations.
post https://{tenant_url}/Org/Update : The Update Organization Identity API allows a system administrator to update the details of an organization.
post https://{tenant_url}/Org/UpdateAdministrators : The 'Update Administrators for Organization' API allows a system administrator to add or delete administrators for a specified organization.
post https://{tenant_url}/Org/UpdatePermission : The Update Administrative Rights API allows a system administrator to update permissions for an organization.

User

post https://{tenant_url}/User/UpdateProfile : The Update User Profile API allows system administrators, users with user management rights, or the user itself to update an existing cloud user's properties.

UserMgmt

post https://{tenant_url}/UserMgmt/ChangeUserAttributes : This API is used to update the value of different attributes for CyberArk Identity active directory users.
post https://{tenant_url}/UserMgmt/GetUserAttributes : This API fetches attributes for a specified user.
post https://{tenant_url}/UserMgmt/GetUserHierarchy : The Get User Hierarchy API is used to retrieve the reporting hierarchy for a specified user.
post https://{tenant_url}/UserMgmt/GetUserInfo : The 'Get User Information - Identity API' allows authorized users to retrieve detailed information about a specific user within the system.
post https://{tenant_url}/UserMgmt/GetUserRiskLevel : This API enables system administrators with user management rights to fetch the risk level details of an existing user in the Cloud Directory.
post https://{tenant_url}/UserMgmt/GetUsersRolesAndAdministrativeRights : This API is used to retrieve a list of user roles and administrative rights associated with those roles.
post https://{tenant_url}/UserMgmt/InviteUsers : The Invite Cloud Users API allows system administrators or users with user management permissions to invite users or groups to the cloud system.
post https://{tenant_url}/UserMgmt/IsUserCloudLocked : This API checks if a user is locked in the system.
post https://{tenant_url}/UserMgmt/IsUserLockedOutByPolicy : This API checks if a user is locked out by policy, meaning they cannot answer MFA challenges and authenticate against CyberArk Identity.
post https://{tenant_url}/UserMgmt/RemoveUsers : The Delete Users - Identity API allows system administrators or users with user management permissions to delete cloud users.
post https://{tenant_url}/UserMgmt/SendLoginEmails : The Send Invitation Email - Identity API allows system administrators to send invitation emails to a list of users identified by their UUIDs.
post https://{tenant_url}/UserMgmt/SendSmsInvite : The Send Invitation SMS - Identity API allows system administrators or users with user management permissions to send an invitation SMS to a user identified by their UUID.
post https://{tenant_url}/UserMgmt/SetCloudLock : This API is used to lock or unlock a user account.

scim

get https://{tenant_url}/scim/Groups : The Query Groups Identity API fetches all the groups from the SCIM service.
delete https://{tenant_url}/scim/Groups/{id} : The Delete Group Identity API is used to delete a group resource identified by a unique group ID.
post https://{tenant_url}/scim/Users : The Create User - Identity API allows system administrators or users with user management rights to create a new user in the system.
put https://{tenant_url}/scim/Users/{id} : The Update User Identity API is used to replace a user resource's attributes using the SCIM PUT operation.

‍

CyberArk API FAQs

How do I authenticate with the CyberArk REST API?

Answer: To authenticate with the CyberArk REST API, you need to obtain a session token. This involves sending a POST request to the /PasswordVault/API/Auth/CyberArk/Logon endpoint with your credentials. The response will include a session token, which must be included in the Authorization header of subsequent API requests.
Source: Authentication - CyberArk Docs

What are the rate limits for the CyberArk REST API?

Answer: CyberArk's REST APIs are designed to be stable and predictable. While specific rate limits are not explicitly documented, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
Source: REST APIs - CyberArk Docs

Can I retrieve account information using the CyberArk REST API?

Answer: Yes, you can retrieve account information using the CyberArk REST API. For example, to list all accounts, you can make a GET request to the /PasswordVault/API/Accounts endpoint.
Source: Accounts - CyberArk Docs

Does the CyberArk REST API support webhooks for real-time data updates?

Answer: As of the latest available information, CyberArk's REST API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
Source: REST APIs - CyberArk Docs

Are there official SDKs or client libraries for the CyberArk REST API?

Answer: CyberArk provides a RESTful API that can be invoked by any RESTful client for various programming and scripting environments, including Java, C#, Perl, PHP, Python, and Ruby.
Source: REST APIs - CyberArk Docs

Get Started with CyberArk API Integration

Knit API offers a convenient solution for quick and seamless integration with CyberArk API. Our AI-powered integration platform allows you to build any CyberArk API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to CyberArk API.‍

To sign up for free, click here. To check the pricing, see our pricing page

BreatheHR API Directory

BreatheHR is a comprehensive HR management software designed to streamline human resource processes for small to medium-sized businesses. By offering a centralized platform, it enables organizations to efficiently manage personal data, company documents, holiday requests, expenses, and sick leave. This user-friendly software enhances workforce connectivity and ensures that HR tasks are handled with precision and ease, allowing businesses to focus on growth and productivity.

One of the standout features of BreatheHR is its ability to integrate seamlessly with other business tools through the BreatheHR API. This integration capability allows businesses to customize their HR management experience, ensuring that all systems work in harmony. By leveraging the BreatheHR API, companies can automate data flows, reduce manual entry, and maintain accurate records, ultimately leading to improved efficiency and decision-making. As businesses continue to evolve, BreatheHR remains a vital tool in the HR domain, offering flexibility and scalability to meet diverse organizational needs.

Key highlights of BreatheHR APIs

Easy Data Access:
- The breatheHR API allows seamless integration with existing systems, providing effortless access to employee data across multiple applications.
Automation:
- Automate business operations and data flow across systems, reducing manual data entry and saving time.
Custom Integration:
- Open-source and developer-friendly, the breatheHR API supports custom integrations with third-party software for tailored solutions.
Developer-Friendly:
- Designed with developers in mind, the API offers flexibility and ease of use for creating custom solutions.

BreatheHR API Endpoints

Absences

get https://api.breathehr.com/v1/absences : Get Absences
post https://api.breathehr.com/v1/absences/{id}/cancel : Cancel Absence Request

Account

get https://api.breathehr.com/v1/account : Get Account Details

Bonuses

get https://api.breathehr.com/v1/bonuses : Get Bonuses

Change Requests

get https://api.breathehr.com/v1/change_requests : Get Change Requests

Company

get https://api.breathehr.com/v1/company_training_types : Get Company Training Types
get https://api.breathehr.com/v1/departments : Get Company Departments
get https://api.breathehr.com/v1/divisions : Get Company Divisions
get https://api.breathehr.com/v1/locations : Get Company Locations

Department

get https://api.breathehr.com/v1/departments/{id}/absences : Get Department Absences
get https://api.breathehr.com/v1/departments/{id}/benefits : Get Department Benefits
get https://api.breathehr.com/v1/departments/{id}/bonuses : Get Department Bonuses
get https://api.breathehr.com/v1/departments/{id}/leave_requests : Get Leave Requests for a Department
get https://api.breathehr.com/v1/departments/{id}/salaries : Get Department Salaries

Employee Expenses

post https://api.breathehr.com/v1/employee_expense_claims : Create Employee Expense Claims
put https://api.breathehr.com/v1/employee_expense_claims/{id} : Update Employee Expense Claim
post https://api.breathehr.com/v1/employee_expenses : Create Employee Expenses
get https://api.breathehr.com/v1/employee_expenses/{id} : Get Employee Expenses by ID

Employee

get https://api.breathehr.com/v1/employee_jobs : Get Employee Jobs
get https://api.breathehr.com/v1/employee_training_courses : Get Employee Training Courses
delete https://api.breathehr.com/v1/employee_training_courses/{id} : Delete Employee Training Course
post https://api.breathehr.com/v1/employees : Create New Employee Record
post https://api.breathehr.com/v1/employees/{employee_id}/change_requests/{id}/approve : Approve Employee Change Request
get https://api.breathehr.com/v1/employees/{id} : Get Employee Details
get https://api.breathehr.com/v1/employees/{id}/absences : Get Employee Absences
get https://api.breathehr.com/v1/employees/{id}/benefits : Get Employee Benefits
get https://api.breathehr.com/v1/employees/{id}/bonuses : Get Employee Bonuses
post https://api.breathehr.com/v1/employees/{id}/change_requests : Create Employee Change Request
post https://api.breathehr.com/v1/employees/{id}/leave_requests : Create Leave Request for Employee
get https://api.breathehr.com/v1/employees/{id}/sicknesses : Get Employee Sickness Records

Leave Requests

get https://api.breathehr.com/v1/leave_requests : Get Leave Requests
get https://api.breathehr.com/v1/leave_requests/{id} : Get Leave Request Details
post https://api.breathehr.com/v1/leave_requests/{id}/approve : Approve Leave Request
get https://api.breathehr.com/v1/leave_requests/{id}/cancelling : Get Leave Request Cancelling Details
post https://api.breathehr.com/v1/leave_requests/{id}/reject : Reject Leave Request

Holiday

get https://api.breathehr.com/v1/holiday_allowances : Get Holiday Allowances
get https://api.breathehr.com/v1/statutory_holiday_countries : Get Statutory Holiday Countries

Other

get https://api.breathehr.com/v1/other_leave_reasons : Get Other Leave Reasons
get https://api.breathehr.com/v1/salaries : Get Employee Salaries
get https://api.breathehr.com/v1/sicknesses : Get Sickness Records
delete https://api.breathehr.com/v1/sicknesses/{id} : Delete Sickness Record
get https://api.breathehr.com/v1/working_patterns : Get Working Patterns

‍

BreatheHR API FAQs

How do I enable API access in BreatheHR?

Answer: To enable API access in BreatheHR:some text
1. Log in to your BreatheHR account as an Admin.
2. Navigate to Configure > Settings > Integrations > API Setup.
3. Click on Enable API and confirm the action.
4. Once enabled, your production API key will be displayed.
Source: How to enable the Breathe API | Breathe Knowledgebase

What authentication method does the BreatheHR API use?

Answer: The BreatheHR API uses API key-based authentication. Include your API key in the X-API-KEY header of your HTTP requests to authenticate.
Source: Breathe Developer Documentation

Are there rate limits for the BreatheHR API?

Answer: The official documentation does not specify explicit rate limits for the BreatheHR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
Source: Breathe Developer Documentation

Can I retrieve employee data using the BreatheHR API?

Answer: Yes, you can retrieve employee data by making a GET request to the /employees endpoint. This will return a list of employees and their details.
Source: Breathe Developer Documentation

Does the BreatheHR API support webhooks?

Answer: As of the latest available information, the BreatheHR API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
Source: Breathe Developer Documentation

‍

Get Started with BreatheHR API Integration

For quick and seamless integration with BreatheHR API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any BreatheHR API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to BreatheHR API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

NetSuite API Directory

NetSuite is a leading cloud-based Enterprise Resource Planning (ERP) platform that helps businesses manage finance, operations, customer relationships, and more from a unified system. Its robust suite of applications streamlines workflows automates processes and provides real-time data insights.

To extend its functionality, NetSuite offers a comprehensive set of APIs that enable seamless integration with third-party applications, custom automation, and data synchronization.

Learn all about the NetSuite API in our in-depth Nestuite API Guide

This article explores the NetSuite APIs, outlining the key APIs available, their use cases, and how they can enhance business operations.

‍Key Highlights of NetSuite APIs

The key highlights of NetSuite APIs are as follows:

SuiteTalk (SOAP & REST) – Provides programmatic access to NetSuite data and functionality for seamless integration with external applications. Supports both SOAP and REST web services.
SuiteScript – A JavaScript-based API that enables custom business logic and automation within NetSuite, including workflows, user event scripts, and scheduled scripts.
REST Web Services – A modern, lightweight API with JSON-based data exchange, ideal for real-time integrations and improved performance over SOAP.
SOAP Web Services – A robust API for complex integrations, offering structured XML-based communication and extensive support for NetSuite's data model.
SuiteAnalytics Connect – Enables direct access to NetSuite data via ODBC, JDBC, and ADO.NET for advanced reporting, analytics, and external BI tool integration.
Token-Based Authentication (TBA) – Enhances security and scalability by allowing API access without storing user credentials using OAuth-style token authentication.
OData Support—Integrates with business intelligence tools that support the OData protocol to facilitate easy data extraction for reporting and analytics.

These APIs empower developers to build custom solutions, automate workflows, and integrate NetSuite with external platforms, enhancing operational efficiency and business intelligence.

This article gives an overview of the most commonly used NetSuite API endpoints.

NetSuite API Endpoints

Here are the most commonly used NetSuite API endpoints:

‍Accounts‍

GET /account
POST /account
DELETE /account/{id}
GET /account/{id}
PATCH /account/{id}
PUT /account/{id}

Accounting Book

GET /accountingBook
POST /accountingBook
DELETE /accountingBook/{id}
GET /accountingBook/{id}
PATCH /accountingBook/{id}
PUT /accountingBook/{id}

Customers

GET /customer
POST /customer
DELETE /customer/{id}
GET /customer/{id}
PATCH /customer/{id}
PUT /customer/{id}

Vendors

GET /vendor
POST /vendor
DELETE /vendor/{id}
GET /vendor/{id}
PATCH /vendor/{id}
PUT /vendor/{id}

Transactions

GET /transaction
POST /transaction
DELETE /transaction/{id}
GET /transaction/{id}
PATCH /transaction/{id}
PUT /transaction/{id}

Items

GET /item
POST /item
DELETE /item/{id}
GET /item/{id}
PATCH /item/{id}
PUT /item/{id}

Employees

GET /employee
POST /employee
DELETE /employee/{id}
GET /employee/{id}
PATCH /employee/{id}
PUT /employee/{id}

Sales Orders

GET /salesOrder
POST /salesOrder
DELETE /salesOrder/{id}
GET /salesOrder/{id}
PATCH /salesOrder/{id}
PUT /salesOrder/{id}

Purchase Orders

GET /purchaseOrder
POST /purchaseOrder
DELETE /purchaseOrder/{id}
GET /purchaseOrder/{id}
PATCH /purchaseOrder/{id}
PUT /purchaseOrder/{id}

Invoices

GET /invoice
POST /invoice
DELETE /invoice/{id}
GET /invoice/{id}
PATCH /invoice/{id}
PUT /invoice/{id}

Payments

GET /payment
POST /payment
DELETE /payment/{id}
GET /payment/{id}
PATCH /payment/{id}
PUT /payment/{id}

Departments

GET /department
POST /department
DELETE /department/{id}
GET /department/{id}
PATCH /department/{id}
PUT /department/{id}

Locations

GET /location
POST /location
DELETE /location/{id}
GET /location/{id}
PATCH /location/{id}
PUT /location/{id}

Classes

GET /classification
POST /classification
DELETE /classification/{id}
GET /classification/{id}
PATCH /classification/{id}
PUT /classification/{id}

Currencies

GET /currency
POST /currency
DELETE /currency/{id}
GET /currency/{id}
PATCH /currency/{id}
PUT /currency/{id}

Tax Codes

GET /taxCode
POST /taxCode
DELETE /taxCode/{id}
GET /taxCode/{id}
PATCH /taxCode/{id}
PUT /taxCode/{id}

Subsidiaries

GET /subsidiary
POST /subsidiary
DELETE /subsidiary/{id}
GET /subsidiary/{id}
PATCH /subsidiary/{id}
PUT /subsidiary/{id}

Budget

GET /budget
POST /budget
DELETE /budget/{id}
GET /budget/{id}
PATCH /budget/{id}
PUT /budget/{id}

Expense Reports

GET /expenseReport
POST /expenseReport
DELETE /expenseReport/{id}
GET /expenseReport/{id}
PATCH /expenseReport/{id}
PUT /expenseReport/{id}

Time Entries

GET /timeEntry
POST /timeEntry
DELETE /timeEntry/{id}
GET /timeEntry/{id}
PATCH /timeEntry/{id}
PUT /timeEntry/{id}

Projects

GET /project
POST /project
DELETE /project/{id}
GET /project/{id}
PATCH /project/{id}
PUT /project/{id}

Work Orders

GET /workOrder
POST /workOrder
DELETE /workOrder/{id}
GET /workOrder/{id}
PATCH /workOrder/{id}
PUT /workOrder/{id}

Here’s a detailed reference to all the NetSuite API Endpoints.

NetSuite API FAQs‍

Here are the frequently asked questions about NetSuite APIs to help you get started:

What is the API limit for NetSuite? Answer
How do I connect to Oracle Netsuite using OAuth 2.0 Client Credentials Flow and JWT certificate with .net core? Answer
How to generate JWT Bearer Flow OAuth access tokens from a .net core client? Answer
How do create Vendor Bill in NetSuite using REST API? Answer
Was the ability to add Communication (Notes) to NetSuite invoices via REST API removed? Answer‍

Find more FAQs here.

Get started with NetSuite API‍

To access NetSuite APIs, enable API access in NetSuite, create an integration record to obtain consumer credentials, configure token-based authentication (TBA) or OAuth 2.0, generate access tokens, and use them to authenticate requests to NetSuite API endpoints.

However, if you want to integrate with multiple CRM, Accounting or ERP APIs quickly, you can get started with Knit, one API for all top integrations.

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Humaans API Directory

Humaans is a cutting-edge HRIS (Human Resource Information System) designed to revolutionize employee management for globally distributed companies. By offering a comprehensive suite of tools, Humaans simplifies the management of the entire employment lifecycle, from onboarding and promotions to offboarding and compensation management. This modern cloud platform is tailored to meet the needs of both small to medium-sized businesses (SMBs) and enterprise-level organizations, ensuring that HR teams can efficiently handle employee databases, payroll, time tracking, benefits, and other critical workforce data. With a focus on automation and streamlined workflows, Humaans significantly reduces administrative burdens, allowing HR professionals to focus on strategic initiatives.

One of the standout features of Humaans is its robust API integration capabilities, which enable seamless connectivity with various third-party applications. The Humaans API allows businesses to customize and extend the functionality of the platform, ensuring that it aligns perfectly with their unique operational requirements. By leveraging the Humaans API, organizations can enhance productivity and drive efficiency across their HR processes, making it an indispensable tool for modern HR management.

Key highlights of Humaans APIs

Humaans provides a RESTful API that enables developers to programmatically access and manage data within the Humaans platform. This API facilitates seamless integration with external applications, allowing operations such as retrieving employee information, managing documents, and handling time-off requests.

Humaans Docs

Key Features of the Humaans API:

Authentication: Utilizes API access tokens for secure authentication. Tokens are managed within the Humaans platform and should be included in the Authorization header as a Bearer token for each request.
Scopes and Roles: Access tokens can be restricted to specific scopes, limiting the actions they can perform. Roles assigned to users further define the level of access, ensuring that only authorized operations are executed.

Standardized Structure: The API features consistently structured, resource-oriented URLs, accepts and returns JSON-formatted data, and employs standard HTTP response codes and methods, facilitating straightforward integration.

Humaans API Endpoints

Time Away

DELETE https://api.example.com/time-away : Delete a time away
POST https://app.humaans.io/api/time-away : Create a Time Away Entry
PATCH https://app.humaans.io/api/time-away/{id} : Update a Time Away Entry
POST https://app.humaans.io/api/time-away-adjustments : Create a Time Away Adjustment
DELETE https://app.humaans.io/api/time-away-adjustments/{id} : Delete a Time Away Adjustment
POST https://app.humaans.io/api/time-away-allocations : Create a Time Away Allocation
GET https://app.humaans.io/api/time-away-allocations/{id} : Retrieve a Time Away Allocation
GET https://app.humaans.io/api/time-away-periods : List All Time Away Periods
GET https://app.humaans.io/api/time-away-policies : List All Time Away Policies
DELETE https://app.humaans.io/api/time-away-policies/{id} : Delete a Time Away Policy
POST https://app.humaans.io/api/time-away-types : Create a Time Away Type
GET https://app.humaans.io/api/time-away-types/{id} : Retrieve a Time Away Type

Bank Accounts

GET https://app.humaans.io/api/bank-accounts : List All Bank Accounts
DELETE https://app.humaans.io/api/bank-accounts/{id} : Delete a Bank Account

Companies

GET https://app.humaans.io/api/companies : List All Companies
PATCH https://app.humaans.io/api/companies/{id} : Update a Company

Compensations

POST https://app.humaans.io/api/compensations : Create a Compensation
DELETE https://app.humaans.io/api/compensations/{id} : Delete a Compensation

Custom Fields

GET https://app.humaans.io/api/custom-fields : List All Custom Fields
DELETE https://app.humaans.io/api/custom-fields/{id} : Delete a Custom Field

Custom Values

POST https://app.humaans.io/api/custom-values : Create a Custom Value
DELETE https://app.humaans.io/api/custom-values/{id} : Delete a Custom Value
PATCH https://app.humaans.io/api/custom-values{id} : Update a Custom Value

Data Exports

GET https://app.humaans.io/api/data-exports : Create a Data Export
GET https://app.humaans.io/api/data-exports/{id} : Retrieve a Data Export

Document Types

POST https://app.humaans.io/api/document-types : Create a Document Type
POST https://app.humaans.io/api/document-types/{id} : Update Document Type

Documents

GET https://app.humaans.io/api/documents : List All Documents
DELETE https://app.humaans.io/api/documents/{document_id} : Delete a Document
GET https://app.humaans.io/api/documents/{id} : Retrieve a Document

Emergency Contacts

GET https://app.humaans.io/api/emergency-contacts : List All Emergency Contacts
DELETE https://app.humaans.io/api/emergency-contacts/{id} : Delete an Emergency Contact

Equipment

POST https://app.humaans.io/api/equipment : Create Equipment
GET https://app.humaans.io/api/equipment-names : List All Equipment Names
GET https://app.humaans.io/api/equipment-types : List All Equipment Types
DELETE https://app.humaans.io/api/equipment/{id} : Delete an Equipment

Files

POST https://app.humaans.io/api/files : Create a File
GET https://app.humaans.io/api/files/{id} : Retrieve a File

Identity Documents

GET https://app.humaans.io/api/identity-document : List All Identity Documents
GET https://app.humaans.io/api/identity-document-types : List All Identity Document Types
POST https://app.humaans.io/api/identity-document/{id} : Create an Identity Document
DELETE https://app.humaans.io/api/identity-documents/{id} : Delete an Identity Document

Job Roles

POST https://app.humaans.io/api/job-roles : Create a Job Role
DELETE https://app.humaans.io/api/job-roles/{id} : Delete a Job Role

Locations

GET https://app.humaans.io/api/locations : List All Locations
PATCH https://app.humaans.io/api/locations/{id} : Update a Location

People

GET https://app.humaans.io/api/me/{id} : Retrieve Currently Logged In User
GET https://app.humaans.io/api/people : List All People
GET https://app.humaans.io/api/people/{id} : Retrieve a Person
GET and GET https://app.humaans.io/api/persons/{personId} and https:/app.humaans.io/api/companies/{companyId} : Retrieve Company Details Using Person's Company ID

Public Holidays

GET https://app.humaans.io/api/public-holiday-calendars : List all public holiday calendars
GET https://app.humaans.io/api/public-holidays : List all public holidays

Timesheets

GET https://app.humaans.io/api/timesheet-entries : List All Timesheet Entries
DELETE https://app.humaans.io/api/timesheet-entries/{id} : Delete a Timesheet Entry
GET https://app.humaans.io/api/timesheet-submissions : List All Timesheet Submissions
PATCH https://app.humaans.io/api/timesheet-submissions/{id} : Update a Timesheet Submission

Token Information

GET https://app.humaans.io/api/token-info/undefined : Retrieve Token Information

‍

Humans API FAQs

How can I access the Humaans API?

Answer: To access the Humaans API, you need to generate an API token within your Humaans account. Navigate to the API section in your account settings to create a new token. This token will be used to authenticate your API requests.

What authentication method does the Humaans API use?

Answer: The Humaans API uses token-based authentication. After generating an API token, include it in the Authorization header of your HTTP requests, formatted as Bearer YOUR_API_TOKEN.

Are there rate limits for the Humaans API?

Answer: The official documentation does not specify explicit rate limits for the Humaans API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.

Can I retrieve employee data using the Humaans API?

Answer: Yes, the Humaans API provides endpoints to retrieve employee data. For example, you can use the /employees endpoint to fetch a list of all employees, including their details such as names, roles, and contact information.

Does the Humaans API support webhooks for real-time data updates?

Answer: Yes, Humaans supports webhooks, allowing you to receive real-time notifications for specific events, such as employee updates or time-off requests. You can configure webhook subscriptions to specify which events you want to receive notifications for. Intercom

Get Started with Humaans API Integration

Obtain API Access Tokens: Log in to your Humaans account to generate and manage API access tokens. Ensure these tokens are kept secure, as they grant significant access privileges.
Set Appropriate Scopes: When creating access tokens, assign the necessary scopes to control the level of access, such as public:read for viewing public data or private:write for modifying private data.
Understand API Endpoints: Familiarize yourself with the available endpoints, which cover resources like employees, documents, and time-off policies. Each resource supports standard operations (GET, POST, PATCH, DELETE) for data manipulation.
Handle Pagination and Filtering: For endpoints that return lists of resources, implement pagination using parameters like $limit and $skip. Utilize filtering options to retrieve specific subsets of data as needed.

Additional Resources:

Comprehensive Documentation: Detailed API documentation is available, providing in-depth information on endpoints, authentication methods, and data structures.
Integration Support: Humaans offers guidance on integrating with various tools and platforms, enhancing the functionality of your HR operations.

‍

About Knit

Knit API offers a convenient solution for quick and seamless integration with Humaans API. Our AI-powered integration platform allows you to build any Humaans API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Humaans API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

Darwinbox API Directory

Darwinbox is a cutting-edge cloud-based Human Resources Management Software (HRMS) that revolutionizes the Human Capital Management (HCM) landscape. Designed to streamline and automate a myriad of HR processes, Darwinbox enhances both efficiency and the employee experience. This comprehensive platform offers an extensive suite of tools that manage the entire employee lifecycle, from core HR functions such as employee data management and payroll processing to talent management, employee engagement, and workforce management. With advanced analytics and reporting capabilities, Darwinbox empowers organizations to make data-driven decisions, ultimately improving HR efficiency and reducing manual workload.

As a Software as a Service (SaaS) platform, Darwinbox is accessible via the internet, making it a versatile solution for businesses of all sizes. One of the key features that sets Darwinbox apart is its robust API integration capabilities. The Darwinbox API allows seamless integration with other enterprise systems, ensuring a cohesive digital ecosystem. This integration process is crucial for organizations looking to enhance their HR operations by connecting Darwinbox with existing tools and platforms. By leveraging the Darwinbox API, businesses can unlock new levels of efficiency and customization, tailoring the software to meet their unique needs.

Key highlights of Darwinbox APIs

Key Features of Darwinbox APIs:

Authentication: Darwinbox APIs employ a token-based authentication mechanism. The token is generated using a SHA512 hash of a dynamic string, which includes parameters like the admin email, a unique secret key provided by Darwinbox, and the current epoch timestamp. Postman
Data Formats: The APIs communicate using JSON, ensuring compatibility with a wide range of programming languages and platforms. Postman
Comprehensive Documentation: Darwinbox provides detailed API documentation, including guides and references, to assist developers in effectively utilizing the APIs. Darwinbox API Docs
Integration Capabilities: The platform supports integrations with various external systems, such as recruitment tools, ERP systems, payroll and compliance management, employee rewards, and engagement platforms. This extensibility ensures a seamless user experience across different solutions. Darwinbox

‍

Darwinbox API Endpoints

Attendance

POST https://{{subdomain}}.darwinbox.in/AttendancePunchesApi : Add Attendance Punches
POST https://{{subdomain}}.darwinbox.in/attendanceDataApi/backdatedattendance : Add Backdated Attendance
POST https://{{subdomain}}.darwinbox.in/attendanceDataApi/timesheetdatewise : Employee Timesheet Datewise

Background Verification

POST https://{{subdomain}}.darwinbox.in/Bgv/candidatedetailv2 : Background Verification - Fetch Candidate Details V2
POST https://{{subdomain}}.darwinbox.in/Bgv/candidatelistv2 : Background Verification - Fetch Candidate List V2
POST https://{{subdomain}}.darwinbox.in/Bgv/filedownloadv2 : Background Verification - Download Form Attachments
POST https://{{subdomain}}.darwinbox.in/Bgv/reportsubmissionv2 : Background Verification - Submit Verification Report V2

Employee Management

POST https://{{subdomain}}.darwinbox.in/Employeedocs/StandardDoc : Add Standard Documents
POST https://{{subdomain}}.darwinbox.in/UpdateEmployeeDetails/approvedconfirmation : Fetch Approved Confirmation Data
POST https://{{subdomain}}.darwinbox.in/UpdateEmployeeDetails/update : Add/Update Employee Email ID
POST https://{{subdomain}}.darwinbox.in/importapi/activate : Activate Pending Employee
POST https://{{subdomain}}.darwinbox.in/importapi/add : Add Pending Employee
POST https://{{subdomain}}.darwinbox.in/importapi/deactivate : Deactivate Active Employee
POST https://{{subdomain}}.darwinbox.in/importapi/deletePendingEmployee : Delete Pending Employee
POST https://{{subdomain}}.darwinbox.in/importapi/educationdetails : Add or Update Employee Education Details
POST https://{{subdomain}}.darwinbox.in/importapi/pastworkdetails : Add or Update Past Work Details
POST https://{{subdomain}}.darwinbox.in/importapi/processCustomSection : Add or Update Custom Section

Project Management

POST https://{{subdomain}}.darwinbox.in/importapi/addProject : Add or Update Project
POST https://{{subdomain}}.darwinbox.in/importapi/addProjectTeam : Add Project Team
POST https://{{subdomain}}.darwinbox.in/importapi/addactivity : Add Activity
POST https://{{subdomain}}.darwinbox.in/importapi/assignpermissions : Assign Permissions

Organizational Management

POST https://{{subdomain}}.darwinbox.in/importapi/addLocations : Create Location Masters
POST https://{{subdomain}}.darwinbox.in/orgmasterapi/createCostCenter : Create Cost Center Master
POST https://{{subdomain}}.darwinbox.in/orgmasterapi/createbusinessunit : Add or Update Business Unit Master
POST https://{{subdomain}}.darwinbox.in/orgmasterapi/createdepartment : Add or Update Department Master
POST https://{{subdomain}}.darwinbox.in/orgmasterapi/createdesignation : Create Designation
POST https://{{subdomain}}.darwinbox.in/orgmasterapi/createdesignationname : Create or Update Designation Name
POST https://{{subdomain}}.darwinbox.in/orgmasterapi/createposition : Create or Update Position Master

Recruitment

POST https://{{subdomain}}.darwinbox.in/JobsApiv2/candidatetag : Add Tags to Candidate Profile V3

Travel

POST https://{{subdomain}}.darwinbox.in/travelApi/Advance : Fetch Advance Travel Requests

‍

Darwinbox API FAQs

How can I access the Darwinbox API?
- Answer: To access the Darwinbox API, you need to be a privileged user with appropriate permissions. Access is provided on a request-only basis. You can reach out to Darwinbox at integrations@darwinbox.in to request API access. Darwinbox API Docs
What authentication method does the Darwinbox API use?
- Answer: The Darwinbox API uses a token-based authentication mechanism. To generate the required token, you need the following parameters:
  - Email: Admin Email ID provided by Darwinbox.
  - Timestamp: Current 10-digit epoch timestamp.
  - Secret Key: Unique secret key provided by Darwinbox.The token is generated by creating a SHA512 hash of the concatenated string: email + secretkey + timestamp. Postman
Are there rate limits for the Darwinbox API?
- Answer: The official documentation does not specify explicit rate limits for the Darwinbox API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
Can I retrieve employee data using the Darwinbox API?
- Answer: Yes, the Darwinbox API provides endpoints to retrieve employee data. For example, you can use the POST /masterapi/employee endpoint to fetch employee data, either as a full load or based on specific criteria such as last modified date. Postman
Does the Darwinbox API support webhooks for real-time data updates?
- Answer: As of the latest available information, the Darwinbox API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services like Knit that provide webhook functionality.

‍

Get Started with Darwinbox API Integration

Access Privileges: Darwinbox APIs are accessible only to privileged users. Access is provided on a request-only basis, ensuring secure and controlled integration. Darwinbox API Docs
Authentication Setup: To authenticate API requests, generate a SHA512 hash using your admin email, the unique secret key provided by Darwinbox, and the current epoch timestamp. This hash is then included in your API requests to validate access. Postman
Explore API Endpoints: Darwinbox offers a variety of API endpoints across different modules, including Employee Core, Recruitment, Onboarding, Attendance, Leave, Performance, Compensation, Expenses, Recognition, Travel, Vibe and Pulse, and HR Documents. Each module provides specific functionalities to manage corresponding HR processes. Postman
Utilize Postman Collections: Darwinbox provides a public workspace on Postman, featuring ready-to-use requests and documentation. This resource aids in testing and understanding API endpoints. Postman

Additional Resources:

Integration Guides: For detailed integration instructions, refer to the Darwinbox Integrations page, which outlines how to become a partner and explore various integration categories and brands. Darwinbox
Developer Community: Engage with the Darwinbox developer community for support, insights, and updates related to the APIs. Postman

‍

About Knit

Knit API offers a convenient solution for quick and seamless integration with Darwinbox API. Our AI-powered integration platform allows you to build any Darwinbox API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Darwinbox API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

Bullhorn API Directory

Bullhorn is a leading software company specializing in providing web-based solutions tailored for the staffing and recruiting industry. Its comprehensive platform is designed to streamline recruitment processes, automate workflows, and ultimately enhance business growth by increasing placements. By leveraging Bullhorn, staffing professionals can efficiently manage candidate relationships, job orders, and client interactions, all within a single, intuitive interface. This focus on automation and efficiency makes Bullhorn an invaluable tool for recruitment agencies aiming to optimize their operations and achieve better results.

A key feature of Bullhorn's offering is its robust Bullhorn API, which allows for seamless integration with other software systems. This API enables businesses to customize their recruitment processes further and integrate Bullhorn's functionalities with existing tools and platforms. By utilizing the Bullhorn API, companies can enhance their data management capabilities, improve communication between different systems, and create a more cohesive recruitment ecosystem. This integration potential is a significant advantage for organizations looking to tailor their recruitment strategies to meet specific business needs.

Key highlights of Bullhorn APIs

Easy Data Access:
- Facilitates straightforward access to Bullhorn's data for seamless integration.
Automation:
- Supports workflow automation to boost productivity and efficiency.
Custom Integration:
- Allows for tailored integrations to meet specific business needs.
Real-Time Sync:
- Ensures up-to-date information across systems with real-time data synchronization.
Strong Security:
- Prioritizes data protection and secure transactions.
Scalable:
- Accommodates the needs of both small and large organizations.
Developer-Friendly:
- Offers comprehensive documentation and support for developers.
Global Support:
- Provides assistance to users worldwide.
Error Handling and Logging:
- Includes features for troubleshooting and maintaining system integrity.
Rate Limiting:
- Implements rate limiting for fair use and system stability.
Version Control:
- Supports version control for effective management of changes and updates.
Data Transformation:
- Enables data formatting and processing as needed.
Webhook Support:
- Allows for event-driven communication and integration.
Detailed Analytics and Reporting:
- Offers insights into data and operations through analytics and reporting.
Sandbox Environment:
- Provides a testing environment for development without affecting live data.

Bullhorn API Endpoints

Candidate Management

PUT and PUT {base_url}/entity/Candidate and {base_url}/entity/JobSubmission : Create Candidate and Associate with Job Order
PUT {base_url}/entity/Candidate/{candidateId} : Attach Documents to Candidate's Application
GET {base_url}/entity/Candidate/{candidateId}/fileAttachments : Retrieve All Documents Linked to a Candidate Application

Job Submission

POST {base_url}/entity/JobSubmission/{applicationId} : Create Candidate Note
GET {base_url}/query/JobSubmission : Retrieve Job Application Details
GET and GET {base_url}/query/JobSubmission and {base_url}/entity/Appointment/{appointment_id} : Retrieve All Interview Details for an Application
GET {base_url}/search/JobSubmission : Retrieve All Job Applications

Job Order

GET {base_url}/query/JobOrder : Retrieve JobOrder Details
GET {base_url}/search/JobOrder : Retrieve List of Job Orders

Bullhorn API FAQs

How do I get started with the Bullhorn REST API?

Answer: To begin using the Bullhorn REST API:some text
1. Obtain OAuth 2.0 credentials by registering your application with Bullhorn.
2. Use these credentials to authenticate and receive an access token.
3. Make a login call to the REST API using the access token to obtain a session token (BhRestToken) and a base REST URL for subsequent API requests.
Source: Get Started with the Bullhorn REST API

What authentication method does the Bullhorn API use?

Answer: The Bullhorn API utilizes OAuth 2.0 for authentication. After obtaining an access token through the OAuth flow, you perform a REST API login call to receive a session token (BhRestToken) and a base REST URL for further API interactions.
Source: Get Started with the Bullhorn REST API

Are there rate limits for the Bullhorn API?

Answer: Yes, Bullhorn enforces rate limits to ensure fair usage. While specific limits are not publicly documented, it's recommended to implement error handling for potential 429 Too Many Requests responses and to contact Bullhorn support for detailed rate limit information.
Source: API Documentation - Bullhorn API Support Forums

Can I retrieve candidate information using the Bullhorn API?

Answer: Yes, you can retrieve candidate information by making a GET request to the /entity/Candidate/{id} endpoint, where {id} is the candidate's unique identifier. You can specify which fields to return using the fields query parameter.
Source: API Reference - GitHub Pages

Does the Bullhorn API support webhooks for real-time data updates?

Answer: As of the latest available information, the Bullhorn API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
Source: API Documentation - Bullhorn API Support Forums

Get Started with Bullhorn API Integration

Knit API offers a convenient solution for quick and seamless integration with Bullhorn API. Our AI-powered integration platform allows you to build any Bullhorn API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, CRM, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Bullhorn API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Zoho Desk API Directory

Zoho Desk is a powerful, cloud-based customer service software designed to streamline support operations and enhance customer satisfaction. As part of the Zoho suite, Zoho Desk empowers businesses to manage customer queries across multiple channels—email, social media, chat, and more—through a unified platform. It offers features like ticket management, workflow automation, and detailed analytics, helping support teams stay organized and efficient.

‍

With the Zoho Desk API, developers can take things a step further by connecting Zoho Desk with other tools, automating tasks, and customizing workflows.

‍

Key highlights of Zoho Desk API are as follows -

Multi-Channel Ticket Management: These APIs help you to access and manage tickets from multiple channels, like email, chat, and social media, through a single API.
Workflow Automation: These endpoints can automate repetitive tasks, such as ticket assignments and status updates, to improve response times and team efficiency.
Custom Integrations: These APIs help to connect Zoho Desk with other apps, CRMs, or systems to create a unified customer support experience.
Advanced Reporting: These APIs help to retrieve data for performance tracking, including response times, ticket trends, and customer satisfaction metrics.
Custom Fields and Modules: These APIs help to extend Zoho Desk functionality with custom fields and modules tailored to your business needs.
Real-Time Updates: These APIs can be used to get instant notifications for ticket changes, comments, and other updates using webhooks.
Secure Authentication: Zoho Desk APIs use OAuth 2.0 for secure access, ensuring data safety and privacy.

‍

In this article, we’ll explore the key Zoho Desk API endpoints and how they can provide flexibility to build powerful, custom solutions that enhance your customer service capabilities.

‍

Zoho Desk API Endpoints

Zoho Desk APIs make it easy to connect with other Zoho apps and external tools by using RESTful principles. With these APIs, you can automatically get and update data in various parts of Zoho Desk, like Tickets, Contacts, and Accounts. All the APIs follow standard HTTP rules and use error codes for better understanding.

‍

Here are the most commonly used Zoho Desk API endpoints -

‍

Organizations

GET /api/v1/organizations/{organization_Id}
GET /api/v1/organizations
GET /api/v1/accessibleOrganizations
PATCH /api/v1/organizations/{organization_Id}
GET /api/v1/organizations/{organization_Id}/logo
GET /api/v1/organizations/{organization_Id}/favicon
POST /api/v1/organizations/{organization_Id}/logo
POST /api/v1/organizations/{organization_Id}/favicon
DELETE /api/v1/organizations/{organization_Id}/logo
DELETE /api/v1/organizations/{organization_Id}/favicon
POST /api/v1/organizations/markDefault

Agents

GET /api/v1/agents/{agent_id}
GET /api/v1/agents
GET /api/v1/agents/count
GET /api/v1/agentsByIds?agentIds={agent_ids}
GET /api/v1/myinfo
POST /api/v1/agents/activate
POST /api/v1/agents/{agent_id}/deactivate
POST /api/v1/agents/reinvite
POST /api/v1/agents
PATCH /api/v1/agents/{agent_id}
POST /api/v1/agents/deleteUnconfirmed
POST /api/v1/agents/{agent_id}/delete
POST /api/v1/deletedAgents/{agent_id}/anonymize
POST /api/v1/uploadMyPhoto
GET /api/v1/agents/{agent_id}/photo?orgId={org_id}
POST /api/v1/deleteMyPhoto
GET /api/v1/myPreferences
PATCH /api/v1/myPreferences
GET /api/v1/agents/email/{email}
POST /api/v1/agents/{agent_id}/reassignment

Profiles

GET /api/v1/profiles
GET /api/v1/profiles/count
GET /api/v1/profiles/{profile_id}
POST /api/v1/profiles/{profile_id}/clone
PATCH /api/v1/profiles/{profile_id}
POST /api/v1/profiles/{profile_id}/delete
GET /api/v1/myProfile
GET /api/v1/myProfilePermissions
GET /api/v1/profiles/{profile_id}/agents
GET /api/v1/lightAgentProfile

Roles

GET /api/v1/roles
GET /api/v1/roles/{role_id}/agents
POST /api/v1/roles
PATCH /api/v1/roles/{role_id}
POST /api/v1/roles/{role_id}/delete
GET /api/v1/roles/{role_id}
GET /api/v1/roles/count
GET /api/v1/personalRole
GET /api/v1/rolesByIds

Teams

POST /api/v1/teams
PATCH /api/v1/teams/{team_id}
POST /api/v1/teams/{team_id}/deleteTeam
GET /api/v1/teams/{team_id}
GET /api/v1/teams
GET /api/v1/teams/{team_id}/members
GET /api/v1/teams/{team_id}/associables
GET /api/v1/agents/{agent_id}/teams
GET /api/v1/roles/{role_id}/teams
GET /api/v1/departments/{department_id}/teams

Departments

GET /api/v1/departments/{department_id}
GET /api/v1/departments
GET /api/v1/departments/{department_id}/agents
GET /api/v1/departments/count
GET /api/v1/departmentsByIds?departmentIds={department_ids}
GET /api/v1/departments/checkExists
POST /api/v1/departments
PATCH /api/v1/departments/{department_id}
POST /api/v1/departments/{department_id}/disable
POST /api/v1/departments/{department_id}/enable
POST /api/v1/departments/{department_id}/associateAgents
POST /api/v1/departments/{department_id}/dissociateAgents
GET /api/v1/departments/{department_id}/logo
POST /api/v1/departments/{department_id}/logo
DELETE /api/v1/departments/{department_id}/logo

Channels

GET /api/v1/channels

Tickets

GET /api/v1/tickets/{ticket_id}
GET /api/v1/tickets
GET /api/v1/tickets/archivedTickets
GET /api/v1/associatedTickets
POST /api/v1/tickets
PATCH /api/v1/tickets/{ticket_id}
POST /api/v1/tickets/moveToTrash
POST /api/v1/tickets/deleteSpam
POST /api/v1/tickets/{ticket_id}/merge
POST /api/v1/tickets/{ticket_id}/move
POST /api/v1/tickets/{ticket_id}/threads/{thread_id}/split
POST /api/v1/tickets/updateMany
POST /api/v1/closeTickets
POST api/v1/tickets/{ticket_id}/markAsRead
POST api/v1/tickets/{ticket_id}/markAsUnRead
POST /api/v1/tickets/markSpam
GET api/v1/ticketQueueView/count
GET api/v1/agentsTicketsCount
GET api/v1/tickets/{ticket_id}/History
GET api/v1/tickets/{ticket_id}/resolution
GET api/v1/tickets/{ticket_id}/resolutionHistory
PATCH api/v1/tickets/{ticket_id}/resolution
DELETE api/v1/tickets/{ticket_id}/resolution
GET /api/v1/tickets/([0-9]+)/metrics
POST /api/v1/tickets/emptySpam
POST /api/v1/tickets/{ticket_id}/executeSkillbasedAssignment
POST /api/v1/tickets/{ticket_id}/recalculateSkills
GET /api/v1/tickets/{ticket_id}/articleSuggestion

Thread

GET /api/v1/tickets/{ticket_id}/threads/{thread_id}
GET /api/v1/tickets/{ticket_id}/threads/{thread_id}/originalContent
GET /api/v1/tickets/{ticket_id}/latestThread
POST /api/v1/tickets/{ticket_id}/threads/{thread_id}/sendForReview
GET /api/v1/tickets/{ticket_id}/threads
GET /api/v1/tickets/{ticket_id}/conversations
POST /api/v1/tickets/{ticket_id}/sendReply
POST /api/v1/tickets/{ticket_id}/draftReply
PATCH /api/v1/tickets/{ticket_id}/draftReply/{thread_id}
DELETE /api/v1/tickets/{ticket_id}/threads/{thread_id}/attachments/{attachment_id}

Contacts

GET /api/v1/contacts/{contact_id}
GET /api/v1/contacts
POST /api/v1/contacts
PATCH /api/v1/contacts/{contact_id}
POST /api/v1/contacts/moveToTrash
POST /api/v1/contacts/deleteSpam
GET /api/v1/contacts/{contact_id}/profiles
POST /api/v1/contacts/updateMany
GET /api/v1/contacts/contactsByIds
GET /api/v1/contacts/{contact_id}/tickets
GET /api/v1/contacts/{contact_id}/products
GET api/v1/contacts/count
GET /api/v1/contacts/{contact_id}/statistics
POST /api/v1/contacts/{contact_id}/merge
POST /api/v1/contacts/markSpam
POST api/v1/contacts/{contact_id}/associateProducts
GET api/v1/contacts/{contact_id}/history
POST api/v1/contacts/inviteAsEndUser
POST api/v1/contacts/{contact_id}/inviteAsEndUser
DELETE api/v1/contacts/{contact_id}/photo
GET api/v1/contacts/{contact_id}/helpCenters
GET /api/v1/contacts/{contact_id}/accounts
POST api/v1/contacts/{contact_id}/associateAccounts
POST api/v1/contacts/{contact_id}/dissociateAccounts
POST /api/v1/contacts/{contact_id}/approveEndUserInvite
POST /api/v1/contacts/{contact_id}/rejectEndUserInvite

Accounts

GET /api/v1/accounts/{account_id}
GET /api/v1/accounts
POST /api/v1/accounts
PATCH /api/v1/accounts/{account_id}
POST /api/v1/accounts/moveToTrash
GET /api/v1/accounts/{account_id}/contracts
GET api/v1/contracts/count
GET api/v1/accounts/count
GET api/v1/accounts/{accounts_id}/contacts?from={from}&limit={limit}&sortBy={sortingField}
GET /api/v1/accounts/{account_id}/tickets
GET /api/v1/accounts/{account_id}/products
POST /api/v1/accounts/{account_id}/merge
POST api/v1/accounts/{account_id}/associateProducts
POST /api/v1/accounts/updateMany
GET api/v1/accounts/{account_id}/history
GET /api/v1/accounts/([0-9]+)/statistics
GET /api/v1/accounts/{account_id}/sla
POST /api/v1/accounts/{account_id}/sla/{sla_id}

Account Contact Mapping

PATCH /api/v1/accountContactMapping/{mapping_id}

Tasks

GET /api/v1/tasks/{task_id}
GET /api/v1/tasks
POST /api/v1/tasks
PATCH /api/v1/tasks/{task_id}
POST /api/v1/tasks/moveToTrash
POST /api/v1/tasks/deleteSpam
GET /api/v1/tickets/{ticket_id}/tasks
GET /api/v1/tasks/count
POST /api/v1/tasks/updateMany
POST /api/v1/tasks/emptySpam

Products

GET /api/v1/products/{product_id}
GET /api/v1/products
POST /api/v1/products
GET /api/v1/products/{product_id}/tickets
PATCH /api/v1/products/{product_id}
POST /api/v1/products/moveToTrash
GET /api/v1/products/searchDuplicates
POST api/v1/products/{product_id}/associateContacts
POST api/v1/products/{product_id}/associateAccounts
GET api/v1/products/{products_id}/accounts
GET api/v1/products/{products_id}/contacts

Users

GET /api/v1/users
GET /api/v1/users/{user_id}
PATCH /api/v1/users/{user_id}
POST api/v1/users/{user_id}/anonymize
GET /api/v1/users/{user_id}/groups
POST /api/v1/users/{user_id}/groups/associate
POST /api/v1/users/{user_id}/groups/dissociate
GET /api/v1/users/{user_id}/labels
POST /api/v1/users/{user_id}/labels/assign
POST /api/v1/users/{user_id}/labels/remove
GET /api/v1/users/([0-9]+)/badges
POST /api/v1/users/{user_id}/badges/associate
POST /api/v1/users/{user_id}/badges/dissociate

Contracts

GET api/v1/contracts/{{contract_id}}
GET api/v1/contracts
POST /api/v1/contracts
PATCH /api/v1/contracts/{contract_id}
POST api/v1/contracts/moveToTrash
POST /api/v1/contracts/updateMany

Upload

POST /api/v1/uploads

Activities

GET /api/v1/tickets/{ticket_id}/activities
POST /api/v1/activities/emptySpam

Calls

GET api/v1/calls/{call_id}
GET api/v1/calls
POST api/v1/calls
PATCH api/v1/calls/{call_id}
GET /api/v1/tickets/{ticket_id}/calls
POST /api/v1/calls/moveToTrash
POST /api/v1/calls/deleteSpam
POST /api/v1/calls/{call_id}/clearLiveCall
POST /api/v1/calls/updateMany
POST /api/v1/calls/emptySpam

Events

GET api/v1/events/{event_id}
GET api/v1/events
POST api/v1/events
PATCH api/v1/events/{event_id}
GET /api/v1/tickets/{ticket_id}/events
POST /api/v1/events/moveToTrash
POST /api/v1/events/deleteSpam
POST /api/v1/events/updateMany
POST /api/v1/events/emptySpam

Skills

POST /api/v1/skills
GET /api/v1/skills/{skillId}
PATCH /api/v1/skills/{skillId}
DELETE /api/v1/skills/{skillId}
GET /api/v1/skills
GET /api/v1/skills/{skillId}/relatedRules
POST /api/v1/skills/order
GET /api/v1/agents/{agentId}/skills
POST /api/v1/agents/{agentId}/mapSkills
GET /api/v1/skills/criteriaFields

Subscriptions

GET /subscriptions
POST /subscriptions
GET /subscriptions/{subscriptionId}
PUT /subscriptions/{subscriptionId}
DELETE /subscriptions/{subscriptionId}

Time Entries

GET /timeentries
POST /timeentries
GET /timeentries/{entryId}
PUT /timeentries/{entryId}
DELETE /timeentries/{entryId}

Here’s a detailed reference to all the Zoho Desk API Endpoints.

‍

Zoho Desk API FAQs

Here are the frequently asked questions about Zoho Desk APIs to help you get started:

What is the usage limit of Zoho API? Answer
How does the get Ticket History API work? Answer
What are the events supported in the Get Ticket History API? Answer
How to authenticate calls from a Zoho Desk Extension using a custom API key? Answer
How to get Access Token for Client Based Application for Zoho API? Answer

Find more FAQs here.

‍

‍Get started with Zoho Desk API

To access the Zoho Desk API, you'll need a Zoho account and an API key, which you can obtain from the Zoho Developer Console. After logging into your Zoho account, navigate to the API Console to create a new client and get your client ID and client secret. Zoho Desk uses OAuth 2.0 for secure authentication, so you’ll authorize the app to generate access tokens. Once authenticated, you’ll have access to Zoho Desk’s API endpoints to start building and integrating with your applications.

‍

If you’re looking for a quick way to connect multiple customer service or CRM systems, consider using Knit—a single API solution that integrates with major platforms, streamlining your setup and reducing development time. To sign up for free, click here. To check the pricing, see our pricing page.

‍

BambooHR API Directory

This guide is part of our growing collection on HRIS integrations. We’re continuously exploring new apps and updating our HRIS Guides Directory with fresh insights.

BambooHR is a leading cloud-based human resources software platform tailored for small to medium-sized businesses. It streamlines HR functions by offering a comprehensive suite of features such as employee data management, an applicant tracking system, onboarding tools, time-off management, performance management, and robust reporting and analytics. By centralizing these HR processes, BambooHR significantly reduces the administrative burden on HR teams, thereby enhancing overall productivity and efficiency.

Looking to dive deep into how BambooHR API works? Check our detailed BambooHR API Guide to learn more on BambooHR authentication, best practices and more.

One of the standout features of BambooHR is its employee self-service portal, which empowers employees to manage their own information, request time off, and access important documents, thereby fostering a more engaged and autonomous workforce. Additionally, the BambooHR API plays a crucial role in integrating this platform with other business systems, ensuring seamless data flow and enhancing the functionality of existing HR processes. In the following sections, we will delve deeper into the BambooHR API integration process and explore how it can be leveraged to optimize HR operations.

Key highlights of BambooHR APIs

Easy Data Access
- Allows interaction with core HR data for retrieval and updates.

Automation
- Supports automation through programmatic access to data and operations.

Real-Time Sync
- Supports webhooks for real-time notifications of actions.

Strong Security
- Provides detailed data access control.

Scalable
- Designed to handle requests efficiently with rate limiting.

Developer-Friendly
- RESTful API, familiar to developers.

Error Handling and Logging
- Requires handling of 503 Service Unavailable responses.

Detailed Analytics and Reporting
- Part of BambooHR's platform features.

Sandbox Environment
- Often provided for testing purposes.

BambooHR API Endpoints

Benefits

GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/benefits/settings/deduction_types/all : Get Benefit Deduction Types

Employee Dependents

GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employeedependents : Get All Employee Dependents
PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employeedependents/{id} : Update An Employee Dependent

Employees

POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/ : Add Employee to BambooHR
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/changed : Gets All Updated Employee Ids
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/changed/tables/{table} : Gets All Updated Employee Table Data
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/files/categories : Add Employee File Category
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/photo : Store A New Employee Photo
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/photo/{size} : Get An Employee Photo
PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/time_off/balance_adjustment/ : Adjust Time Off Balance
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/time_off/calculator : Estimate Future Time Off Balances
PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/time_off/history/ : Add A Time Off History Item For Time Off Request
PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/time_off/policies : Assign Time Off Policies For An Employee
PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{employeeId}/time_off/request : Add A Time Off Request
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/ : Update Employee
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/files : Upload Employee File
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/files/view/ : List Employee Files and Categories
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/files/{fileId} : Update Employee File
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/tables/employmentStatus : Terminate Employee by Adding Row to Employment Status Table
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/tables/{table} : Adds A Table Row
DELETE https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/employees/{id}/tables/{table}/{rowId} : Deletes A Table Row

Company Files

POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/files : Upload Company File
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/files/categories : Add Company File Category
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/files/view/ : List Company Files And Categories
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/files/{fileId} : Update Company File

Login

POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/login : User Login

Performance

GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals : Get Goals for an Employee
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/aggregate : Get All Aggregate Goal Info
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/alignmentOptions : Alignable Goal Options
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/canCreateGoals : Can Create A Goal
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/filters : Get Goal Status Counts
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/shareOptions : Available Goal Sharing Options
PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId} : Update Goal
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/aggregate : Get Aggregate Goal Info
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/close : Close Goal
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/comments : Get Goal Comments
DELETE https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/comments/{commentId} : Delete Goal Comment
PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/progress : Update Goal Progress
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/reopen : Reopen A Goal
PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/performance/employees/{employeeId}/goals/{goalId}/sharedWith : Update Goal Sharing

Reports

POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/reports/custom : List all employees
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/reports/{id} : Get Company Report

Time Off

GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_off/requests/ : Get Time Off Requests
PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_off/requests/{requestId}/status : Change A Request Status
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_off/whos_out/ : Get A List Of Who's Out

Time Tracking

POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/clock_entries/delete : Delete Timesheet Clock Entries
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/clock_entries/store : Add or Edit Timesheet Clock Entries
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/employees/{employeeId}/clock_in : Add Timesheet Clock-in Entry
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/employees/{employeeId}/clock_out : Add Timesheet Clock-out Entry
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/employees/{employeeId}/projects : Get Employee Projects
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/hour_entries/delete : Delete Timesheet Hour Entries
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/hour_entries/store : Add or Edit Timesheet Hour Entries
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/projects : Create A Time Tracking Project
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/time_tracking/timesheet_entries : Get Timesheet Entries
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/timetracking/add : Add An Hour Record
PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/timetracking/adjust : Edit An Hour Record
DELETE https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/timetracking/delete/{id} : Delete An Hour Record
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/timetracking/record : Bulk Add or Edit Hour Records
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/timetracking/record/{id} : Get an Hour Record

Training

GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/training/category : List Training Categories
DELETE https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/training/category/{trainingCategoryId} : Delete Training Category
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/training/record/employee/{employeeId} : List Employee Trainings
DELETE https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/training/record/{employeeTrainingRecordId} : Delete Employee Training Record
POST https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/training/type : Add Training Type
PUT https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/training/type/{trainingTypeId} : Update Training Type

Webhooks

GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/webhooks/ : Gets List Of Webhooks For The User API Key
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/webhooks/monitor_fields : Get Monitor Fields
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/webhooks/{id}/ : Get Webhook
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/webhooks/{id}/log : Get Webhook Logs

Version 1.1

GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1_1/employees/{employeeId}/time_off/policies : Assign Time Off Policies For An Employee
GET https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1_1/performance/employees/{employeeId}/goals/filters : Get Goal Status Counts Version 1.1

Looking for an example on how to use the above APIs to build a BambooHR integration? Check our guide to get employee dependent data from BambooHR

BambooHR API FAQs

How do I generate an API key in BambooHR?
- Answer: To generate an API key in BambooHR, log in to your account and click your name in the upper right-hand corner to access the user context menu. If you have sufficient permissions, select "API Keys" from the menu. On the API Keys page, click "Add New Key," provide a name for the key, and then click "Generate Key." Once generated, copy the key and store it securely, as it will not be displayed again.
- Source: Getting Started With The API - BambooHR
What authentication method does the BambooHR API use?
- Answer: The BambooHR API uses HTTP Basic Authentication. When making API requests, use the API key as the username and any random string as the password. Include these credentials in the 'Authorization' header of your HTTP requests.
- Source: Getting Started With The API - BambooHR
Are there rate limits for the BambooHR API?
- Answer: Yes, the BambooHR API enforces rate limits to ensure fair usage and system stability. If requests are deemed too frequent, the API may throttle them, resulting in a 503 Service Unavailable response. It's recommended to implement error handling in your application to manage such responses appropriately.
- Source: Technical Overview - BambooHR
Can I retrieve employee data using the BambooHR API?
- Answer: Yes, you can retrieve employee data using the BambooHR API. To get data for a specific employee, make a GET request to the endpoint /v1/employees/{id}/, where {id} is the employee's ID. You can specify which fields to retrieve by including a comma-separated list of field names in the fields query parameter.
- Source: Get Employee - BambooHR
Does the BambooHR API support webhooks?
- Answer: As of the latest available information, BambooHR supports two types of webhooks - global and permissioned. Global webhooks work on a subset of fields with open access while permissioned webhooks enable all fields but access is restricted via access control. You can also use third party service providers like Knit which provide virtual webhooks even for fields not supported natively by the BambooHR API for webhook functinality.‍
- Source: Webhooks - BambooHR

Get Started with BambooHR API Integration

For quick and seamless integration with BambooHR API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any BambooHR API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, HRIS, Payroll and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to BambooHR API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

Lever API Directory

Lever is a talent acquisition platform that helps companies simplify and improve their hiring process. With tools for tracking applicants and managing relationships, Lever makes it easy for teams to attract, engage, and hire the best talent. Its user-friendly design and smart features help companies of all sizes make better hiring decisions while improving the candidate experience.

‍

Lever also offers APIs that allow businesses to integrate the platform with their existing systems. These APIs automate tasks like syncing candidate data and managing job postings, making the hiring process more efficient and customizable.

‍

Key highlights of Lever APIs are as follows:

Seamless Integration: Easily connects with existing HR systems, CRMs, and other tools to streamline recruitment workflows.
Automation: Automates tasks such as syncing candidate data, managing job postings, and updating applicant status in real time.
Custom Endpoints: Provides flexible endpoints for candidates, jobs, opportunities, and interviews, allowing for tailored solutions.
Real-time Data: Offers real-time updates, ensuring your recruitment process stays up to date with minimal manual effort.
Well-documented: Comes with comprehensive documentation to help developers quickly build and maintain custom integrations.
Scalable: Supports businesses of all sizes, from startups to enterprises, helping them automate and improve their hiring processes.

This article will provide an overview of the Lever API endpoints. These endpoints enable businesses to build custom solutions, automate workflows, and streamline HR operations.

‍

Lever API Endpoints

Here are the most commonly used API endpoints in the latest version -

Opportunities

POST /opportunities : The 'Create an opportunity' API endpoint allows integrations to create candidates and opportunities in a Lever account. It supports both JSON and multipart/form-data requests, enabling the inclusion of candidate information and resume files. The API deduplicates candidates based on email and links new opportunities to existing contacts if a match is found. It accepts various parameters such as perform_as, parse, and perform_as_posting_owner, and fields like name, headline, stage, location, phones, emails, links, tags, sources, origin, owner, followers, resumeFile, files, postings, createdAt, archived, and contact. The response includes the opportunity ID, status, and a message indicating the result of the request.
POST /opportunities/:opportunity/addLinks : The 'Update Contact Links by Opportunity' API allows users to add or remove links associated with a contact through a specified opportunity. The API requires the opportunity ID as a path parameter and accepts an optional 'perform_as' parameter to perform the update on behalf of a specified user. The body of the request must include an array of links to be added or removed. The response includes a status and a message indicating the result of the operation.
POST /opportunities/:opportunity/addSources : The 'Update Opportunity Sources' API allows users to add or remove sources from a specified opportunity. The API requires the opportunity ID as a path parameter and an array of sources in the request body. Optionally, the request can include a 'perform_as' header to specify the user on whose behalf the operation is performed. The response indicates whether the operation was successful and provides a descriptive message.
POST /opportunities/:opportunity/addTags : The Update Opportunity Tags API allows users to add or remove tags from a specified opportunity. The API requires the opportunity ID as a path parameter. Users can optionally specify a 'perform_as' parameter to perform the update on behalf of another user. The request body must include an array of tags to be added or removed. The response indicates whether the operation was successful and provides a message detailing the result.
PUT /opportunities/:opportunity/archived : This API updates the archived state of an Opportunity. If the Opportunity is already archived, the archive reason can be changed, or it can be unarchived by specifying null as the reason. If the Opportunity is active, it will be archived with the provided reason. The API accepts an optional 'perform_as' header to perform the update on behalf of a specified user. The request body requires a 'reason' for archiving, and optionally accepts 'cleanInterviews' to remove pending interviews and 'requisitionId' to hire a candidate against a specific requisition. The response includes the status of the operation, a message, and details of the updated opportunity.
POST /opportunities/:opportunity/files : The 'Upload a Single File' API endpoint allows users to upload a file to a specified opportunity. The request must be made using the POST method to the '/opportunities/:opportunity/files' URL, where ':opportunity' is the ID of the opportunity. The request must include a 'perform_as' query parameter to specify the user on whose behalf the upload is performed. The file must be included in the request body as a binary file with a maximum size of 30MB, and the request must be of type 'multipart/form-data'. Upon successful upload, the API returns a response containing details of the uploaded file, including its ID, download URL, extension, name, upload timestamp, status, and size. In case of an error, such as a timeout, an error response with a code and message is returned.
DELETE /opportunities/:opportunity/files/:file : The 'Delete a file' API endpoint allows for the deletion of a specified file associated with an opportunity. The request must include the 'perform_as' header to specify the user on whose behalf the operation is performed. The endpoint requires the 'opportunity' and 'file' path parameters to identify the specific file to be deleted. An optional 'offset' query parameter can be used to skip a number of items before starting to collect the result set for pagination. Upon successful deletion, the API returns a 204 No Content response, indicating that the file has been successfully removed. The response includes details of the user who created the file. Note that the endpoint via /candidates/ is deprecated, and it is recommended to use the /opportunities/ endpoint for this operation.
PUT /opportunities/:opportunity/stage : The 'Update Opportunity Stage' API allows users to change the current stage of a specified opportunity. The endpoint requires the opportunity's unique identifier as a path parameter. Optionally, the update can be performed on behalf of another user by providing their identifier in the 'perform_as' query parameter. The request body must include the new stage ID for the opportunity. The response indicates whether the update was successful and provides a message with additional information.
GET /opportunities/deleted : The 'List Deleted Opportunities' API endpoint allows users to retrieve a list of all deleted opportunities from their Lever account. The endpoint supports filtering by the timestamp of deletion using the optional query parameters 'deleted_at_start' and 'deleted_at_end'. If 'deleted_at_start' is provided, the API returns opportunities deleted from that timestamp onwards. If 'deleted_at_end' is provided, it returns opportunities deleted up to that timestamp. The response includes an array of deleted opportunities, each with a unique 'opportunity_id' and the 'deleted_at' timestamp.

Archive Reasons

GET https://api.lever.co/v1/archive_reasons : The 'List all archive reasons' API endpoint allows users to retrieve a list of all archive reasons from their Lever account. The endpoint supports filtering by the type of archive reason, which can be either 'hired' or 'non-hired'. The request requires basic authentication using an API key. The response includes a list of archive reasons, each with an ID, text description, status (active or inactive), and type (hired or non-hired).
GET https://api.lever.co/v1/archive_reasons/:archive_reason : The 'Retrieve a Single Archive Reason' API endpoint allows users to fetch details of a specific archive reason by its unique identifier. The request requires an API key for authentication and the archive reason ID as a path parameter. The response includes the archive reason's ID, description, status, and type.

Audit Events

GET https://api.lever.co/v1/audit_events : The 'List all audit events' API retrieves all audit events from your Lever account, sorted in descending chronological order. It supports filtering by event type, user ID, target type, target ID, and creation timestamps. The response includes detailed information about each event, such as the event ID, creation time, type, user details, target details, and additional metadata.

Contacts

GET https://api.lever.co/v1/contacts/:contact : The 'Retrieve a Single Contact' API endpoint allows users to fetch details of a specific contact using their unique identifier. The request requires an API key for authentication, which should be included in the headers. The contact ID is specified as a path parameter. The response includes detailed information about the contact, such as their name, headline, location, email addresses, and phone numbers.

EEO Responses

GET https://api.lever.co/v1/eeo/responses : The 'Retrieve anonymous EEO responses' API endpoint allows users to list anonymous Equal Employment Opportunity (EEO) responses. The API requires an API key for authentication and supports optional query parameters 'fromDate' and 'toDate' to filter the responses by date range. The response includes details such as application timestamps, current stage, gender, race, veteran status, and disability information of the applicants.
GET https://api.lever.co/v1/eeo/responses/pii : This API endpoint retrieves EEO (Equal Employment Opportunity) responses with Personally Identifiable Information (PII) from the Lever platform. It supports optional query parameters such as 'expand' to expand user IDs and posting ID into full objects, 'created_at_start' to specify the start date for retrieving data, and 'created_at_end' to specify the end date. The response includes detailed information about each EEO response, such as application dates, current stage, contact information, gender, race, veteran status, disability status, and more.

Feedback Templates

POST https://api.lever.co/v1/feedback_templates : This API endpoint allows the creation of a feedback template for an account. The request must include the name of the feedback template, instructions, the group UID, and an array of fields. Each field can have various types such as date, currency, multiple-select, and score-system, among others. The fields array must include at least one field of type score-system. The response returns the created feedback template with its unique ID, name, instructions, group details, fields, and timestamps for creation and last update.
DELETE https://api.lever.co/v1/feedback_templates/:feedback_template : The 'Delete a feedback template' API endpoint allows users to delete a specific feedback template associated with their account. This endpoint requires the unique identifier of the feedback template to be specified in the path parameters. Only templates that were created via the 'Create a feedback template' endpoint can be deleted using this endpoint. The request must be authenticated using an API key provided in the headers. Upon successful deletion, the API returns no content.

Form Templates

GET https://api.lever.co/v1/form_templates : This API endpoint retrieves all active profile form templates for an account. It includes all form data such as instructions and fields. The response can be customized to include only specific attributes like id, text, and group using the 'include' query parameter. The API requires an API key for authentication. The response contains details about each form template, including its id, creation and update timestamps, text, instructions, group information, whether it is secret by default, and the fields it contains. Each field has its own id, type, text, description, and whether it is required.
GET https://api.lever.co/v1/form_templates/:form_template : The Retrieve a Profile Form Template API endpoint allows users to fetch a single profile form template by its unique identifier. This endpoint is useful for obtaining a reference template when creating a new profile form. The request requires an API key for authentication and the form template ID as a path parameter. The response includes details such as the template's creation and update timestamps, text description, instructions, group information, and fields with their respective types, descriptions, and requirement status.

Opportunities

GET https://api.lever.co/v1/opportunities : The 'List all opportunities' API endpoint retrieves all pipeline opportunities for contacts in your Lever account. It supports various optional query parameters to filter the results, such as 'include', 'expand', 'tag', 'email', 'origin', 'source', 'confidentiality', 'stage_id', 'posting_id', 'archived_posting_id', 'created_at_start', 'created_at_end', 'updated_at_start', 'updated_at_end', 'advanced_at_start', 'advanced_at_end', 'archived_at_start', 'archived_at_end', 'archived', 'archive_reason_id', 'snoozed', and 'contact_id'. The response includes detailed information about each opportunity, such as 'id', 'name', 'headline', 'contact', 'emails', 'phones', 'confidentiality', 'location', 'links', 'createdAt', 'updatedAt', 'lastInteractionAt', 'lastAdvancedAt', 'snoozedUntil', 'archivedAt', 'archiveReason', 'stage', 'stageChanges', 'owner', 'tags', 'sources', 'origin', 'sourcedBy', 'applications', 'resume', 'followers', 'urls', 'dataProtection', and 'isAnonymized'.
GET https://api.lever.co/v1/opportunities/:opportunity : The 'Retrieve a Single Opportunity' API endpoint allows users to fetch detailed information about a specific opportunity using its unique identifier. The request requires basic authentication using an API key and the opportunity ID as a path parameter. The response includes comprehensive details about the opportunity, such as contact information, confidentiality status, location, associated tags, sources, and data protection settings. It also provides timestamps for creation, updates, interactions, and stage changes, along with URLs for candidate lists and specific candidate views.
POST https://api.lever.co/v1/opportunities/:opportunity/feedback : This API endpoint allows the creation of a feedback form for a specific opportunity. The request requires the opportunity ID as a path parameter and the user ID to perform the action on behalf of as a query parameter. The request body must include the base template ID and can optionally include panel and interview IDs, field values, and timestamps for creation and completion. The response returns the details of the created feedback form, including its fields, associated panel and interview, and timestamps.
PUT https://api.lever.co/v1/opportunities/:opportunity/feedback/:feedback : The Update Feedback API allows you to update a feedback form for a specific opportunity. The endpoint requires the opportunity ID and feedback ID as path parameters. You can perform the update on behalf of a specified user by providing the 'perform_as' query parameter. The request body can include a 'completedAt' timestamp and an array of 'fieldValues' to update specific fields in the feedback form. The response includes detailed information about the updated feedback, including account ID, user ID, profile ID, and the fields with their respective values and options.
GET https://api.lever.co/v1/opportunities/:opportunity/files : The 'List all files for an opportunity' API endpoint allows users to retrieve a list of all files associated with a specific opportunity. The endpoint requires an API key for authentication and the unique identifier of the opportunity as a path parameter. Users can optionally filter the files by their upload timestamp using the 'uploaded_at_start' and 'uploaded_at_end' query parameters. The response includes an array of file objects, each containing details such as the file ID, download URL, extension, name, upload timestamp, processing status, and size.
GET https://api.lever.co/v1/opportunities/:opportunity/files/:file : The Retrieve a Single File API endpoint allows users to retrieve metadata for a specific file associated with an opportunity. The endpoint requires the opportunity ID and file ID as path parameters and uses an API key for authentication. The response includes details such as the file ID, download URL, file extension, name, upload timestamp, status, and size. Note that the endpoint via /candidates/ is deprecated, and users should use the /opportunities/ endpoint for the same response.
GET https://api.lever.co/v1/opportunities/:opportunity/files/:file/download : The 'Download a file' API endpoint allows users to download a file associated with a specific opportunity in Lever. The endpoint requires the opportunity ID and file ID as path parameters, and an API key for authentication in the headers. The response includes the file's binary content and headers indicating the file type and disposition. Note that if the file could not be processed correctly by Lever, a 422 Unprocessable Entity status will be returned.
GET https://api.lever.co/v1/opportunities/:opportunity/forms : This API endpoint retrieves all profile forms associated with a specific opportunity for a candidate. The request requires an API key for authentication and the unique identifier of the opportunity as a path parameter. The response includes details of the form such as its ID, type, text, instructions, base template ID, fields, user, stage, and timestamps for creation, completion, and deletion. Each field in the form has attributes like type, text, description, requirement status, ID, value, and currency if applicable.
GET https://api.lever.co/v1/opportunities/:opportunity/forms/:form : The Retrieve a Profile Form API endpoint allows you to retrieve a specific profile form associated with an opportunity. The endpoint requires the opportunity ID and form ID as path parameters. The response includes detailed information about the form, such as its ID, type, text, instructions, base template ID, fields, user ID, stage ID, and timestamps for when the form was completed, created, and deleted. The fields array contains various types of fields, each with its own properties like type, text, description, required status, ID, value, and currency if applicable.
GET https://api.lever.co/v1/opportunities/:opportunity/interviews : The 'List all interviews for an opportunity' API endpoint retrieves all interview events associated with a specific opportunity. The endpoint requires an API key for authentication and the unique identifier of the opportunity as a path parameter. The response includes detailed information about each interview, such as the interview ID, panel, subject, notes, interviewers, timezone, creation date, interview date, duration, location, feedback templates, feedback forms, feedback reminders, user who scheduled the interview, stage, cancellation timestamp, related postings, and Google Calendar event URL. This endpoint is useful for obtaining a comprehensive list of interviews for a given opportunity.
PUT https://api.lever.co/v1/opportunities/:opportunity/interviews/:interview : The 'Update an Interview' API endpoint allows users to update an existing interview associated with a specific opportunity. This endpoint requires the entire interview object to be present in the PUT request, as missing fields will be deleted. It is important to note that this endpoint cannot be used to update interviews created within the Lever application; only interviews within panels where 'externallyManaged' is true can be updated. The request must include the 'perform_as' query parameter to specify the user on whose behalf the update is performed. The request body should contain details such as the panel ID, subject, note, interviewers, date, duration, location, feedback template, and feedback reminder. The response includes the updated interview details, including the interview ID, panel, subject, note, interviewers, timezone, creation date, duration, location, feedback template, feedback forms, feedback reminder, user, stage, and postings.
GET https://api.lever.co/v1/opportunities/:opportunity/notes : The 'List all notes' API endpoint retrieves all notes associated with a specific opportunity. The endpoint is accessed via a GET request to '/opportunities/:opportunity/notes', where ':opportunity' is the unique identifier for the opportunity. The request requires an API key for authentication. The response includes an array of notes, each with details such as the note ID, text, fields, user, and timestamps for creation, completion, and deletion. The 'hasNext' boolean indicates if there are more notes to fetch. Note that the endpoint via '/candidates/' is deprecated.
GET https://api.lever.co/v1/opportunities/:opportunity/notes/:note : The Retrieve a Single Note API endpoint allows users to fetch a specific note associated with an opportunity using the opportunity and note identifiers. The request requires an API key for authentication and the unique identifiers for both the opportunity and the note as path parameters. The response includes detailed information about the note, such as its text content, associated fields, user information, and timestamps for creation, completion, and deletion. This endpoint is part of the Lever API and is used to access notes related to opportunities.
DELETE https://api.lever.co/v1/opportunities/:opportunity/notes/:noteId : The 'Delete a Note' API endpoint allows users to delete a note associated with a specific opportunity. This endpoint is restricted to notes created via the API and cannot delete notes created within the Lever application. The request requires the opportunity ID and note ID as path parameters, and the API key for authentication in the headers. A successful deletion will result in a 204 No Content response, indicating that the note has been successfully deleted.
GET https://api.lever.co/v1/opportunities/:opportunity/offers : The 'List all offers' API endpoint retrieves all offers associated with a specific opportunity. The endpoint is accessed via a GET request to '/opportunities/:opportunity/offers'. The request requires an API key for authentication, passed in the Authorization header. The 'opportunity' path parameter is mandatory and specifies the unique identifier for the opportunity. An optional query parameter 'expand' can be used to expand the creator ID into a full object in the response. The response includes an array of offer objects, each containing details such as the offer ID, creation timestamp, status, creator ID, and various fields related to the offer. Additionally, information about sent and signed documents is provided, including file names, upload timestamps, and download URLs. The response also indicates if there are more offers to fetch with the 'hasNext' boolean.
GET https://api.lever.co/v1/opportunities/:opportunity/offers/:offer/download : The 'Download Offer File' API allows users to download a specific version of an offer file associated with an opportunity. The endpoint requires the opportunity and offer identifiers as path parameters. An optional query parameter 'status' can be used to specify whether to download the 'sent' or 'signed' version of the offer file. If no status is provided, the most recent document is returned. The API requires an API key for authentication. The response includes a 'downloadUrl' from which the offer file can be downloaded.
POST https://api.lever.co/v1/opportunities/:opportunity/panels : The 'Create a Panel' API endpoint allows users to create a panel and associate it with a specific opportunity. The endpoint requires the opportunity ID as a path parameter and the 'perform_as' user ID as a query parameter. The request body must include the timezone and a non-empty array of interview objects. Optional fields include applications, feedback reminders, notes, and an external URL. The response returns details of the created panel, including its ID, associated applications, interviews, and other metadata.
DELETE https://api.lever.co/v1/opportunities/:opportunity/panels/:panel : This API endpoint deletes a panel associated with a specific opportunity. Only panels with 'externallyManaged' set to true can be deleted via this API. The request requires the opportunity ID and panel ID as path parameters, and a 'perform_as' query parameter to specify the user on whose behalf the delete operation is performed. The API key must be included in the headers for authentication. The endpoint returns a 204 No Content status upon successful deletion. Note that the endpoint via /candidates/ is deprecated, and the /opportunities/ endpoint should be used instead.
GET https://api.lever.co/v1/opportunities/:opportunity/referrals : The 'List all referrals for a candidate for an Opportunity' API endpoint retrieves all referrals associated with a specific opportunity. The endpoint is accessed via a GET request to '/opportunities/:opportunity/referrals', where ':opportunity' is the unique identifier for the opportunity. The request requires an API key for authentication, provided in the headers. The response includes a list of referral objects, each containing details such as the referral ID, type, text, instructions, fields (including referrer name, relationship, and comments), base template ID, user ID, referrer ID, stage, and timestamps for creation and completion. The response also indicates if there are more referrals to fetch with the 'hasNext' boolean.
GET https://api.lever.co/v1/opportunities/:opportunity/referrals/:referral : The 'Retrieve a Single Referral' API endpoint allows users to fetch details of a specific referral associated with a given opportunity. The endpoint requires the opportunity ID and referral ID as path parameters. The response includes detailed information about the referral, such as the referral ID, type, text, instructions, fields (including referrer name, relationship, and comments), base template ID, user ID, referrer ID, stage ID, and timestamps for creation and completion. This endpoint is authenticated using an API key.
GET https://api.lever.co/v1/opportunities/:opportunity/resumes : The 'List all resumes for an opportunity' API endpoint allows users to retrieve all resumes associated with a specific opportunity. The endpoint is accessed via a GET request to the URL 'https://api.lever.co/v1/opportunities/:opportunity/resumes', where ':opportunity' is the unique identifier for the opportunity. The request requires an 'Authorization' header with a Basic authentication API key. Optional query parameters 'uploaded_at_start' and 'uploaded_at_end' can be used to filter resumes by their upload timestamps. The response includes a list of resumes, each with details such as the resume ID, creation timestamp, file information (name, extension, download URL, upload timestamp, status, and size), and parsed data including positions and educational background. The endpoint is designed to provide comprehensive resume data for a given opportunity.
GET https://api.lever.co/v1/opportunities/:opportunity/resumes/:resume : The 'Retrieve a Single Resume' API endpoint allows users to retrieve metadata for a specific resume associated with an opportunity. The endpoint requires the opportunity ID and resume ID as path parameters. The response includes details such as the resume's creation timestamp, file information (name, extension, download URL, upload timestamp, status, and size), and parsed data including positions and educational background. This endpoint is accessed via a GET request and requires an API key for authentication. Note that the endpoint via /candidates/ is deprecated, and users should use the /opportunities/ endpoint for the same response.
GET https://api.lever.co/v1/opportunities/:opportunity/resumes/:resume/download : The 'Download a resume file' API allows users to download a resume file associated with a specific opportunity if it exists. The endpoint requires the opportunity ID and resume ID as path parameters. It uses basic authentication with an API key. The response includes the binary content of the resume file, typically in PDF format, along with headers indicating the content type and disposition. If the file cannot be processed, a 422 Unprocessable Entity status is returned. Note that the endpoint via /candidates/ is deprecated, and users should use the /opportunities/ endpoint instead.

Postings

POST https://api.lever.co/v1/postings : The 'Create a Posting' API endpoint allows integrations to create job postings in a Lever account. This API does not trigger the approvals chain, but postings can be created as drafts and later go through approvals within Lever Hire. The API accepts requests in JSON format and requires a 'perform_as' query parameter to specify the user on whose behalf the posting is created. The request body includes details such as the job title, state, distribution channels, owner, hiring manager, categories, tags, content, workplace type, and requisition codes. The response returns the created posting's details, including its ID, title, timestamps, user information, categories, content, distribution channels, salary details, state, tags, URLs, workplace type, and requisition codes.
GET https://api.lever.co/v1/postings/:posting : The 'Retrieve a Single Posting' API endpoint allows users to fetch the details of a specific job posting, including the job description and associated metadata. The endpoint requires the unique posting ID as a path parameter and optionally accepts a 'distribution' query parameter to specify whether to return internal or external custom application questions. The response includes detailed information about the job posting, such as its title, creation and update timestamps, user and owner details, confidentiality level, categories like team and department, job content including descriptions and lists, location, state, distribution channels, requisition codes, salary details, and URLs for listing, viewing, and applying for the job. The API is authenticated using an API key.
GET https://api.lever.co/v1/postings/:posting/apply : The Retrieve Posting Application Questions API endpoint provides a list of questions included in a job posting's application form. It indicates whether each field is required. The API is accessed via a GET request to the specified URL with the posting ID as a path parameter. The request requires an API key for authentication. The response includes custom questions, EEO questions, personal information fields, and URLs related to the application. Custom questions may include fields like previous work experience and favorite programming language. EEO questions cover topics such as gender, race, veteran status, and disability, with options for each. Personal information fields include full name, email, current company, phone, resume, and additional information. URLs may include LinkedIn, other websites, and GitHub profiles. Note that collecting disability information is only allowed for US contractors, and EEO questions may not be saved if legally restricted.

Requisition Fields

POST https://api.lever.co/v1/requisition_fields : The 'Create a requisition field' API allows users to create a set of requisition field schemas that can be used across their account for any requisition. The API accepts POST requests with a JSON body containing the field identifier, human-readable field name, field type, and optionally, whether the field is required. Fields can be of type 'number', 'text', 'date', 'object', or 'dropdown'. For 'object' type fields, subfields must be specified, and for 'dropdown' type fields, options must be provided. The response includes the created field's details, including its identifier, name, type, and any subfields or options.
PUT https://api.lever.co/v1/requisition_fields/:requisition_field : The 'Update a requisition field' API allows users to update an existing requisition field by sending a PUT request to the specified endpoint. The request must include the full requisition_field object with updated properties in the request body. Any properties not included will be considered deleted. The API requires a Content-Type header set to 'application/json' and an API key for authentication. The response returns the updated requisition field data.
POST https://api.lever.co/v1/requisition_fields/:requisition_field/options : The 'Updating Dropdown Fields' API allows users to append, update, or delete options in a dropdown field without needing to replace the entire object. The API supports POST, PUT, and DELETE methods. The POST method is used to add new options to the dropdown. The request requires a 'Content-Type' header set to 'application/json' and an 'Authorization' header with the API key. The path parameter ':requisition_field' specifies the dropdown field to be updated. The request body contains an array of 'values', each with a 'text' property representing the dropdown option. The response returns the 'id' and 'text' of the newly created option.

Requisitions

GET https://api.lever.co/v1/requisitions : The 'List all requisitions' API endpoint allows users to retrieve a list of requisitions from the Lever platform. Users can filter the requisitions based on various query parameters such as 'created_at_start', 'created_at_end', 'requisition_code', 'status', and 'confidentiality'. The API requires an API key for authentication. The response includes detailed information about each requisition, including its ID, requisition code, name, confidentiality status, creation timestamp, creator ID, headcount details, status, hiring manager, owner, compensation band, employment status, location, internal notes, postings, department, team, offer IDs, approval details, custom fields, and timestamps for closure and updates.
GET https://api.lever.co/v1/requisitions/:requisition : The 'Retrieve a Single Requisition' API endpoint allows users to fetch detailed information about a specific requisition using its unique identifier. The API requires an API key for authentication and the requisition ID as a path parameter. The response includes comprehensive details about the requisition such as its code, name, status, headcount, compensation band, location, department, and more. It also provides information about the approval process, custom fields, and timestamps related to the requisition's lifecycle.

Sources

GET https://api.lever.co/v1/sources : The 'List all sources' API endpoint retrieves a list of all sources in your Lever account. It requires a GET request to the URL 'https://api.lever.co/v1/sources' with basic authentication using an API key. The response includes a JSON object with a 'data' array, where each element contains a 'text' field representing the name of the source and a 'count' field indicating the number of occurrences of that source.

Stages

GET https://api.lever.co/v1/stages : The 'List all stages' API retrieves all pipeline stages available in your Lever account. It requires a GET request to the endpoint 'https://api.lever.co/v1/stages' with basic authentication using an API key. The response includes an array of stages, each with a unique 'id' and a 'text' field representing the name of the stage. This API does not require any path or query parameters, nor does it require a request body.
GET https://api.lever.co/v1/stages/:stage : The 'Retrieve a Single Stage' API endpoint allows users to fetch details of a specific stage using its unique identifier. The request requires an API key for authentication, which should be included in the headers. The stage ID is a path parameter that specifies which stage to retrieve. The response includes the stage's unique identifier and its name or description.

Diversity Surveys

GET https://api.lever.co/v1/surveys/diversity/:posting : The 'Retrieve a diversity survey' API endpoint allows users to retrieve a diversity survey associated with a specific location. The endpoint requires a posting ID as a path parameter and optionally accepts a country code as a query parameter to filter candidate self-select location surveys. If no country code is provided and the account's survey type is set to candidate self-select, all active surveys will be returned. The response includes details such as survey ID, creation and update timestamps, survey text, candidate locations, instructions, and fields with options.

Tags

GET https://api.lever.co/v1/tags : The 'List all tags' API endpoint allows users to retrieve all tags associated with their Lever account. The request requires an API key for authentication, which should be included in the headers. The response returns a list of tags, each with a 'text' field indicating the tag name and a 'count' field indicating the number of times the tag is used.

Uploads

POST https://api.lever.co/v1/uploads : The 'Upload a file' API endpoint allows users to upload files temporarily to be used in conjunction with the 'Apply to a posting' endpoint. This endpoint accepts requests of type 'multipart/form-data' and allows uploading of binary files up to 30MB in size. The uploaded file will be available for 24 hours, after which it cannot be referenced. The response includes details such as the expiration timestamp, filename, unique file ID, URI for accessing the file, and the file size.

Users

POST https://api.lever.co/v1/users : This API endpoint allows integrations to create a user in the Lever account with a default role of Interviewer. Users can also be created with roles such as Limited Team Member, Team Member, Admin, or Super Admin. The request must be of type application/json and include the user's name and email as required fields. Optional fields include accessRole, externalDirectoryId, jobTitle, and managerId. The response includes the user's ID, name, username, email, timestamps for creation and deactivation, external directory ID, access role, photo URL, linked contact IDs, job title, and manager ID.
GET https://api.lever.co/v1/users/:user : The 'Retrieve a Single User' API endpoint allows you to fetch the full user record for a specific user by their user ID. The request requires an API key for authentication, which should be included in the Authorization header. The user ID is specified as a path parameter in the URL. The response includes detailed information about the user, such as their ID, name, username, email, creation and deactivation timestamps, external directory ID, access role, photo URL, linked contact IDs, job title, and manager ID.
POST https://api.lever.co/v1/users/:user/deactivate : The 'Deactivate a user' API allows you to deactivate a user in the Lever system. Deactivated users remain in the system for historical record keeping but can no longer log in and use Lever. The API requires a POST request to the endpoint '/users/:user/deactivate' with the user's unique identifier in the path parameter. The request must include the 'Content-Type' header set to 'application/json' and an 'Authorization' header with the API key. The response includes details of the deactivated user such as their ID, name, username, email, creation and deactivation timestamps, external directory ID, access role, photo URL, linked contact IDs, job title, and manager ID.
POST https://api.lever.co/v1/users/:user/reactivate : The Reactivate a User API allows you to reactivate a user that has been previously deactivated. The endpoint requires a POST request to '/users/:user/reactivate' with the user's unique identifier in the path parameters. The request must include headers for 'Content-Type' as 'application/json' and 'Authorization' with a valid API key. The response returns the user's details including id, name, username, email, creation timestamp, and other relevant information. The 'deactivatedAt' field will be null indicating the user is active.

Webhooks

POST https://api.lever.co/v1/webhooks : The 'Create a Webhook' API allows users to create a new webhook by specifying the webhook URL and event type. The API requires the 'url' and 'event' parameters, while 'configuration', 'conditions', and 'verifyConnection' are optional. Upon successful creation, the API returns a response containing the webhook's unique ID, event type, URL, configuration details including a signature token, and timestamps for creation and last update. A Super Admin must enable the webhook group in account settings for data transmission to commence.
DELETE https://api.lever.co/v1/webhooks/:webhookId : The 'Delete a Webhook' API allows users to delete a specific webhook by its unique identifier. The request requires an API key for authentication, which should be included in the headers. The 'webhookId' is a required path parameter that specifies the webhook to be deleted. Upon successful deletion, the API returns a 204 No Content status, indicating that the webhook has been successfully removed.

‍

Here’s a detailed reference to all the Lever API Endpoints.

‍

Lever API FAQs

Here are the frequently asked questions about Lever APIs to help you get started:

What is the difference between the Lever API and Postings API? Answer
Does the Lever API archive encompass all candidates either rejected or somehow stopped the interview process? Answer
Does each company customize stages in Lever API? Answer
How do I add global tags to a Lever account? Answer
Does each company customize tags in Lever? Answer
What are the rate limits for the Lever API? Answer
How can I get a sandbox account to test the Lever API? Answer

Find more FAQs here.

‍

‍Get started with Lever API

Lever API access is only available for integration after a careful internal review based on your interest. However, if you want to integrate with multiple HRMS or Recruitment APIs quickly, you can get started with Knit, one API for all top HR integrations.

‍

To sign up for free, click here. To check the pricing, see our pricing page.

Breezy API Directory

Breezy software is a cutting-edge recruitment and applicant tracking system designed to revolutionize the hiring process for organizations. By automating essential tasks such as pre-screening candidates, sending emails, scheduling interviews, and collecting feedback, Breezy empowers human resources and recruitment teams to focus on strategic decision-making rather than administrative burdens. This innovative platform serves as a comprehensive solution for streamlining hiring workflows, ensuring that companies can efficiently manage their talent acquisition efforts.

One of the standout features of Breezy is its robust API integration capabilities. The Breezy API allows seamless connectivity with various third-party applications, enabling organizations to customize and enhance their recruitment processes. By leveraging the Breezy API, businesses can integrate their existing HR tools and systems, ensuring a cohesive and efficient hiring ecosystem. This flexibility not only optimizes the recruitment process but also provides a scalable solution that can adapt to the evolving needs of any organization.

Key highlights of Breezy APIs

1. Streamlined Recruitment Processes:
- Automates routine tasks, making recruitment more efficient.
2. Custom Integrations:
- Allows building custom integrations tailored to specific needs.
3. Real-time Updates:
- Provides real-time updates via webhooks for timely decision-making.
4. No-Code Simplicity:
- Enables integration and automation without extensive coding knowledge.
5. Fast Development Speeds:
- Supports rapid development for quick implementation of new features.
6. Hands-On Support:
- Offers support to help users effectively utilize the API.
7. Integration with Multiple Apps:
- Can integrate with a multitude of other applications, enhancing functionality.
8. REST APIs for Recruiting Features:
- Allows integration of recruiting features like managing candidates, jobs, and interviews.
9. Custom Objects and Fields:
- Users can create custom objects, fields, rules, calculations, and views.
10. Unified API for ATS:
- Connects with various applications through a unified API, aiding in closing deals and retaining customers.
11. Automated Workflows:
- Supports automation of workflows, freeing up time for more critical tasks.

Breezy API Endpoints

Company

GET https://api.breezy.hr/v3/companies : Retrieve Companies Associated with Authenticated User
GET https://api.breezy.hr/v3/company/{company_id} : Retrieve Company Information
GET https://api.breezy.hr/v3/company/{company_id}/custom-attributes/candidate : Retrieve Candidate Specific Custom Attributes
GET https://api.breezy.hr/v3/company/{company_id}/custom-attributes/position : Retrieve Position Specific Custom Attributes
GET https://api.breezy.hr/v3/company/{company_id}/questionnaires : Retrieve Company Questionnaires
GET https://api.breezy.hr/v3/company/{company_id}/template/{template_id} : Retrieve Company Email Templates

Position

GET https://api.breezy.hr/v3/company/{company_id}/positions : Retrieve All jobs present in the system.
GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id} : Retrieve Position Details
GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidates : Retrieve Candidates for Given Position
GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/custom-fields : Get Position Custom Fields
PUT https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/custom-fields/{custom_field_id} : Update Position Custom Field
GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/stream : Retrieve Last 30 Activity Stream Events for a Position
GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/team : Retrieve User Objects of All Position Team Members

Candidate

GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id} : Retrieve Candidate by ID for Given Position
GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/assessments : Retrieve Candidate's 3rd Party Assessments
GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/background-checks : Retrieve all 3rd party background checks for candidate
POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/conversation : Add New Conversation Message for Candidate
PUT https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/custom-attribute : Add Custom Attribute to Candidate
GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/custom-fields : Get Candidate Custom Fields
GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/documents : Retrieve Candidate Documents by ID for Given Position
PUT https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/education : Add Education Entry to Candidate
POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/meta : Retrieve Candidate Meta Data by ID for Given Position
POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/questionnaire/{candidate_questionnaire_id} : Save Candidate Responses to a Questionnaire
GET https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/questionnaires : Retrieve Candidate Questionnaires
POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/resume : Attach a Resume File to an Existing Candidate
PUT https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/scorecard : Update Candidate Scorecard for User
POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/send-questionnaire : Create a New Questionnaire for a Candidate
PUT https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/stage : Move Candidate to Specified Stage
POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/stream : Add Note to Candidate's Discussion Stream
PUT https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidate/{candidate_id}/work-history : Add Work History Entry to Candidate
POST https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidates/resume : Upload and Parse Resume to Create Candidate

Pipeline

GET https://api.breezy.hr/v3/company/{company_id}/pipeline/{pipeline_id} : Retrieve Pipeline Stages by Pipeline ID

Questionnaire

GET https://api.breezy.hr/v3/company/{company_id}/questionnaire/{questionnaire_id} : Retrieve Questionnaire by ID

Authentication

POST https://api.breezy.hr/v3/signin : Retrieve Access Token
GET https://api.breezy.hr/v3/signout : Invalidate Access Token

User

GET https://api.breezy.hr/v3/user : Retrieve User Information
GET https://api.breezy.hr/v3/user/details : Retrieve User Company Configuration Details

‍

Breezy API FAQs

How do I obtain API credentials for Breezy HR?

Answer: To obtain API credentials in Breezy HR:some text
1. Log in to your Breezy HR account.
2. Click on the gear icon (⚙️) in the left sidebar to access Company Settings.
3. Navigate to the Integrations section.
4. Locate the API option and click on Settings.
5. Here, you can generate and manage your API keys.

What authentication method does the Breezy HR API use?

Answer: The Breezy HR API utilizes token-based authentication. After generating an API key, include it in the Authorization header of your HTTP requests, formatted as Bearer YOUR_API_KEY.
Source: Breezy API - Developer docs, APIs, SDKs, and auth.

Are there rate limits for the Breezy HR API?

Answer: The official documentation does not specify explicit rate limits for the Breezy HR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
Source: Breezy API - Developer docs, APIs, SDKs, and auth.

Can I retrieve candidate information using the Breezy HR API?

Answer: Yes, you can retrieve candidate information using the Breezy HR API. For example, to list all candidates for a specific position, make a GET request to the /positions/{position_id}/candidates endpoint.

Does the Breezy HR API support webhooks for real-time data updates?

Answer: As of the latest available information, Breezy HR does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
Source: Breezy API - Developer docs, APIs, SDKs, and auth.

Get Started with Breezy API Integration

Knit API offers a convenient solution for quick and seamless integration with Breezy API. Our AI-powered integration platform allows you to build any Breezy API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, CRM, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Breezy API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

HR Cloud API Directory

HR Cloud software is a comprehensive digital platform hosted on the cloud, designed to streamline and enhance human resources functions. It offers a suite of tools and services that assist organizations in managing critical HR tasks such as employee data management, recruitment, onboarding, payroll, and benefits administration. By leveraging HR Cloud software, companies can efficiently handle performance management, time and attendance tracking, learning and development, and compliance reporting. This software is indispensable for HR professionals, managers, and employees across various industries, aiming to optimize workforce management and boost organizational efficiency.

HR Cloud offers a suite of RESTful APIs that enable developers to programmatically access and manage various HR-related data and services within the HR Cloud platform. These APIs facilitate seamless integration with external applications, allowing for operations such as retrieving employee information, managing departments, and handling documents.

Key Features of HR Cloud APIs:

RESTful Architecture: The APIs adhere to REST principles, utilizing standard HTTP methods (GET, POST, PUT, DELETE) for resource manipulation. This design ensures compatibility and ease of integration with various systems. HRCloud Help
JSON Payloads: Data is exchanged in JSON format, providing a lightweight and easily parsable structure for client applications. HRCloud Help
Versioning Support: The APIs support versioning, allowing organizations to adopt new features at their own pace without disrupting existing integrations. HRCloud Help

Core HR API:

The Core HR API provides programmatic access to common HR activities, including:

Employee Management: Retrieve and update employee information, including attachments and forms.
Department and Division Management: Access and modify details of departments and divisions.
Location Management: Manage location data pertinent to the organization.
Task Management: Create and manage tasks assigned to employees.

Detailed documentation for the Core HR API is available, outlining endpoints, request structures, and response formats. HRCloud Help

Employee API:

The Employee API focuses on operations related to employee data, such as:

Retrieving Employee Details: Fetch comprehensive information about employees, including personal and employment-related data.
Creating and Updating Employees: Programmatically add new employees or update existing employee records.

Comprehensive details and usage examples for the Employee API can be found in the official documentation. HR Cloud Support

Authentication and Authorization:

HR Cloud APIs implement robust authentication and authorization mechanisms to ensure secure access. Developers must obtain appropriate credentials and tokens to interact with the APIs, adhering to the security protocols outlined in the documentation. HR Cloud Support

Integration with External Systems:

HR Cloud's APIs facilitate integration with various external systems, such as Microsoft Power Automate, enabling organizations to automate workflows and synchronize HR data across platforms. Microsoft Learn

‍

HR Cloud API Endpoints

Applicant APIs

POST /xApplicant : Create an Applicant
post /xApplicant/Resource : Post XApplicant Resource
GET https://corehr-api.hrcloud.com/v1/cloud/xApplicant : Retrieve Applicants
GET https://corehr-api.hrcloud.com/v1/cloud/xApplicant/:applicantId : Retrieve Single Applicant
PUT https://corehr-api.hrcloud.com/v1/cloud/xApplicant/Upsert : Upsert Applicant

Bonus History APIs

GET https://corehr-api.hrcloud.com/v1/cloud/xBonusHistory : Retrieve Bonus History
GET https://corehr-api.hrcloud.com/v1/cloud/xBonusHistory/:bonusid : Get One Bonus

Department APIs

GET https://corehr-api.hrcloud.com/v1/cloud/xDepartment : GET departments
GET https://corehr-api.hrcloud.com/v1/cloud/xDepartment/:departmentId : GET single department
PUT https://corehr-api.hrcloud.com/v1/cloud/xDepartment/Upsert : Update or Create a Department

Division APIs

GET https://corehr-api.hrcloud.com/v1/cloud/xDivision : GET divisions
PUT https://corehr-api.hrcloud.com/v1/cloud/xDivision/Upsert : PUT division upsert

Employee APIs

POST https://corehr-api.hrcloud.com/v1/cloud/xEmployee : Create Employee with Mapping Parameters
GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId : GET single employee
GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments : Retrieve Employee Attachments
GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments/:attachmentId : Get one attachment of an employee
GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments/download : GET employee attachment download all
GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments/download/:attachmentId : Download Employee Attachment
GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/attachments/download/:attachmentId1,:attachmentId2,... : GET employee attachment download multiple
GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/form/:formType/:formId : Get one form of an employee
GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/forms : Retrieve Employee Forms
GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/forms/download : Download All Employee Forms
GET https://corehr-api.hrcloud.com/v1/cloud/xEmployee/:employeeId/forms/download/:formType1_formId1,:formType2_formId2 : GET employee forms download single or multiple
PUT https://corehr-api.hrcloud.com/v1/cloud/xEmployee/Picture : PUT employee picture
POST https://corehr-api.hrcloud.com/v1/cloud/xEmployee/Resource/Picture : Upload Employee Picture
PUT https://corehr-api.hrcloud.com/v1/cloud/xEmployee/Upsert : PUT employee param upsert

Employment Status History APIs

POST https://corehr-api.hrcloud.com/v1/cloud/xEmploymentStatusHistory : Create Employment Status History
GET https://corehr-api.hrcloud.com/v1/cloud/xEmploymentStatusHistory/:employmentid : Get Employment Status Change Details

Location APIs

PUT https://corehr-api.hrcloud.com/v1/cloud/xLocation : Update Location
GET https://corehr-api.hrcloud.com/v1/cloud/xLocation/:locationId : GET single division
PUT https://corehr-api.hrcloud.com/v1/cloud/xLocation/Upsert : PUT location

Position APIs

POST https://corehr-api.hrcloud.com/v1/cloud/xPosition : Create a Position
GET https://corehr-api.hrcloud.com/v1/cloud/xPosition/:positionId : GET single position
PUT https://corehr-api.hrcloud.com/v1/cloud/xPosition/Upsert : PUT position upsert

Position History APIs

GET https://corehr-api.hrcloud.com/v1/cloud/xPositionHistory : GET position history
GET https://corehr-api.hrcloud.com/v1/cloud/xPositionHistory/:positionid : GET one position history

Rehire History APIs

GET https://corehr-api.hrcloud.com/v1/cloud/xRehireHistory : Retrieve Rehire History
GET https://corehr-api.hrcloud.com/v1/cloud/xRehireHistory/:rehireid : Get One Rehire

Salary History APIs

GET https://corehr-api.hrcloud.com/v1/cloud/xSalaryHistory : Retrieve Salary History
GET https://corehr-api.hrcloud.com/v1/cloud/xSalaryHistory/:salaryid : Get One Salary

Task APIs

GET https://corehr-api.hrcloud.com/v1/cloud/xTask : Retrieve a list of tasks
GET https://corehr-api.hrcloud.com/v1/cloud/xTask/:taskId : GET single task
POST https://corehr-api.hrcloud.com/v1/cloud/xTask/Portal : Create a Plain Task

‍

Get Started with HR Cloud API Integration

Access Documentation: Review the comprehensive API documentation to understand available endpoints and their functionalities. HRCloud Help

Obtain Credentials: Register your application and acquire the necessary authentication credentials as per the guidelines provided. HR Cloud Support

Implement API Calls: Utilize standard HTTP methods to interact with the APIs, ensuring adherence to the request and response formats specified in the documentation.

‍

About Knit

Knit API offers a convenient solution for quick and seamless integration with HR Cloud API. Our AI-powered integration platform allows you to build any HR Cloud API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to HR Cloud API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

Full list of Knit's HRIS API Guides

About this directory

To make it simpler, we collect and organise all the guides in lists specific to a particular category. This list is about all the HRIS API guides we have published so far to make HRIS Integration simpler for developers.

It is divided into two sections - In-depth integration guides for various HRIS platforms and API directories. While in-depth guides cover the more complex APPs in detail, including authentication, use cases, and more, the API directories give you a quick overview of the common API end points for each APP, which you can use as a reference to build your integrations.

In-Depth HRIS API Guides

HRIS API Directories

About Knit

Build once. Integrate everywhere.

All our Directories

HRIS Integration is just one category we cover. Here's our full list of our directories across different APP categories:

Close API Directory

Close CRM is a robust customer relationship management software tailored for startups and small to medium-sized businesses (SMBs) aiming to enhance their sales processes. Designed with a focus on sales efficiency, Close CRM equips sales teams with a suite of tools to streamline activities and boost performance. Key features include advanced emailing capabilities, a power dialer, email automation, and integrated outbound sales tools, all of which contribute to a more efficient sales workflow. By automating and optimizing sales processes, Close CRM helps businesses convert leads into revenue, making it an essential tool for sales-driven organizations.

In addition to its core functionalities, Close CRM offers comprehensive reporting and management features that provide valuable insights into sales activities and outcomes. This enables sales professionals to make informed decisions and refine their strategies. For businesses looking to integrate Close CRM with other systems, the Close API offers seamless integration capabilities, allowing for enhanced customization and functionality. The Close API is a critical component for businesses seeking to leverage the full potential of Close CRM in their sales operations.

Key highlights of Close CRM APIs

The Close API provides developers with a comprehensive suite of tools to integrate and automate sales processes within their applications. Below are the key highlights of the Close API:

Core Functionalities:

Lead Management: Create, retrieve, update, and delete leads, enabling seamless integration with your sales pipeline.
Activity Tracking: Log and manage various activities such as calls, emails, notes, and meetings associated with leads.
Custom Fields: Define and utilize custom fields to store additional information on leads, contacts, opportunities, and activities, allowing for tailored data management.
Webhooks: Set up webhooks to receive real-time notifications about specific events, facilitating timely data synchronization.

Integration Use Cases:

CRM Synchronization: Integrate Close with other CRM systems to ensure consistent and up-to-date customer information across platforms.
Automated Workflows: Develop automated workflows that trigger actions based on specific events, such as sending follow-up emails after a call is logged.
Custom Reporting: Extract and analyze sales data to generate custom reports that provide insights into sales performance and trends.

Supported Protocols:

RESTful API: The Close API adheres to REST conventions, utilizing standard HTTP methods and predictable URL structures for resource manipulation.

Authentication Mechanisms:

API Key Authentication: Suitable for internal scripts and simple integrations, API keys are used for authentication via HTTP Basic Authentication.
OAuth 2.0: For public applications, OAuth 2.0 is employed to grant secure access to the API on behalf of users.

Rate Limiting Policies:

Per-Endpoint Group Limits: The API enforces rate limits based on endpoint groups, allowing higher limits for lightweight requests compared to more resource-intensive ones.
Organization-Level Limits: Rate limits are applied at the organization level across all users' API keys, with additional per-API key limits to prevent individual integrations from affecting others.

For detailed information and to begin integrating with the Close API, refer to their official API documentation. Close Developer

Close CRM API Endpoints

Activity

DELETE https://api.close.com/api/v1/activity/call/{id}/ : Delete a Call Activity
POST https://api.close.com/api/v1/activity/custom/ : Create a new Custom Activity instance
DELETE https://api.close.com/api/v1/activity/custom/{id}/ : Delete a Custom Activity Instance
POST https://api.close.com/api/v1/activity/email/ : Create an Email Activity
DELETE https://api.close.com/api/v1/activity/email/{id}/ : Delete an Email Activity
DELETE https://api.close.com/api/v1/activity/emailthread/{id}/ : Delete an EmailThread Activity
DELETE https://api.close.com/api/v1/activity/meeting/{id}/ : Delete a Meeting Activity
POST https://api.close.com/api/v1/activity/meeting/{id}/integration/ : Create or Update Third Party Meeting Integration
POST https://api.close.com/api/v1/activity/note/ : Create a Note Activity
DELETE https://api.close.com/api/v1/activity/note/{id}/ : Delete a Note Activity
POST https://api.close.com/api/v1/activity/sms/ : Create an SMS Activity
DELETE https://api.close.com/api/v1/activity/sms/{id}/ : Delete an SMS activity
POST https://api.close.com/api/v1/activity/status_change/lead/ : Create a new LeadStatusChange activity
DELETE https://api.close.com/api/v1/activity/status_change/lead/{id}/ : Delete a single LeadStatusChange activity
POST https://api.close.com/api/v1/activity/status_change/opportunity/ : Create a new OpportunityStatusChange activity
DELETE https://api.close.com/api/v1/activity/status_change/opportunity/{id}/ : Delete a Single OpportunityStatusChange Activity
DELETE https://api.close.com/api/v1/activity/task_completed/{id}/ : Delete a TaskCompleted Activity

Comment

POST https://api.close.com/api/v1/comment/ : Create a Comment

Contact

POST https://api.close.com/api/v1/contact/ : Create a New Contact
DELETE https://api.close.com/api/v1/contact/{id}/ : Delete a Contact

Custom Activity

POST https://api.close.com/api/v1/custom_activity/ : Create New Custom Activity Type
DELETE https://api.close.com/api/v1/custom_activity/{id}/ : Delete a Custom Activity Type

Custom Field

POST https://api.close.com/api/v1/custom_field/activity/ : Create a new Activity Custom Field
DELETE https://api.close.com/api/v1/custom_field/activity/{custom_field_id}/ : Delete an Activity Custom Field
POST https://api.close.com/api/v1/custom_field/contact/ : Create a new Contact Custom Field
DELETE https://api.close.com/api/v1/custom_field/contact/{custom_field_id}/ : Delete a Contact Custom Field
POST https://api.close.com/api/v1/custom_field/custom_object_type/ : Create a new Custom Object Custom Field
DELETE https://api.close.com/api/v1/custom_field/custom_object_type/{custom_field_id}/ : Delete a Custom Object Custom Field
POST https://api.close.com/api/v1/custom_field/lead/ : Create a new Lead Custom Field
DELETE https://api.close.com/api/v1/custom_field/lead/{custom_field_id}/ : Delete a Lead Custom Field
POST https://api.close.com/api/v1/custom_field/opportunity/ : Create a new Opportunity Custom Field
DELETE https://api.close.com/api/v1/custom_field/opportunity/{custom_field_id}/ : Delete an Opportunity Custom Field
POST https://api.close.com/api/v1/custom_field/shared/ : Create a new Shared Custom Field
DELETE https://api.close.com/api/v1/custom_field/shared/{custom_field_id}/ : Delete a Shared Custom Field
DELETE https://api.close.com/api/v1/custom_field/shared/{custom_field_id}/association/{object_type}/ : Disassociate a Shared Custom Field from an Object
POST https://api.close.com/api/v1/custom_field/shared/{shared_custom_field_id}/association/ : Associate a Shared Custom Field with an Object Type

Custom Object

POST https://api.close.com/api/v1/custom_object/ : Create a new Custom Object instance
DELETE https://api.close.com/api/v1/custom_object/{id}/ : Delete a Custom Object Instance

Custom Object Type

POST https://api.close.com/api/v1/custom_object_type/ : Create New Custom Object Type
DELETE https://api.close.com/api/v1/custom_object_type/{id}/ : Delete a Custom Object Type

Email Template

POST https://api.close.com/api/v1/email_template/ : Create an Email Template
DELETE https://api.close.com/api/v1/email_template/{id}/ : Delete an Email Template

Export

POST https://api.close.com/api/v1/export/lead/ : Export Leads, Opportunities, or Contacts

Group

POST https://api.close.com/api/v1/group/ : Create a Group
DELETE https://api.close.com/api/v1/group/{group_id}/ : Delete a Group
POST https://api.close.com/api/v1/group/{group_id}/member/ : Add a User to a Group

Integration Link

POST https://api.close.com/api/v1/integration_link/ : Create an Integration Link
DELETE https://api.close.com/api/v1/integration_link/{id}/ : Delete an Integration Link

Lead

POST https://api.close.com/api/v1/lead/ : Create a New Lead
DELETE https://api.close.com/api/v1/lead/{id}/ : Delete a Lead

Membership

POST https://api.close.com/api/v1/membership/ : Create or Activate Membership

Opportunity

POST https://api.close.com/api/v1/opportunity/ : Create an Opportunity
DELETE https://api.close.com/api/v1/opportunity/{id}/ : Delete an Opportunity

Phone Number

DELETE https://api.close.com/api/v1/phone_number/{id}/ : Delete a Phone Number

Pipeline

POST https://api.close.com/api/v1/pipeline/ : Create a Pipeline
DELETE https://api.close.com/api/v1/pipeline/{pipeline_id}/ : Delete a Pipeline

Role

POST https://api.close.com/api/v1/role/ : Create a New Role
DELETE https://api.close.com/api/v1/role/{role_id}/ : Delete a Role

Saved Search

POST https://api.close.com/api/v1/saved_search/ : Create a Contact Smart View
DELETE https://api.close.com/api/v1/saved_search/{id}/ : Delete a Smart View

Scheduling Link

POST https://api.close.com/api/v1/scheduling_link/ : Create a User Scheduling Link
POST https://api.close.com/api/v1/scheduling_link/integration/ : Create or Update a User Scheduling Link via OAuth Integration
DELETE https://api.close.com/api/v1/scheduling_link/integration/{source_id}/ : Delete User Scheduling Link by Source ID via OAuth
DELETE https://api.close.com/api/v1/scheduling_link/{id}/ : Delete a User Scheduling Link

Send As

DELETE https://api.close.com/api/v1/send_as/ : Delete a Send As Association by Allowed User
POST https://api.close.com/api/v1/send_as/bulk/ : Edit Send As Associations in Bulk
DELETE https://api.close.com/api/v1/send_as/{id}/ : Delete a Send As Association by ID

Sequence

POST https://api.close.com/api/v1/sequence/ : Create a Sequence
DELETE https://api.close.com/api/v1/sequence/{id}/ : Delete a Sequence

Shared Scheduling Link

POST https://api.close.com/api/v1/shared_scheduling_link/ : Create a Shared Scheduling Link
DELETE https://api.close.com/api/v1/shared_scheduling_link/{id}/ : Delete a Shared Scheduling Link

SMS Template

POST https://api.close.com/api/v1/sms_template/ : Create an SMS Template
DELETE https://api.close.com/api/v1/sms_template/{id}/ : Delete an SMS Template

Status

POST https://api.close.com/api/v1/status/lead/ : Create a New Status for Leads
DELETE https://api.close.com/api/v1/status/lead/{status_id}/ : Delete a Lead Status
POST https://api.close.com/api/v1/status/opportunity/ : Create Opportunity Status
DELETE https://api.close.com/api/v1/status/opportunity/{status_id}/ : Delete an Opportunity Status

Task

PUT https://api.close.com/api/v1/task/ : Bulk Update Tasks
DELETE https://api.close.com/api/v1/task/{id}/ : Delete a Task

Webhook

POST https://api.close.com/api/v1/webhook/ : Create new Webhook subscription
DELETE https://api.close.com/api/v1/webhook/{id}/ : Delete Webhook Subscription

‍

Close API FAQs

How do I authenticate with the Close API?

Answer: The Close API supports two authentication methods:some text
- API Key: Suitable for scripts and internal integrations. Generate an API key in your Close account settings and include it in the Authorization header of your HTTP requests, formatted as Basic {Base64EncodedAPIKey:}.
- OAuth 2.0: Recommended for public applications. Register your application in the Close Developer settings to obtain a client ID and secret. Follow the OAuth 2.0 flow to obtain an access token, which should be included in the Authorization header as Bearer {AccessToken}.
Source: Authentication with API keys - Close API Documentation

What are the rate limits for the Close API?

Answer: Close enforces rate limits to ensure fair usage. The default limit is 60 requests per minute per organization. Exceeding this limit will result in a 429 Too Many Requests response. It's advisable to implement exponential backoff in your application to handle rate limiting gracefully.
Source: Rate Limits - Close API Documentation

Can I retrieve lead information using the Close API?

Answer: Yes, you can retrieve lead information by making a GET request to the /lead/ endpoint. This will return a list of leads and their details. You can also filter leads using query parameters to narrow down the results.
Source: Leads - Close API Documentation

Does the Close API support webhooks for real-time data updates?

Answer: Yes, Close supports webhooks, allowing you to receive real-time notifications for specific events, such as when a lead is updated or a new opportunity is created. You can configure webhook subscriptions to specify which events you want to receive notifications for.
Source: Webhooks - Close API Documentation

Are there official API clients or SDKs for the Close API?

Answer: Yes, Close provides official API clients for various programming languages to facilitate integration:some text
- Python: An officially maintained wrapper for Python developers.
- Node.js: An officially maintained wrapper for Node.js developers.
- Ruby, PHP, C#, Elixir, Go: Community-contributed clients are available for these languages.
Source: API Clients - Close API Documentation

Get Started with Close API Integration

Knit API offers a convenient solution for quick and seamless integration with Close API. Our AI-powered integration platform allows you to build any Close API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Close API.

To sign up for free, click here. To check the pricing, see our pricing page.

Paychex API Directory

Paychex is a payroll and HR solutions provider designed to simplify workforce management for businesses of all sizes. It offers a range of tools for payroll processing, employee benefits, time tracking, and compliance, helping companies streamline their HR tasks.

‍

With Paychex’s API, developers can integrate payroll, benefits, and other HR data with external applications, enabling automation and creating a seamless experience for managing employee-related tasks across platforms.

‍

Here are some key highlights of the Paychex APIs:

Payroll Processing: Automate payroll calculations, deductions, and tax filings for smooth and timely payments.
Employee Management: Access and manage employee data, including personal details, employment status, and role-based permissions.
Time and Attendance: Track employee hours, manage time-off requests, and streamline attendance records for accurate payroll processing.
Benefits Administration: Integrate employee benefits data to easily manage enrollments, coverage updates, and compliance reporting.
Compliance and Tax Data: Access tax compliance data and generate reports to simplify filing and stay aligned with local, state, and federal regulations.
Secure Authentication: Uses OAuth 2.0 for secure data exchange, ensuring that sensitive payroll and employee information is protected.

In this article, we will explore what are the most commonly used Paychex API endpoints and how they allow businesses to streamline their HR and payroll operations, making it easy to integrate Paychex services into existing workflows.

‍

Paychex API Endpoints

Here are the most commonly used Paychex API endpoints -

‍

Authentication

POST https://api.paychex.com/auth/oauth/v2/token

Company

‍

Payroll

‍

Worker

‍

Management

POST https://api.paychex.com/management/requestclientaccess

‍

Webhooks

‍

Here’s a detailed reference to all the Paychex API Endpoints.

Paychex API FAQs

Here are the frequently asked questions about Paychex APIs to help you get started:

‍

Do Paychex APIs support pagination? Answer
What is the rate limit on Paychex API endpoints? Answer
What happens when I POST new workers via the Paychex API, and what are the required fields? Answer
How do I specify a vendor media type profile in Paychex API requests, and is it required for each call? Answer
What are the predefined headers used in Paychex API requests and responses? Answer

Find more FAQs here.

‍

Get started with Paychex API

To access Paychex APIs, create a Paychex account and log in to the Developer Portal. Apply for API access, and upon approval, you'll receive your API credentials (client ID and secret). Use these for OAuth 2.0 authentication to securely access the API endpoints. Review the documentation for integration guidelines.

‍

If you’re looking for a quick way to connect multiple Payroll systems, consider using Knit—a single API solution that integrates with major platforms, streamlining your setup and reducing development time. To sign up for free, click here. To check the pricing, see our pricing page.

‍

Ashby API Directory

Ashby software is a robust recruiting platform designed to transform the way organizations manage their recruitment and talent acquisition processes. By integrating Applicant Tracking System (ATS), analytics, scheduling, Customer Relationship Management (CRM), and sourcing capabilities, Ashby offers a comprehensive solution that empowers recruiting teams to streamline their operations and make data-driven decisions. This all-in-one platform is tailored to enhance efficiency and strategic planning, making it an indispensable tool for modern recruitment teams.

One of the standout features of Ashby is its ability to seamlessly integrate with various systems through the Ashby API. This integration capability allows organizations to connect Ashby with their existing tools and platforms, ensuring a smooth flow of data and enhancing the overall recruitment process. The Ashby API is designed to be user-friendly and flexible, enabling developers to customize and extend the platform's functionalities to meet specific organizational needs. By leveraging the Ashby API, companies can optimize their recruitment strategies and achieve better outcomes.

Key Highlights of the Ashby API:

Comprehensive Data Access: The API provides endpoints to access and manage data related to candidates, applications, jobs, interviews, offers, and more. This allows for seamless integration of Ashby's functionalities into external applications. Ashby
Webhooks Support: Ashby supports webhooks to notify external systems about specific events, such as candidate updates or job postings, enabling real-time data synchronization and automation. Ashby

Getting Started with the Ashby API:

Obtain an API Key:
- Log in to your Ashby account.
- Navigate to the Developer Center to generate an API key.
- Ensure that the API key is kept secure, as it grants access to your Ashby data.
Explore API Documentation:
- Review the comprehensive API documentation available at Ashby API Documentation
- Familiarize yourself with the available endpoints, request structures, and response formats.
Set Up Webhooks (If Needed):
- If your application requires real-time updates, configure webhooks through the Ashby platform to receive event notifications.
Implement API Calls:
- Use standard HTTP methods (GET, POST, PUT, DELETE) to interact with the API endpoints.
- Ensure that each request includes the necessary authentication headers and complies with the API's data format requirements.

Additional Resources:

Integration Guides: Ashby provides guides and examples to assist in integrating their API with your applications, available within the API documentation.
Third-Party Integration Platforms: Services like Knit and Airbyte offer connectors to facilitate integration with Ashby, simplifying the development process.

Ashby API Endpoints

Below is a comprehensvie list of Ashby API endpoints with details on each endpoint:

API Key

POST https://api.ashbyhq.com/apiKey.info : The apiKey.info API endpoint is used to retrieve information about the API key being used to make the request. It requires the 'apiKeysRead' permission. The request is made using the POST method to the URL 'https://api.ashbyhq.com/apiKey.info'. The request headers must include 'accept' and 'content-type' set to 'application/json'. The request body is an empty JSON object. The response can either be a success response containing the API key's title and creation date or an error response with a list of error messages.

Application

POST https://api.ashbyhq.com/application.addHiringTeamMember : The Add Hiring Team Member to Application API allows you to add an Ashby user to the hiring team at the application level. It requires the 'candidateWrite' permission. The request body must include 'applicationId', 'teamMemberId', and 'roleId', all of which are UUIDs. The response can either be a success response, which includes details about the user added to the hiring team, or an error response with a list of error messages.
POST https://api.ashbyhq.com/application.change_source : The Change Application Source API allows users to update the source of a specific application. It requires the 'candidatesWrite' permission. The request is made via a POST method to the endpoint 'https://api.ashbyhq.com/application.change_source'. The request body must include 'applicationId' and 'sourceId', both of which are UUIDs. The response can either be a success or an error. A successful response includes details about the application, candidate, current interview stage, source, job, and hiring team. An error response includes a list of error messages.
POST https://api.ashbyhq.com/application.change_stage : The Change Application Stage API allows users to change the stage of an application in the system. It requires the 'candidatesWrite' permission. The request must include the applicationId and interviewStageId in the body, both of which are UUIDs. Optionally, an archiveReasonId can be provided if the application is being moved to an 'Archived' stage. The response will indicate success and provide detailed information about the application, including its status, candidate details, current interview stage, source, archive reason, job details, credited user, and hiring team. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/application.create : The Create Application API allows you to consider a candidate for a job by creating an application. It requires the `candidatesWrite` permission. The request body must include the `candidateId` and `jobId` as required fields. Optional fields include `interviewPlanId`, `interviewStageId`, `sourceId`, `creditedToUserId`, `createdAt`, and `applicationHistory`. The response can either be a success response with details of the created application or an error response with a list of error messages.
POST https://api.ashbyhq.com/application.info : The Fetch Application Details API allows users to retrieve application details using either an application ID or a submitted form instance ID. If both IDs are provided, the application ID takes precedence. The API requires the 'candidatesRead' permission. The request body must include either 'applicationId' or 'submittedFormInstanceId', and optionally an 'expand' parameter to include additional related data. The response includes detailed information about the application, candidate, interview stages, job, and more. The API returns a success response with application details or an error response with error messages.
POST https://api.ashbyhq.com/application.list : The List Applications API endpoint retrieves all applications within an organization. It requires the 'candidatesRead' permission. The request is made via a POST method to the URL 'https://api.ashbyhq.com/application.list'. The request body can include parameters such as 'createdAfter', 'cursor', 'syncToken', 'limit', 'expand', 'status', and 'jobId'. The response includes a success flag, a list of results with detailed application information, and pagination details like 'moreDataAvailable' and 'nextCursor'. The response also provides a 'syncToken' for synchronization purposes. In case of errors, an error response with a list of error messages is returned.
POST https://api.ashbyhq.com/application.update : The Update Application API allows users to update an existing application. It requires the `candidatesWrite` permission. The request must include the `applicationId` in the body, which is the ID of the application to be updated. Optional fields include `sourceId`, `creditedToUserId`, `createdAt`, and `sendNotifications`. The response will indicate success and provide details about the updated application, including its status, candidate information, interview stage, source, and more. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/applicationFeedback.list : The List Application Feedback API endpoint allows users to retrieve all feedback associated with a specific application. It requires the 'candidatesRead' permission. The request is made via a POST method to the specified URL with headers indicating the content type as 'application/json'. The request body can include parameters such as 'createdAfter', 'cursor', 'syncToken', 'limit', and 'applicationId'. The response includes a success flag, a list of results with detailed feedback information, and pagination details like 'moreDataAvailable' and 'nextCursor'. In case of errors, an error response with a list of error messages is returned.
POST https://api.ashbyhq.com/applicationFeedback.submit : The Submit Application Feedback API allows users to submit feedback for a specific application using a feedback form. The API requires the `candidatesWrite` permission. The request body must include the feedback form details, form definition ID, application ID, and optionally the user ID and interview event ID. The feedback form supports various field types such as Boolean, Date, Email, Number, RichText, Score, Phone, String, ValueSelect, and MultiValueSelect. The response indicates whether the submission was successful and includes the submitted form instance details. In case of errors, an error response with a list of error messages is returned.
POST https://api.ashbyhq.com/applicationForm.submit : The Submit Application Form API allows users to submit an application for a job posting. It requires the `candidatesWrite` permission and the request must be of type `multipart/form-data`. The request body must include the `jobPostingId` and `applicationForm` with `fieldSubmissions`. The API supports various field types such as Boolean, Date, Email, Number, and more. The response can be a success or an error, with detailed information about the submitted form instance and any form messages.
POST https://api.ashbyhq.com/applicationHiringTeamRole.list : The List Application Hiring Team Roles API retrieves all available hiring team roles for applications within the organization. It requires the 'candidatesRead' permission. The request is made via a POST method to the specified endpoint with an 'accept' header indicating the media type as 'application/json'. The response includes a list of roles with their unique IDs and titles if successful, or an error message if the request fails.

Approval

POST https://api.ashbyhq.com/approvalDefinition.update : The Update Approval Definition API allows users to create or update an approval definition for a specific entity that requires approval. The entity must be within the scope of an approval in Ashby that is managed by the API. The request requires the 'approvalsWrite' permission. The request body must include 'entityType', 'entityId', and 'approvalStepDefinitions'. If 'approvalStepDefinitions' is empty, approval will be skipped. The response will indicate success and provide details of the approval definition or errors if the request fails.

Archive Reason

POST https://api.ashbyhq.com/archiveReason.list : The List Archive Reasons API endpoint allows users to retrieve a list of archive reasons. It requires the 'hiringProcessMetadataRead' permission. The request is made via a POST method to the URL 'https://api.ashbyhq.com/archiveReason.list'. The request body can include a boolean parameter 'includeArchived' to specify whether archived interview plans should be included. The response can either be a success response containing a list of archive reasons with details such as 'id', 'text', 'reasonType', and 'isArchived', or an error response with a list of error messages.

Assessment

POST https://api.ashbyhq.com/assessment.addCompletedToCandidate : The 'Add Completed Assessment to Candidate' API allows you to add a completed assessment to a candidate's profile. It requires the 'candidatesWrite' permission. The request body must include the candidateId, partnerId, assessment details (including assessmentTypeId, assessmentId, assessmentName, result, and metadata), and a timestamp indicating when the assessment was completed. The response will indicate success or failure, and in the case of success, it will return the details of the assessment added. In case of an error, it will return a list of error messages.
POST https://api.ashbyhq.com/assessment.cancel : The Cancel Assessment API allows partners to cancel an assessment that has been started. The request requires the 'assessment_id' in the body, which is a UUID identifying the assessment to be canceled. The response can either be a success response containing details about the canceled assessment or an error response with a list of error messages. The API is implemented by the partner and called by Ashby.
POST https://api.ashbyhq.com/assessment.start : The Start Assessment API is used to initiate an assessment for a candidate. It requires details about the assessment type, candidate, application, and job. The request body must include the assessment_type_id, candidate details (including ashby_id, first_name, last_name, email, and ashby_profile_url), application details (including ashby_id and status), and job details (including ashby_id, name, ashby_job_url, and hiring team information). The response includes a success flag and results containing the assessment_id and various metadata about the assessment, such as update requests, assessment profile URL, assessment result, cancelled reason, and additional metadata.
POST https://api.ashbyhq.com/assessment.update : The 'Update Assessment Status' API allows users to update Ashby about the status of a started assessment. It requires the 'candidatesWrite' permission. The request body must include 'assessment_id' and 'timestamp'. Optional fields include 'assessment_status', 'assessment_profile_url', 'assessment_result', 'cancelled_reason', and 'metadata'. The response indicates the status of the update operation.

Candidate

POST https://api.ashbyhq.com/candidate.addTag : The Add Tag to Candidate API allows users to add a specific tag to a candidate's profile in the Ashby system. This API requires the `candidatesWrite` permission. The request must include the candidate's unique ID and the tag's unique ID in the request body. The response will indicate whether the operation was successful and provide detailed information about the candidate, including their contact information, social links, tags, and other relevant details. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/candidate.create : The Create Candidate API endpoint allows users to create a new candidate in the system. It requires the `candidatesWrite` permission. The request must include the candidate's name, and can optionally include other details such as email, phone number, LinkedIn URL, GitHub URL, website, alternate email addresses, source ID, credited user ID, location, and creation timestamp. The response will indicate success and provide details about the created candidate, including their ID, name, contact information, social links, tags, position, company, school, application IDs, resume file handle, custom fields, profile URL, source, credited user, timezone, and primary location. In case of an error, the response will include error messages.
POST https://api.ashbyhq.com/candidate.createNote : The Create Note on Candidate API allows users to add a note to a candidate's profile. It requires the 'candidatesWrite' permission. The request body must include the candidate's unique identifier (candidateId) and the note content, which can be either a plain text string or an object specifying the content type and value. The API supports HTML elements like bold, italic, underline, links, lists, and code blocks for notes of type 'text/html'. Users can optionally specify whether to send notifications to subscribed users. The response includes a success flag and, if successful, details of the created note, including its ID, creation date, content, and author information. In case of errors, an error message is returned.
POST https://api.ashbyhq.com/candidate.info : The Candidate Information Retrieval API allows users to fetch detailed information about a candidate using either the candidate's unique ID or an external mapping ID. This API requires the 'candidatesRead' permission. The request body must include either the 'id' or 'externalMappingId' to identify the candidate. The response includes comprehensive details about the candidate, such as personal information, contact details, social links, tags, position, company, school, application IDs, resume file handle, custom fields, profile URL, source, credited user, timezone, and primary location. The response can either be a success with detailed candidate information or an error with a list of error messages.
POST https://api.ashbyhq.com/candidate.list : The List Candidates API endpoint allows users to retrieve a list of all candidates in an organization. It requires the 'candidatesRead' permission. The request is made via a POST method to the URL 'https://api.ashbyhq.com/candidate.list'. The request body can include parameters such as 'cursor' for pagination, 'syncToken' for data synchronization, and 'limit' to specify the number of items to return. The response includes a success flag, potential error messages, and detailed candidate information such as name, contact details, social links, tags, and more.
POST https://api.ashbyhq.com/candidate.listNotes : The List Candidate Notes API endpoint allows users to retrieve all notes associated with a specific candidate. It requires the 'candidatesRead' permission. The request must include the candidate's ID, and optionally a cursor, sync token, and limit for pagination. The response includes a success flag, and if successful, a list of notes with details such as note ID, creation date, content, and author information. If there are errors, an error message will be returned.
POST https://api.ashbyhq.com/candidate.search : The Candidate Search API allows users to search for candidates by email and/or name. It requires the 'candidatesRead' permission. The API is designed for use cases where a small set of candidates is needed, such as building a candidate autocomplete. The request body can include 'email' and 'name' as search parameters, which are combined with the 'AND' operator if both are provided. The response is limited to 100 results and includes detailed candidate information such as email addresses, phone numbers, social links, tags, and more. If the search criteria are invalid, an error response is returned.
POST https://api.ashbyhq.com/candidate.update : The Update Candidate API allows you to update an existing candidate's information in the system. It requires the `candidatesWrite` permission. The request body must include the `candidateId` as a required field, and can optionally include other fields such as `name`, `email`, `phoneNumber`, `linkedInUrl`, `githubUrl`, `websiteUrl`, `alternateEmail`, `socialLinks`, `sourceId`, `creditedToUserId`, `location`, `createdAt`, and `sendNotifications`. The response will indicate success or failure, and in the case of success, it will return the updated candidate details including `id`, `name`, `emailAddresses`, `phoneNumbers`, `socialLinks`, `tags`, `applicationIds`, `fileHandles`, `profileUrl`, and more.
POST https://api.ashbyhq.com/candidate.uploadFile : The Upload Candidate File API allows users to upload a file to attach to a candidate's profile in Ashby. This API requires the 'candidatesWrite' permission and the request must be made with 'multipart/form-data' content type. The request body must include the 'candidateId' and the 'file' to be uploaded. Upon successful upload, the API returns a detailed response containing the candidate's information, including their name, email addresses, phone numbers, social links, tags, position, company, school, application IDs, file handles, custom fields, profile URL, source, credited user, timezone, and primary location. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/candidate.uploadResume : The candidate.uploadResume API allows users to upload a candidate's resume, parse it, and update their information in the system. This API requires the 'candidatesWrite' permission and the request must be sent with 'multipart/form-data' as the content type. The request body must include the 'candidateId' and the 'resume' file. The response will indicate success and provide detailed information about the candidate, including their contact information, social links, tags, position, company, school, application IDs, resume file handle, custom fields, profile URL, source, credited user, timezone, and primary location. If the request fails, an error response will be returned with a list of error messages.
POST https://api.ashbyhq.com/canidate.anonymize : The Anonymize Candidate API is used to anonymize a candidate's data. It requires the 'candidatesWrite' permission and all of the candidate's applications must be in the archived or hired state. The API takes a POST request with a JSON body containing the 'candidateId' as a UUID. The response can either be a success response with detailed candidate information or an error response with a list of error messages.

Candidate Tag

POST https://api.ashbyhq.com/candidateTag.create : The Create Candidate Tag API allows users to create a new tag for a candidate. It requires the 'hiringProcessMetadataWrite' permission. The request must include a JSON body with a 'title' field, which is the name of the tag. If a tag with the same title already exists, the existing tag will be returned. The response can either be a success response, which includes the tag details such as 'id', 'title', and 'isArchived', or an error response with a list of error messages.
POST https://api.ashbyhq.com/candidateTag.list : The List Candidate Tags API endpoint allows users to retrieve all candidate tags. It requires the 'hiringProcessMetadataRead' permission. The request is made via a POST method to the URL 'https://api.ashbyhq.com/candidateTag.list'. The request body can include an optional 'includeArchived' boolean parameter to specify whether archived tags should be included. The response will be a JSON object indicating success and containing an array of candidate tags, each with an 'id', 'title', and 'isArchived' status. In case of an error, the response will include a list of error messages.

Custom Field

POST https://api.ashbyhq.com/customField.create : The Create Custom Field API allows users to create a new custom field in the Ashby system. It requires the `hiringProcessMetadataWrite` permission. The request body must include the `fieldType`, `objectType`, and `title` as required fields. Optional fields include `description`, `selectableValues`, `isDateOnlyField`, and `isExposableToCandidate`. The response will indicate success and provide details of the created custom field, including its `id`, `title`, `objectType`, `isArchived`, and `fieldType`. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/customField.list : The List Custom Fields API endpoint allows users to retrieve a list of all custom fields available in the Ashby system. It requires the 'hiringProcessMetadataRead' permission. The request is made via a POST method to the specified URL with headers indicating the content type as 'application/json'. The request body can include optional parameters such as 'cursor' for pagination, 'syncToken' for synchronization, and 'limit' to specify the number of items to return. The response can either be a success or an error. A successful response includes a list of custom fields with details such as 'id', 'title', 'objectType', 'isArchived', 'fieldType', and 'selectableValues' if applicable. An error response includes a list of error messages.
POST https://api.ashbyhq.com/customField.setValue : The 'Set Custom Field Value' API allows users to set the value of a custom field for a specified object. It requires the 'candidatesWrite' permission. The request body must include 'objectId', 'objectType', 'fieldId', and 'fieldValue'. The 'fieldValue' can be of various types depending on the field being updated, such as Boolean, Date, String, MultiValueSelect, Number, or ValueSelect. The response will indicate success and provide details of the updated field value, or it will return an error message if the input is invalid.

Department

POST https://api.ashbyhq.com/department.create : The Create Department API allows users to create a new department within an organization. It requires the 'organizationWrite' permission. The request must include the department's name and optionally the parent department's ID. The response will indicate success and provide details of the created department, including its ID, name, and archival status. In case of errors, an error message will be returned.
POST https://api.ashbyhq.com/department.info : The Fetch Department Details API allows users to retrieve details of a department by its unique ID. It requires the 'organizationRead' permission. The request must include the department ID in the request body. The response can either be a success response containing the department details such as ID, name, and archival status, or an error response with a list of error messages.
POST https://api.ashbyhq.com/department.list : The List Departments API endpoint allows users to retrieve a list of all departments within an organization. It requires the 'organizationRead' permission. The request is made via a POST method to the URL 'https://api.ashbyhq.com/department.list'. The request body can include an optional 'includeArchived' boolean parameter to specify whether archived departments should be included in the response. The response will return a success status and a list of department objects, each containing an 'id', 'name', 'isArchived' status, and optionally a 'parentId'. In case of an error, the response will include a list of error messages.

Feedback Form Definition

POST https://api.ashbyhq.com/feedbackFormDefinition.info : The Feedback Form Definition Information API returns a single feedback form by its unique ID. It requires the 'hiringProcessMetadataRead' permission. The request must include the 'feedbackFormDefinitionId' in the body as a UUID. The response can either be a success, containing details of the feedback form such as its ID, title, and form definition, or an error response with a list of error messages.
POST https://api.ashbyhq.com/feedbackFormDefinition.list : The List Feedback Form Definitions API endpoint allows users to retrieve a list of feedback forms. It requires the 'hiringProcessMetadataRead' permission. The request body can include parameters such as 'includeArchived' to include archived items, 'cursor' for pagination, 'syncToken' for synchronization, and 'limit' to specify the number of items to return. The response includes a success flag, a list of results with feedback form details, and pagination information. In case of errors, an error message is returned.

File

POST https://api.ashbyhq.com/file.info : The 'Retrieve File URL for Candidate' API endpoint allows users to retrieve the URL of a file associated with a candidate. This API requires the 'candidatesRead' permission. The request is made via a POST method to the URL 'https://api.ashbyhq.com/file.info'. The request body must include a 'fileHandle', which is a string representing a file handle retrieved from the public API. The response can either be a success, returning a JSON object with a 'success' boolean and a 'results' object containing the 'url' of the file, or an error, returning a 'success' boolean set to false and an 'errors' array with error message strings.

Hiring Team

POST https://api.ashbyhq.com/hiringTeam.addMember : The Add Member to Hiring Team API allows you to add an Ashby user to the hiring team at either the application or job level. It requires the 'organizationWrite' permission. The request body must include either an applicationId or jobId, along with the teamMemberId and roleId. The response will indicate success and provide details of the added team member, or it will return errors if the operation fails.
POST https://api.ashbyhq.com/hiringTeamRole.list : The List Hiring Team Roles API endpoint allows users to retrieve a list of possible hiring team roles within an organization. It requires the 'organizationRead' permission. The request is made via a POST method to the specified URL with headers indicating the expected response and request body media types as 'application/json'. The request body can include a 'namesOnly' boolean parameter, which defaults to true. If 'namesOnly' is true, the response will be an array of role titles. If false, the response will include an array of objects with each role's id and title. The response includes a 'success' boolean indicating if the request was successful and a 'results' array containing the role information.

Interview

POST https://api.ashbyhq.com/interview.info : The Fetch Interview Details by ID API allows users to retrieve detailed information about a specific interview using its unique ID. This API requires the 'interviewsRead' permission. The request must include the interview ID in the request body as a UUID. The response will include details such as the interview's title, whether it is archived, HTML and plaintext descriptions, associated job ID, and feedback form definition ID. If the request is successful, the response will include a 'success' flag and the interview details. In case of an error, the response will include a 'success' flag set to false and a list of error messages.
POST https://api.ashbyhq.com/interview.list : The 'List Interviews' API endpoint allows users to retrieve a list of interviews. It requires the 'interviewsRead' permission. The request is made via a POST method to the URL 'https://api.ashbyhq.com/interview.list'. The request body can include parameters such as 'cursor', 'syncToken', 'limit', 'includeArchived', and 'includeNonSharedInterviews'. The response can either be a success or an error. A successful response includes details about the interviews such as 'id', 'title', 'isArchived', 'instructionsHtml', 'instructionsPlain', 'jobId', and 'feedbackFormDefinitionId'. An error response includes a list of error messages.
POST https://api.ashbyhq.com/interviewEvent.list : The List Interview Events API allows users to retrieve a list of interview events associated with a specific interview schedule. It requires the 'interviewsRead' permission. The request must include the 'interviewScheduleId' in the body, which is a UUID identifying the interview schedule. The response will include a success flag and a list of interview events, each with details such as event ID, interview ID, schedule ID, interviewer IDs, creation time, start and end times, feedback link, location, meeting link, and feedback submission status. In case of errors, an error response with a list of error messages will be returned.
POST https://api.ashbyhq.com/interviewPlan.list : The List Interview Plans API endpoint allows users to retrieve a list of interview plans. It requires the 'interviewsRead' permission. The request is made via a POST method to the URL 'https://api.ashbyhq.com/interviewPlan.list'. The request body can include an optional parameter 'includeArchived' to specify whether archived items should be included in the response. The response can either be a success response containing a list of interview plans with details such as 'id', 'title', and 'isArchived', or an error response with a list of error messages.
POST https://api.ashbyhq.com/interviewSchedule.cancel : The Cancel Interview Schedule API allows users to cancel an interview schedule by its ID. It requires the 'interviewsWrite' permission. The request must include the ID of the interview schedule to be canceled and optionally whether the schedule can be rescheduled. The response will indicate success or failure, and in case of success, it will provide details about the interview schedule, including its status, associated application ID, interview stage ID, and any scheduled interview events. In case of an error, a list of error messages will be returned.
POST https://api.ashbyhq.com/interviewSchedule.create : The 'Create Scheduled Interview' API allows users to create a scheduled interview in Ashby. It requires the 'interviewsWrite' permission. The request body must include the 'applicationId' and 'interviewEvents', which detail the events that make up the interview schedule. Each event must specify 'startTime', 'endTime', and 'interviewers'. The response can either be a success, providing details of the created interview schedule, or an error with a list of error messages.
POST https://api.ashbyhq.com/interviewSchedule.list : The List Interview Schedules API retrieves all interview schedules within an organization. It requires the 'interviewsRead' permission. The request is made via a POST method to the endpoint 'https://api.ashbyhq.com/interviewSchedule.list'. The request body can include parameters such as 'createdAfter', 'cursor', 'syncToken', 'limit', 'applicationId', and 'interviewStageId'. The response includes a success flag, a list of interview schedules, and pagination details like 'moreDataAvailable', 'nextCursor', and 'syncToken'. Each interview schedule contains details such as 'id', 'status', 'applicationId', 'interviewStageId', and associated 'interviewEvents'.
POST https://api.ashbyhq.com/interviewSchedule.update : The Update Interview Schedule API allows users to update, add, or cancel interview events associated with an interview schedule. It requires the 'interviewsWrite' permission. To update an interview event, the 'interviewEventId' must be included in the request. The request body can either update an existing event or cancel an event. The response includes the status of the interview schedule and details of all associated interview events. The API returns a success response with the updated schedule details or an error response with a list of error messages.
POST https://api.ashbyhq.com/interviewStage.info : The Fetch Interview Stage Details API allows users to retrieve details of a specific interview stage by its unique ID. It requires the 'interviewsRead' permission. The request must include the 'interviewStageId' in the body as a UUID. The response can either be a success, containing details such as the stage ID, title, type, order in the interview plan, and interview plan ID, or an error response with a list of error messages.
POST https://api.ashbyhq.com/interviewStage.list : The List Interview Stages API endpoint allows users to list all interview stages for a specified interview plan in order. It requires the 'interviewsRead' permission. The request must include the 'interviewPlanId' in the body as a UUID. The response will indicate success and provide an array of interview stages, each with an id, title, type, order in the interview plan, and the interview plan id. If the request fails, an error response with a list of error messages will be returned.

Interviewer Pool

POST https://api.ashbyhq.com/interviewerPool.addUser : The 'Add User to Interviewer Pool' API allows you to add a user to a specified interviewer pool. It requires the 'hiringProcessMetadataWrite' permission. The request body must include the 'interviewerPoolId' and 'userId', both of which are UUIDs. Optionally, you can include 'interviewerPoolTrainingPathStageId'. The response will indicate success and provide details about the interviewer pool, including its ID, title, and training path information. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/interviewerPool.archive : The Archive Interviewer Pool API archives an interviewer pool. It requires the 'hiringProcessMetadataWrite' permission. The request is made via a POST method to the endpoint 'https://api.ashbyhq.com/interviewerPool.archive'. The request body must include the 'interviewerPoolId', which is the ID of the interviewer pool to be archived. The response can either be a success or an error. A successful response includes details about the interviewer pool, such as its ID, title, archival status, training path, qualified members, and trainees. An error response includes a list of error messages.
POST https://api.ashbyhq.com/interviewerPool.create : The 'Create Interviewer Pool' API endpoint allows users to create a new interviewer pool. It requires the 'hiringProcessMetadataWrite' permission. The request must include a JSON body with the 'title' of the pool, which is required, and an optional 'requiresTraining' boolean to indicate if training is needed. The response will indicate success and provide details about the created pool, including its ID, title, archival status, training path, qualified members, and trainees. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/interviewerPool.info : The Interviewer Pool Information API provides details about a specific interviewer pool. It requires the 'hiringProcessMetadataRead' permission. The request is made via a POST method to the endpoint 'https://api.ashbyhq.com/interviewerPool.info'. The request body must include the 'interviewerPoolId', which is a UUID identifying the pool. The response can be a success or an error. A successful response includes details such as the pool's ID, title, archival status, training path, qualified members, and trainees. An error response includes a list of error messages.
POST https://api.ashbyhq.com/interviewerPool.list : The List Interviewer Pools API endpoint allows users to retrieve a list of interviewer pools. It requires the 'hiringProcessMetadataRead' permission. The request is made via a POST method to the URL 'https://api.ashbyhq.com/interviewerPool.list'. The request body can include parameters such as 'cursor', 'syncToken', 'limit', 'includeArchivedPools', and 'includeArchivedTrainingStages'. The response includes a success flag, a list of results with details about each pool, and pagination information. In case of an error, the response will include an error message.
POST https://api.ashbyhq.com/interviewerPool.removeUser : The 'Remove User from Interviewer Pool' API allows you to remove a user from a specified interviewer pool. This API requires the 'hiringProcessMetadataWrite' permission. The request must include the 'interviewerPoolId' and 'userId' in the body, both of which are UUIDs. The response will indicate success or failure. On success, it returns details about the interviewer pool, including its ID, title, archival status, training path, qualified members, and trainees. On failure, it provides a list of error messages.
POST https://api.ashbyhq.com/interviewerPool.restore : The 'Restore Interviewer Pool' API endpoint allows users to restore an archived interviewer pool. It requires the 'hiringProcessMetadataWrite' permission. The request is made via a POST method to the specified URL with a JSON body containing the 'interviewerPoolId' of the pool to be restored. The response can either be a success, returning details of the restored pool including its ID, title, archival status, training path, qualified members, and trainees, or an error with a list of error messages.
POST https://api.ashbyhq.com/interviewerPool.update : The 'Update Interviewer Pool' API allows users to update details of an existing interviewer pool. It requires the 'hiringProcessMetadataWrite' permission. The request body must include the 'interviewerPoolId' as a required field, and optionally, the 'title' and 'requiresTraining' fields. The response can either be a success or an error. A successful response includes details of the updated interviewer pool, such as its ID, title, archival status, training path, qualified members, and trainees. An error response includes a list of error messages.

Job

POST https://api.ashbyhq.com/job.create : The 'Create a New Job' API endpoint allows users to create a new job posting in the system. It requires the 'jobsWrite' permission. The request must include a JSON body with the job title, team ID, and location ID as required fields. Optional fields include default interview plan ID and job template ID. The response will indicate success or failure, and if successful, it will return details of the created job, including its ID, title, status, and other attributes. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/job.info : The Job Information Retrieval API allows users to fetch detailed information about a specific job using its unique ID. The request requires the 'jobsRead' permission and must include the job ID in the request body. Optionally, users can expand the response to include additional data related to the job's location and openings. The response includes detailed job information such as title, status, employment type, associated department, and custom fields. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/job.list : The List Jobs API allows users to retrieve a list of jobs, including open, closed, and archived jobs. It requires the 'jobsRead' permission. The request body can include parameters such as 'cursor', 'syncToken', 'limit', 'status', 'openedAfter', 'openedBefore', 'closedAfter', 'closedBefore', and 'expand'. The response includes a success flag, a list of job results, and pagination information. Each job result contains details such as job ID, title, status, employment type, location, department, interview plans, custom fields, and hiring team information.
POST https://api.ashbyhq.com/job.search : The Job Search API allows users to search for jobs by title. It requires the 'jobsRead' permission. The request is made via a POST method to the endpoint 'https://api.ashbyhq.com/job.search'. The request body must include a 'title' field specifying the job title to search for. The response includes a success flag and a list of job results, each containing details such as job ID, title, status, employment type, location, department, interview plans, custom fields, job postings, requisition ID, hiring team, and timestamps for updates, openings, and closings. In case of errors, an error response with a list of error messages is returned.
POST https://api.ashbyhq.com/job.setStatus : The Set Job Status API allows users to change the status of a job by its unique ID. It requires the 'jobsWrite' permission. The job status can be set to 'Draft', 'Open', 'Closed', or 'Archived', with specific transitions allowed between these states. The request must include the job ID and the desired status in the body. The response will indicate success and provide detailed job information if successful, or error messages if not.
POST https://api.ashbyhq.com/job.update : The Update Job Details API allows users to update an existing job's details. It requires the 'jobsWrite' permission. The request must include the jobId in the body, and optionally, other fields such as title, teamId, locationId, defaultInterviewPlanId, and customRequisitionId. The response will indicate success and provide updated job details, including id, title, status, employmentType, and more. In case of errors, an error response with a list of error messages will be returned.

Job Posting

POST https://api.ashbyhq.com/jobPosting.info : The Retrieve Job Posting Information API allows users to retrieve detailed information about a specific job posting. It requires the 'jobsRead' permission. The request must include the 'jobPostingId' in the body, which is a UUID identifying the job posting. Optionally, the 'expand' parameter can be used to include additional data for related objects. The response includes detailed information about the job posting, such as its title, description, department, team, location, and linked data for search engine optimization. The API returns a success response with the job posting details or an error response with a list of error messages.
POST https://api.ashbyhq.com/jobPosting.list : The List Job Postings API endpoint allows users to retrieve all published job postings. It requires the 'jobsRead' permission. By default, it includes both listed and unlisted job postings. To only fetch publicly displayable job postings, set the 'listedOnly' parameter to true. The request body can filter results by location and department. The response includes details such as job ID, title, department, team, location, employment type, and more. It also provides a success status and handles errors with descriptive messages.
POST https://api.ashbyhq.com/jobPosting.update : The jobPosting.update API allows users to update an existing job posting. It requires the 'jobsWrite' permission. The request body must include the 'jobPostingId' to identify the job posting to update. Optionally, a new 'title' and 'description' can be provided. The description must be in HTML format and only certain HTML tags are supported. The response will indicate success and return the updated job posting details, or provide error messages if the update fails.

Location

POST https://api.ashbyhq.com/location.create : The Create Location or Location Hierarchy API allows users to create a new location or a hierarchy of locations. It requires the 'organizationWrite' permission. The request body must include the 'name' and 'type' of the location, and can optionally include the 'address', 'parentLocationId', and 'isRemote' status. The response will indicate success and provide details of the created location, or it will return error messages if the input is invalid.
POST https://api.ashbyhq.com/location.info : The Location Information Retrieval API allows users to get details for a single location by its ID. It requires the 'organizationRead' permission. The request must include a JSON body with the 'locationId' parameter, which is a UUID representing the location to fetch. The response can either be a success response containing the location details such as ID, name, archival status, address, and remote status, or an error response with a list of error messages.
POST https://api.ashbyhq.com/location.list : The List All Locations API endpoint allows users to retrieve a list of all locations, excluding regions. The request requires the 'organizationRead' permission. The request body can include an optional parameter 'includeArchived' to specify whether archived locations should be included in the response. The response will return a success status and a list of location objects, each containing details such as id, name, archival status, address, and remote status. In case of an error, the response will include a list of error messages.

Offer

POST https://api.ashbyhq.com/offer.create : The Create Offer API endpoint allows users to create a new offer in the system. It requires the `offersWrite` permission. The request must include the offer process ID, offer form ID, and the offer form details, which include field submissions. The field submissions can include various types of data such as Boolean, Currency, Date, Number, String, ValueSelect, and MultiValueSelect. The response will indicate success or failure and, if successful, will include details about the created offer, such as its ID, application ID, acceptance status, offer status, latest version details, and author information. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/offer.info : The Offer Information Retrieval API allows users to fetch details about a specific offer using its unique ID. This API requires the 'offersRead' permission. The request is made via a POST method to the endpoint 'https://api.ashbyhq.com/offer.info'. The request body must include the 'offerId', which is a UUID representing the offer to be fetched. The response can either be a success or an error. A successful response includes details such as the offer's ID, application ID, acceptance status, offer status, latest version details, and author information. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/offer.list : The offer.list API endpoint is used to retrieve a list of all offers with their latest version. It requires the 'offersRead' permission. The request is made via a POST method to the URL 'https://api.ashbyhq.com/offer.list'. The request body can include parameters such as 'cursor', 'syncToken', 'limit', and 'applicationId' to filter and paginate the results. The response includes a success flag, a list of offers with details such as acceptance status, offer status, latest version details, and author information. The response also indicates if more data is available for pagination and provides a new sync token for subsequent requests.
POST https://api.ashbyhq.com/offer.start : The offer.start endpoint creates and returns an offer version instance that can be filled out and submitted using the `offer.create` endpoint. It requires the `offersWrite` permission. To create a new offer version for a candidate with an in-progress offer process, call the `offer.start` endpoint and then call the `offer.create` endpoint to fill out the newly created offer version form. The request body requires the `offerProcessId`, which is the ID of the offer process to start. The response can either be a success response containing the offer version details or an error response with a list of error messages.

Opening

POST https://api.ashbyhq.com/opening.addJob : The Add Job to Opening API allows users to add a job to an existing opening. It requires the 'jobsWrite' permission. The request body must include 'openingId' and 'jobId', both of which are strings representing the IDs of the opening and the job to be added, respectively. The response will indicate success with a boolean and provide details about the opening, including its state, whether it is archived, and information about the latest version of the opening. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/opening.create : The Create Opening API allows users to create a new job opening. It requires the 'jobsWrite' permission. The request body must include details such as the identifier, description, teamId, locationIds, jobIds, targetHireDate, targetStartDate, isBackfill, employmentType, and openingState. The response will indicate success and provide details of the created opening, including its ID, state, and associated metadata. In case of errors, an error response with a list of error messages will be returned.
POST https://api.ashbyhq.com/opening.info : The Retrieve Opening Information API allows users to retrieve detailed information about a specific job opening using its UUID. This API requires the 'jobsRead' permission. The request must include the 'openingId' in the body, which is the unique identifier of the opening. The response will include detailed information about the opening, such as its state, whether it is archived, and details about the latest version of the opening, including the hiring team, employment type, and other relevant details. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/opening.list : The List Openings API endpoint allows users to retrieve a list of job openings. It requires the 'jobsRead' permission. The request is made via a POST method to the URL 'https://api.ashbyhq.com/opening.list'. The request body can include optional parameters 'cursor' and 'syncToken' to paginate through results and synchronize data. The response includes a success flag and a list of results, each containing details about the job opening such as its ID, state, and latest version information. In case of an error, the response will include a list of error messages.
POST https://api.ashbyhq.com/opening.removeJob : The Remove Job from Opening API allows users to remove a specific job from an opening. It requires the 'jobsWrite' permission. The request is made via a POST method to the endpoint 'https://api.ashbyhq.com/opening.removeJob'. The request body must include 'openingId' and 'jobId', both of which are required. The response can either be a success or an error. A successful response includes details about the opening, such as its state, whether it is archived, and information about the latest version of the opening. An error response includes a list of error messages.
POST https://api.ashbyhq.com/opening.search : The Opening Search API allows users to search for job openings by their identifier. It requires the 'jobsRead' permission. The request is made via a POST method to the endpoint 'https://api.ashbyhq.com/opening.search'. The request body must include a JSON object with the 'identifier' of the opening to search for. The response can either be a success or an error. A successful response includes a list of results with details about each opening, such as its ID, state, and latest version information. An error response includes a list of error messages.
POST https://api.ashbyhq.com/opening.setArchived : The 'Set Archived State of an Opening' API allows users to update the archived state of a specific job opening. It requires the 'jobsWrite' permission. The request is made via a POST method to the endpoint 'https://api.ashbyhq.com/opening.setArchived'. The request body must include 'openingId' (the ID of the opening) and 'archive' (a boolean indicating the desired archived state). The response will indicate success and provide details about the opening, including its ID, state, and latest version information. In case of errors, an error message will be returned.
POST https://api.ashbyhq.com/opening.setOpeningState : The Set Opening State API allows users to update the state of a job opening. It requires the 'jobsWrite' permission. The request is made via a POST method to the endpoint 'https://api.ashbyhq.com/opening.setOpeningState'. The request body must include 'openingId' (the ID of the opening to update), 'openingState' (the new state, which can be 'Draft', 'Approved', 'Open', or 'Closed'), and optionally 'closeReasonId' if the state is being set to 'Closed'. The response will indicate success and provide details of the updated opening, including its ID, state, and other metadata. In case of errors, an error response with a list of error messages will be returned.
POST https://api.ashbyhq.com/opening.update : The Update Opening API allows users to update an existing job opening. It requires the 'jobsWrite' permission. The request body can include parameters such as 'openingId', 'identifier', 'description', 'teamId', 'targetHireDate', 'targetStartDate', 'isBackfill', and 'employmentType'. The response will indicate success or failure and provide details about the updated opening, including its ID, state, and latest version information.

Referral

POST https://api.ashbyhq.com/referral.create : The Create Referral API endpoint allows users to create a new referral in the system. It requires the `candidatesWrite` permission. The request must include the referral form ID, the user ID of the person submitting the referral, and the field submissions. Optionally, a creation timestamp can be provided. The response will indicate success and provide details about the created referral, including its ID, creation and update timestamps, status, candidate information, interview stage, source, job details, credited user, and hiring team. In case of errors, an error response will be returned with a list of error messages.
POST https://api.ashbyhq.com/referralForm.info : The Referral Form Information API fetches the default referral form or creates one if it does not exist. It requires the 'hiringProcessMetadataRead' permission. The API is accessed via a POST request to the specified endpoint with an 'accept' header set to 'application/json'. The response can either be a success or an error. A successful response includes details about the referral form, such as its ID, title, and form definition. An error response includes a list of error messages.

Source

POST https://api.ashbyhq.com/source.list : The 'List All Sources' API endpoint allows users to retrieve a list of all sources. It requires the 'hiringProcessMetadataRead' permission. The request is made via a POST method to the URL 'https://api.ashbyhq.com/source.list'. The request body can include an optional 'includeArchived' boolean parameter to specify whether archived items should be included. The response will include a 'success' boolean indicating if the request was successful, and if successful, a 'results' array containing source objects with 'id', 'title', 'isArchived', and 'sourceType' details. If there are errors, an 'errors' array will be returned with error messages.

Survey Form Definition

POST https://api.ashbyhq.com/surveyFormDefinition.info : The Survey Form Definition Information API returns details about a single survey form definition by its ID. It requires the 'hiringProcessMetadataRead' permission. The request must include the 'surveyFormDefinitionId' in the body as a UUID. The response includes details such as the form's ID, title, archival status, form definition, and survey type. The API returns a success response with the form details or an error response with a list of error messages.
POST https://api.ashbyhq.com/surveyFormDefinition.list : The List Survey Form Definitions API endpoint allows users to retrieve a list of all survey form definitions. It requires the 'hiringProcessMetadataRead' permission. The request is made via a POST method to the specified URL with headers indicating the expected response and request body media types as 'application/json'. The request body can include optional parameters such as 'cursor' for pagination, 'syncToken' for synchronization, and 'limit' to specify the number of items to return. The response can either be a success or an error. A successful response includes a list of survey form definitions with details such as form ID, title, archived status, and form definition details. An error response includes a success flag set to false and a list of error messages.

Survey Request

POST https://api.ashbyhq.com/surveyRequest.create : The Create Survey Request API endpoint generates a survey request and returns a survey URL. This URL can be shared with a candidate to allow them to complete a survey. The request requires the `candidatesWrite` permission. The request body must include `candidateId`, `applicationId`, and `surveyFormDefinitionId`, all of which are UUIDs. The response will include a success flag and, if successful, details of the survey request including the survey URL. If unsuccessful, an error response with a list of error messages will be returned.

Survey Submission

POST https://api.ashbyhq.com/surveySubmission.list : The surveySubmission.list API endpoint allows users to list all survey submissions of a specified survey type. It requires the 'candidatesRead' permission. The request body must include the 'surveyType' parameter, which specifies the type of survey submissions to fetch. Optional parameters include 'cursor', 'syncToken', and 'limit', which control pagination and data synchronization. The response includes a success flag, pagination information, and an array of survey submission results, each containing details such as the submission ID, candidate ID, application ID, survey type, form definition, and submitted values. In case of errors, the response will include an error message.

User

POST https://api.ashbyhq.com/user.info : The Get Ashby User Information API allows you to retrieve information about a specific user in the Ashby system by their user ID. This API requires the 'organizationRead' permission. The request must include a JSON body with the 'userId' parameter, which is a UUID representing the user to be looked up. The response will either be a success response containing user details such as id, firstName, lastName, email, globalRole, isEnabled, and updatedAt, or an error response with a list of error messages.
POST https://api.ashbyhq.com/user.list : The List Users API endpoint allows you to retrieve a list of all Ashby users. It requires the 'organizationRead' permission. The request body can include parameters such as 'cursor' for pagination, 'syncToken' for synchronization, 'limit' to specify the number of items to return, and 'includeDeactivated' to include deactivated users in the response. The response includes user details such as 'id', 'firstName', 'lastName', 'email', 'globalRole', 'isEnabled', and 'updatedAt'. The 'globalRole' property specifies the user's access level in Ashby. The response can also indicate if more data is available for pagination.
POST https://api.ashbyhq.com/user.search : The User Search by Email API allows you to search for an Ashby user using their email address. It requires the 'organizationRead' permission. The request must include the email in the request body. The response will indicate success and provide user details such as id, firstName, lastName, email, globalRole, isEnabled, and updatedAt if successful. In case of an error, the response will include a list of error messages.

Webhook

POST https://api.ashbyhq.com/webhook.create : The Create Webhook Setting API allows users to create a webhook setting by specifying the type of webhook, the URL to which the webhook will send requests, and a secret token for signing the webhook request. The request requires the 'apiKeysWrite' scope for authentication. The request body must include 'webhookType', 'requestUrl', and 'secretToken' as required fields. The response will indicate success with a boolean and provide details of the created webhook setting, including its ID, enabled status, request URL, secret token, and webhook type. In case of errors, an error response will be returned with a list of error messages.
POST https://api.ashbyhq.com/webhook.delete : The Delete Webhook Setting API allows users to delete a specific webhook setting by providing the webhook ID. It requires the 'apiKeysWrite' permission. The request must include the 'webhookId' in the body as a UUID string. The response will indicate success with a boolean and return the deleted 'webhookId' if successful, or an array of error messages if there was an error.

‍

Ashby API Use Case Examples

Ashby API FAQs

General API Questions

What is the Ashby API?
The Ashby API is a RESTful interface that allows developers to programmatically interact with Ashby’s recruiting and ATS (Applicant Tracking System) data—such as jobs, candidates, interviews, offers, and more.
‍Who can use the Ashby API?
Organizations that use Ashby can enable API access for internal developers or partners to build integrations, automate workflows, sync HR data, or build reporting dashboards.‍
Where can I find the official Ashby API documentation?
You can find Ashby's full API documentation here: https://developers.ashbyhq.com

Authentication & Access

How is the Ashby API authenticated?
Ashby uses API keys for authentication. Each request must include the API key in the Authorization header as a Bearer token.
‍How can I generate an API key in Ashby?
Log in to your Ashby admin dashboard, navigate to Developer Settings, and generate a new API key. API keys should be securely stored as they provide access to sensitive recruiting data.‍
Can I restrict permissions on an API key?
Yes. You can scope API keys to specific types of data (e.g., read-only access to candidates or jobs), improving security and compliance.

Functionality & Endpoints

‍What data can I access with the Ashby API?
You can access and manage:
1. Job postings
2. Applications
3. Candidates
4. Interviews and scheduling data
5. Offers
6. Feedback and notes
7. Custom fields
8. Reports and analytics (in some plans)‍
Does Ashby support webhooks?
Yes. Ashby supports webhooks for key events such as:
1. Candidate created/updated
2. Application status changes
3. Offer updates
4. Interview scheduling changes‍
Does Ashby API support pagination?
Yes. Most list endpoints are paginated. You can use query parameters like limit and cursor to navigate large datasets.

‍Usage & Best Practices

‍Can I integrate Ashby with my HRIS or CRM using the API?
Absolutely. You can sync Ashby data with your HR systems (like BambooHR, Workday), CRMs (like Salesforce), or analytics tools using Ashby's API or third-party platforms like Knit.‍
Is there a sandbox or test environment?
Currently, Ashby doesn't provide a public sandbox. It’s recommended to create a test workspace or use demo data within your production environment (with restricted keys) for development and testing.‍
What rate limits apply to the Ashby API?
Ashby enforces rate limits per API key. While the limits are generous, if you expect high-volume syncs, contact Ashby support to discuss rate limit increases.

Troubleshooting & Support

‍My API request failed—how can I debug it?
Check the response code and message. Common issues include:‍
1. 401 Unauthorized: Missing or invalid API key‍
2. 403 Forbidden: Insufficient permissions‍
3. 429 Too Many Requests: Rate limit exceeded‍
4. 500 Internal Server Error: Ashby-side issue‍
How do I contact support for API-related issues?
You can reach out to Ashby support through the in-app chat or email. For technical API support, you may also reference the Ashby Developer Docs or ask for direct developer assistance.‍
Does Ashby offer SDKs or client libraries?
Not at the moment. Ashby provides a standard REST API and recommends using any HTTP client or tools like Postman, cURL, or libraries like Axios, requests, or Fetch.

Leveraging Knit For Ashby API Integration

For quick and seamless integration with Ashby API, Knit API offers a convenient solution. It's AI powered integration platform allows you to build any Ashby API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, HRIS, Payroll and other systems. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Ashby API.

‍

To sign up for free, click here. To check the pricing, see our pricing page.

Freshteams API Directory

Freshteam is a comprehensive HR software solution designed to streamline recruitment, onboarding, and employee management processes. As part of the Freshworks suite, Freshteam offers a user-friendly interface that simplifies the complexities of human resource management, making it an essential tool for businesses of all sizes. By automating repetitive tasks and providing a centralized platform for managing employee data, Freshteam enhances efficiency and productivity within HR departments.

One of the standout features of Freshteam is its robust API integration capabilities. The Freshteams API allows businesses to seamlessly connect Freshteam with other software applications, facilitating data exchange and enhancing workflow automation. This integration capability is crucial for organizations looking to create a cohesive HR ecosystem, enabling them to leverage the full potential of Freshteam alongside their existing tools. By utilizing the Freshteams API, companies can customize their HR processes to better suit their unique needs, ensuring a more tailored and efficient approach to human resource management.

Key highlights of freshteam APIs

Easy Data Access:
- Access employee information effortlessly with Freshteam API's streamlined data retrieval capabilities.
Automation:
- Enhance efficiency through seamless data synchronization and automated HR processes.
Custom Integration:
- Integrate with various platforms using a unified API for multiple integrations, tailored to your business needs.
Real-Time Sync:
- Keep your data up-to-date with real-time updates, ensuring accuracy across all systems.
Developer-Friendly:
- Benefit from an accessible API design, SDKs, and comprehensive documentation for easy implementation.

Employee Management

put /api/employees/{id}/send_invite : Send Employee Portal Invitation Email
get https://<account-name>.freshteam.com/api/employees : List All Employees
put https://<account-name>.freshteam.com/api/employees/{id} : Update Employee Information
post https://<account-name>.freshteam.com/api/employee_fields : Create Custom Employee Field
post https://<account-name>.freshteam.com/api/new_hires : Create a New Hire
put https://<account-name>.freshteam.com/api/new_hires/{id} : Update New Hire Information

Organizational Structure

get https://<account-name>.freshteam.com/api/branches : List All Branches
get https://<account-name>.freshteam.com/api/business_units : List All Business Units
get https://<account-name>.freshteam.com/api/departments : List All Departments
get https://<account-name>.freshteam.com/api/sub_departments : List All Sub-Departments
get https://<account-name>.freshteam.com/api/teams : List All Teams
get https://<account-name>.freshteam.com/api/roles : List All Roles
get https://<account-name>.freshteam.com/api/levels : List All Levels

Recruitment

get https://<account-name>.freshteam.com/api/candidate_source_categories : List All Candidate Source Categories
post https://<account-name>.freshteam.com/api/candidate_sources : Create Candidate Source
get https://<account-name>.freshteam.com/api/job_posting_fields : List All Job Posting Fields
get https://<account-name>.freshteam.com/api/job_postings : List All Job Postings
get https://<account-name>.freshteam.com/api/job_postings/{id} : Retrieve Job Posting Information
get https://<account-name>.freshteam.com/api/job_postings/{id}/applicant_fields : List All Applicant Fields
post https://<account-name>.freshteam.com/api/job_postings/{id}/applicants : Create an Applicant for a Job Posting

Time Off Management

get https://<account-name>.freshteam.com/api/time_off_types : List All Timeoff Types
get https://<account-name>.freshteam.com/api/time_offs : List All Timeoffs
get https://<account-name>.freshteam.com/api/time_offs/{id} : Retrieve Timeoff Information
put https://<account-name>.freshteam.com/api/time_offs/{id}/approve : Approve a Timeoff Request
put https://<account-name>.freshteam.com/api/time_offs/{id}/cancel : Cancel a Timeoff Request

User Functions

get https://<account-name>.freshteam.com/api/user_functions : List all user functions

‍

Freshteam API FAQs

How do I obtain an API key in Freshteam?

Answer: To obtain your API key in Freshteam:some text
1. Log in to your Freshteam account.
2. Click on your profile icon in the top-right corner.
3. Select API Settings from the dropdown menu.
4. Your API key will be displayed under Your API Key.
Source: Freshteam API Documentation

What authentication method does the Freshteam API use?

Answer: The Freshteam API uses OAuth 2.0 for authentication. You need to obtain an access token by making a call to the Freshteam authentication server and include this token in the Authorization header of your API requests.
Source: Freshteam API Documentation

Are there rate limits for the Freshteam API?

Answer: Yes, Freshteam enforces rate limits based on your subscription plan and the number of subscribed employees:some text
- Free Plan: No API access.
- Trial Plan: 10 requests per minute.
- Growth and Pro Plans: Maximum of 50 requests per minute.
- Enterprise Plan: Maximum of 100 requests per minute.
Source: Freshteam API Documentation

Can I retrieve employee data using the Freshteam API?

Answer: Yes, you can retrieve employee data by making a GET request to the /employees endpoint. This will return a list of employees and their details.
Source: Freshteam API Documentation

Does the Freshteam API support webhooks?

Answer: Yes, Freshteam supports webhooks, allowing you to receive real-time notifications for specific events, such as when a new employee is added or an employee's information is updated.
Source: Freshteam Developers

‍

Get Started with Freshteam API Integration

For quick and seamless integration with Freshteam API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Freshteam API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Freshteam API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Rippling API Directory

Rippling is a versatile software platform that revolutionizes human resources and business operations management. It offers a comprehensive suite of tools designed to streamline and automate various aspects of employee management, making it an essential asset for businesses looking to enhance efficiency. Key functionalities include payroll management, which automates payroll processing, ensuring compliance and accuracy with tax calculations and filings across federal, state, and local agencies. Additionally, Rippling supports global payroll, enabling businesses to seamlessly pay employees worldwide, thus catering to the needs of international operations.

Beyond payroll, Rippling excels in HR management by providing tools for managing employee information, benefits administration, and ensuring compliance with HR regulations. Its IT management features allow businesses to manage employee devices, apps, and access permissions, effectively integrating IT management with HR processes. Furthermore, Rippling automates onboarding and offboarding processes, ensuring efficient setup and removal of employee access and tools. The platform also offers time tracking and attendance management features, helping businesses monitor and manage employee work hours efficiently. With its integrated solution, Rippling significantly streamlines administrative tasks and enhances operational efficiency in HR and IT management. For developers and businesses looking to extend these capabilities, the Rippling API offers seamless integration options, making it a powerful tool for customized business solutions.

Key highlights of Rippling APIs

Automation of HR Functions
- Automates tasks like employee onboarding, benefits management, and payroll processing, saving time and reducing errors.
Centralized Benefits Management
- Allows HR teams to manage employee benefits, such as health insurance and retirement plans, in one system, improving efficiency.
Data Synchronization
- Ensures up-to-date and consistent employee information across different systems.
REST API Integration
- Enables developers to integrate Rippling with other systems, allowing for customization to meet specific business needs.
Seamless HR and IT Integration
- Supports integration of HR and IT processes, enhancing employee experience by making processes faster and more efficient.
Third-Party Integrations
- Can be integrated with applications like 15Five to facilitate data exchange and improve workflow efficiency.

Rippling API Endpoints

Candidate Management

POST https://api.rippling.com/platform/api/ats_candidates/push_candidate : This API endpoint allows applications integrating with OAuth2.0 to push a candidate from an applicant tracking system directly into the Rippling onboarding flow. The request requires a bearer token for authorization and includes candidate details such as name, email, job title, phone number, and other employment-related information. The response returns the same candidate details as confirmation of successful onboarding.

Employee Management

GET https://api.rippling.com/platform/api/employees : The Get Active Employees List API retrieves a list of active employees currently provisioned within the application. The response includes various details about each employee, such as their unique role ID, user ID, name, employment type, title, gender, department, work location, role state, and more. The API requires a bearer token for authorization, which should be included in the request headers. Optional query parameters 'limit' and 'offset' can be used for pagination, with a recommended maximum limit of 100. The response is an array of employee objects, each containing detailed information about the employee.
GET https://api.rippling.com/platform/api/employees/include_terminated : The Get Active and Terminated Employees API endpoint retrieves a list of both active and terminated employees from the Rippling platform. It requires an Authorization header with a bearer token for access. The API supports pagination through 'limit' and 'offset' query parameters, with a maximum limit of 100. Additional query parameters include 'EIN' for the employer identification number and 'send_all_roles' to bypass access rules and retrieve all employees. The response includes detailed employee information such as ID, name, employment type, department, work location, role state, and more. The API is designed to provide comprehensive employee data for integrations and compliance purposes.
GET https://api.rippling.com/platform/api/employees/{employeeId} : The Get Employee Information API retrieves detailed information about a specific employee identified by the employeeId path parameter. The request requires an Authorization header with a bearer token. The response includes comprehensive details about the employee, such as their name, employment type, work location, role state, and more. The API provides a structured response with fields like id, name, employmentType, gender, department, workLocation, and customFields, among others.

Leave Management

GET https://api.rippling.com/platform/api/leave_balances : This API retrieves the leave balances for employees. It requires an Authorization header with a bearer token for access. The API supports optional query parameters 'limit' and 'offset' to control pagination. The response includes an array of roles, each containing a list of leave balances. Each balance entry specifies the company leave type, whether the balance is unlimited, and the remaining balance in minutes with and without future leave requests considered.
GET https://api.rippling.com/platform/api/leave_balances/{role} : This API retrieves the leave balances for a given role, where a role represents a single employee. The request requires a bearer token for authorization, provided in the Authorization header. The role ID, which is a path parameter, uniquely identifies the employee. The response includes the role ID and an array of leave balances, each with details such as the company leave type ID, whether the balance is unlimited, and the remaining balance in minutes with and without future leave requests considered.
GET https://api.rippling.com/platform/api/leave_requests : This API retrieves the current leave requests from the Rippling platform. It allows filtering by various query parameters such as endDate, startDate, status, and more. The request requires an Authorization header with a bearer token. The response includes detailed information about each leave request, such as the employee's role, status, dates, and the system managing the leave request.
PATCH https://api.rippling.com/platform/api/leave_requests/{id} : The Update Leave Request API allows users to modify an existing leave request by providing the unique identifier of the leave request in the path parameters. The request requires an Authorization header with a bearer token for authentication. The body of the request can include various fields such as 'requestedBy', 'status', 'startDate', 'endDate', 'startDateStartTime', 'endDateEndTime', 'startDateCustomHours', 'endDateCustomHours', and 'reasonForLeave'. The response returns a detailed leave request object, including fields like 'id', 'createdAt', 'updatedAt', 'role', 'roleName', 'requestedBy', 'requestedByName', 'status', 'startDate', 'endDate', 'startDateStartTime', 'endDateEndTime', 'startDateCustomHours', 'endDateCustomHours', 'comments', 'numHours', 'numMinutes', 'leavePolicy', 'leaveTypeUniqueId', 'policyDisplayName', 'reasonForLeave', 'processedAt', 'processedBy', 'processedByName', 'roleTimezone', 'dates', 'managedBy', and 'partialDays'.
POST https://api.rippling.com/platform/api/leave_requests/{id}/process : This API allows an admin or manager to approve or decline a pending leave request. The request requires a bearer token for authorization and includes a path parameter for the leave request ID and a query parameter for the action (approve or decline). The response includes detailed information about the leave request, such as the employee's role, status, dates, and whether the leave is paid.

Group Management

POST https://api.rippling.com/platform/api/groups : This API endpoint allows the creation of a generic group that can be associated within a third-party application. The request requires a bearer token for authorization, and the body must include a name, a unique spokeId, and an array of user IDs. Upon successful creation, the API returns the group's unique identifier, name, spokeId, user IDs, and version.
PUT https://api.rippling.com/platform/api/groups/{groupId} : The 'Update Group in Rippling' API allows third-party applications to update all fields of a group within Rippling organizations using the PUT method. The endpoint requires an OAuth application for authorization. The request must include a bearer token in the Authorization header. The groupId path parameter is required to specify the unique identifier of the group. The request body can include optional fields such as name, spokeId, users, and version to update the group's details. The response returns the updated group details, including the id, spokeId, name, users, and version.

Application Management

POST https://api.rippling.com/platform/api/mark_app_installed : This API endpoint is used to mark an app as installed in Rippling. It is a POST request to the URL 'https://api.rippling.com/platform/api/mark_app_installed'. The request requires an Authorization header with a bearer token, and the headers 'Accept' and 'Content-Type' set to 'application/json'. The response returns a JSON object with a boolean 'ok' field indicating whether the app was successfully marked as installed. No request body is required.

User Information

GET https://api.rippling.com/platform/api/me : The GET Current User Information API retrieves basic information about the Rippling user whose access token is being used. This API is typically used in the SSO flow. The request requires an Authorization header with a bearer token. The response includes the user's unique identifier, work email, and the unique identifier of the company.
GET https://api.rippling.com/platform/api/saml/idp_metadata : The Get SAML Metadata API endpoint provides a SAML IDP metadata file for the current app integration. This endpoint is accessible only with a token associated with an app integration that has SAML enabled. The metadata is unique per customer app installation and changes with each new installation. To access this endpoint, include your bearer token in the Authorization header. The response is an XML string containing the SAML metadata. If the token is invalid or the app does not have SAML enabled, a 404 error is returned.

‍

Rippling API FAQs

How do I access the Rippling API?

Answer: To access the Rippling API, you need to generate an API token. Navigate to the 'API Tokens' section in your Rippling account settings, create a new token, and securely store it, as it will not be displayed again.
Source: API Tokens - Rippling

‍

What authentication method does the Rippling API use?

Answer: The Rippling API uses token-based authentication. Include the API token in the 'Authorization' header of your HTTP requests, formatted as 'Bearer YOUR_API_TOKEN'.
Source: Rippling Platform API

‍

Are there rate limits for the Rippling API?

Answer: Yes, the Rippling API enforces rate limits to ensure fair usage. While specific limits are not publicly documented, it's recommended to implement error handling for potential 429 Too Many Requests responses.
Source: Rippling API - Developer docs, APIs, SDKs, and auth.

‍

Can I retrieve employee data using the Rippling API?

Answer: Yes, you can retrieve employee data by making a GET request to the '/employees' endpoint. Ensure you have the necessary permissions and that your API token has access to the required scopes.
Source: Rippling Platform API

‍

Does the Rippling API support webhooks?

Answer: Yes, the Rippling API supports webhooks, allowing you to receive real-time notifications for specific events. You can configure webhooks to trigger on events such as employee onboarding or offboarding.
Source: Rippling API - Developer docs, APIs, SDKs, and auth.

‍

Get Started with Rippling API Integration

For quick and seamless integration with Rippling API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Rippling API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Rippling API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍

HiBob API Directory

HiBob is a cutting-edge human resources management software that revolutionizes the way businesses handle HR tasks. Known as "Bob," this platform offers a comprehensive suite of features designed to streamline HR processes and enhance employee management. From onboarding workflows to time and attendance management, HiBob provides tools that simplify the complexities of HR operations. Its robust capabilities also include compensation analysis, performance reviews, and workforce planning, making it an indispensable asset for modern HR departments.

One of the standout features of HiBob is its ability to integrate seamlessly with other systems through the HiBob API. This integration capability allows businesses to connect HiBob with their existing software infrastructure, ensuring a smooth flow of data and enhancing operational efficiency. By leveraging the HiBob API, companies can customize their HR processes, automate repetitive tasks, and gain valuable insights into their workforce, ultimately driving better decision-making and fostering a more engaged and productive work environment.

Key highlights of HiBob APIs

The HiBob API offers developers a comprehensive suite of tools to integrate and automate various human resources processes within their applications. Below are the key highlights of the HiBob API:

Core Functionalities:

Employee Management: Access and manage detailed information about employees, including personal details, employment history, and contact information. HiBob API Documentation
Time Off Management: Retrieve and handle data related to employee leave requests, balances, and histories.
Reports Generation: Generate and access various reports to gain insights into HR metrics and organizational data.
Onboarding Integration: Integrate with Applicant Tracking Systems (ATS) to streamline the onboarding process for new hires. HiBob API Documentation

Integration Use Cases:

Onboarding Automation: Streamline the onboarding process by integrating employee data into internal systems. HiBob API Documentation
Payroll Synchronization: Ensure consistency between HR records and payroll systems by syncing employee and compensation data.
Custom Reporting: Generate tailored reports by extracting and analyzing HR data to meet specific business needs.

Supported Protocols:

RESTful API: The HiBob API follows REST principles, facilitating straightforward HTTP requests and responses.

Authentication Mechanisms:

Service User Authentication: Secure access is granted through service user credentials, which include a unique ID and token. HiBob API Documentation

Rate Limiting Policies:

Usage Limits: While specific rate limits are not publicly detailed, it's advisable to implement efficient API call practices and handle potential rate limit responses gracefully.

For comprehensive information and to get started with the HiBob API, refer to their official API documentation.

HiBob API Endpoints

Attendance

POST https://api.hibob.com/v1/attendance/import/{importMethod} : The Import Attendance Data API allows you to import attendance records for employees.

Avatars

PUT https://api.hibob.com/v1/avatars/{employeeId} : This API endpoint allows you to upload an employee's avatar by providing a URL to the image.

Bulk People

GET https://api.hibob.com/v1/bulk/people/employment : This API endpoint retrieves a list of historical employment entries from the employment table for all employees or a specific list of employees.
GET https://api.hibob.com/v1/bulk/people/lifecycle : This API endpoint retrieves a list of historical lifecycle entries from the lifecycle table for all employees or a specified list of employees.
GET https://api.hibob.com/v1/bulk/people/salaries : This API endpoint retrieves a list of historical salary entries from the payroll table for all employees or a specified list of employees.
GET https://api.hibob.com/v1/bulk/people/work : This API endpoint retrieves a list of historical work entries from the work table for all employees or a specific list of employees.

Company

GET https://api.hibob.com/v1/company/named-lists : The Get Company Named Lists API retrieves named lists from the company database.
POST https://api.hibob.com/v1/company/named-lists/{listName} : This API endpoint allows you to create a new item in a named list within the company.
DELETE https://api.hibob.com/v1/company/named-lists/{listName}/{itemId} : This API endpoint deletes a specific item from a named list in the company database.
GET https://api.hibob.com/v1/company/people/fields : This API endpoint retrieves metadata about employee fields, including all employee fields.
DELETE https://api.hibob.com/v1/company/people/fields/{fieldId} : This API endpoint deletes a specific field from the company people fields in the HiBob system.
GET https://api.hibob.com/v1/company/reports : The Get Company Reports API endpoint returns a list of all the company reports with their details.
GET https://api.hibob.com/v1/company/reports/{reportId}/download : The Download Company Report API allows users to download a report data file in the specified format.
GET https://api.hibob.com/v1/company/reports/{reportId}/download-async : This API endpoint asynchronously generates a report based on the specified format (csv or xlsx).

Docs

GET https://api.hibob.com/v1/docs/folders/metadata : This API endpoint retrieves a list of available folders and their metadata, including the folder ID, name, and type.
GET https://api.hibob.com/v1/docs/people/{id} : This API endpoint retrieves a list of documents and their download links for a specified employee.
POST https://api.hibob.com/v1/docs/people/{id}/confidential/upload : This API endpoint allows you to upload a file directly into a confidential folder of a specific employee in Bob.
DELETE https://api.hibob.com/v1/docs/people/{id}/confidential/{docId} : This API endpoint is used to delete a specific document from a confidential folder of a specific employee in Bob.
POST https://api.hibob.com/v1/docs/people/{id}/folders/{folderId}/upload : This API endpoint allows you to upload a file directly into a custom folder of a specific employee in Bob.
DELETE https://api.hibob.com/v1/docs/people/{id}/folders/{folderId}/{docId} : This API endpoint is used to delete a specific document from a custom folder of a specific employee in Bob.
POST https://api.hibob.com/v1/docs/people/{id}/shared/upload : This API endpoint allows you to upload a file directly into a shared folder of a specific employee in Bob.
DELETE https://api.hibob.com/v1/docs/people/{id}/shared/{docId} : This API endpoint is used to delete a specific document from a shared folder of a specific employee in Bob.

Employees

POST https://api.hibob.com/v1/employees/{employeeId}/invitations : This API endpoint is used to send an invitation to an employee using their Employee ID or email address.
POST https://api.hibob.com/v1/employees/{employeeId}/start-date : This API sets the start date for an employee in the HiBob system.
POST https://api.hibob.com/v1/employees/{identifier}/terminate : This API endpoint is used to change an employee's status to Terminated according to a specified termination date.
POST https://api.hibob.com/v1/employees/{identifier}/uninvite : The Uninvite Employee API is used to revoke access for an employee in the system.

Hiring

POST https://api.hibob.com/v1/hiring/job-ads/search : This API endpoint allows users to search for active job ads as promoted on the Bob career page.
GET https://api.hibob.com/v1/hiring/job-ads/{id} : This API endpoint retrieves the details of a specific job ad that was promoted on the Bob careers page.

Metadata

GET https://api.hibob.com/v1/metadata/objects/position : This API endpoint retrieves a list of all fields of the object type 'position'.

Objects

POST https://api.hibob.com/v1/objects/position/search : This API endpoint allows users to search for company positions by specifying fields to retrieve and filters to apply.

Onboarding

GET https://api.hibob.com/v1/onboarding/wizards : This API endpoint retrieves information about onboarding wizards.

Payroll

GET https://api.hibob.com/v1/payroll/history : The Get Payroll History API retrieves payroll data for employees.

People

POST https://api.hibob.com/v1/people : This API endpoint creates a new employee record in Bob.
GET https://api.hibob.com/v1/people/custom-tables/metadata : This API endpoint retrieves metadata for custom tables in the system.
GET https://api.hibob.com/v1/people/custom-tables/metadata/{custom_table_id} : This API endpoint retrieves metadata for a specific custom table identified by the 'custom_table_id' path parameter.
POST https://api.hibob.com/v1/people/custom-tables/{employee_id}/{custom_table_id} : This API endpoint allows you to create an entry in a custom table for a specific employee.
DELETE https://api.hibob.com/v1/people/custom-tables/{employee_id}/{custom_table_id}/{entry_id} : This API endpoint deletes a specific entry from a custom table for a given employee in the HiBob system.
POST https://api.hibob.com/v1/people/search : This API endpoint allows you to search and retrieve data fields of employees using a POST request.
PUT https://api.hibob.com/v1/people/{identifier} : This API endpoint updates the employee record in Bob.
POST https://api.hibob.com/v1/people/{id} : This API endpoint allows you to update employee details by adding equity grants, salary entries, and variable payments for a specific employee identified by their ID.
GET https://api.hibob.com/v1/people/{id}/bank-accounts : This API endpoint retrieves a list of bank account entries for a specified employee.
DELETE https://api.hibob.com/v1/people/{id}/bank-accounts/{entry_id} : This API endpoint allows you to delete a specific bank account entry for an employee using their employee ID and the bank account entry ID.
GET https://api.hibob.com/v1/people/{id}/compensation : This API endpoint retrieves comprehensive compensation details for a specified employee, including salary history, variable payments, and equity grants.
PUT https://api.hibob.com/v1/people/{id}/email : This API endpoint allows changing an employee's email address.
POST https://api.hibob.com/v1/people/{id}/employment : This API endpoint is used to add an employment entry for a specific employee identified by their ID.
DELETE https://api.hibob.com/v1/people/{id}/employment/{entry_id} : The Delete Employment Entry API allows you to delete a specific employment entry for a given employee.
GET https://api.hibob.com/v1/people/{id}/equities : This API endpoint retrieves a list of equity grants for a specified employee.
DELETE https://api.hibob.com/v1/people/{id}/equities/{entry_id} : This API endpoint deletes a specific equity entry for an employee.
GET https://api.hibob.com/v1/people/{id}/lifecycle : This API endpoint retrieves a list of life-cycle history entries for a specified employee.
GET https://api.hibob.com/v1/people/{id}/salaries : This API endpoint retrieves a list of salary history entries for a specified employee.
DELETE https://api.hibob.com/v1/people/{id}/salaries/{entry_id} : This API endpoint allows the deletion of a specific salary entry for an employee.
GET https://api.hibob.com/v1/people/{id}/training : This API endpoint retrieves a list of training records for a specified employee.
DELETE https://api.hibob.com/v1/people/{id}/training/{entry_id} : This API endpoint deletes a specific training entry for an employee.
POST https://api.hibob.com/v1/people/{id}/variable : This API endpoint is used to add a variable payment for an employee in the HiBob system.
DELETE https://api.hibob.com/v1/people/{id}/variable/{entry_id} : This API endpoint allows the deletion of a specific variable entry for an employee in the HiBob system.
POST https://api.hibob.com/v1/people/{id}/work : This API endpoint is used to add a work entry for an employee identified by their ID.
PUT https://api.hibob.com/v1/people/{id}/work/{entry_id} : This API endpoint updates an entry in the employee’s work history table.

Profiles

GET https://api.hibob.com/v1/profiles : The Get Employee Profiles API endpoint retrieves a predefined list of fields for all active employees that the service user can access.

Tasks

GET https://api.hibob.com/v1/tasks : This API endpoint retrieves all open tasks for a company.
GET https://api.hibob.com/v1/tasks/people/{id} : This API retrieves all tasks for a specific employee.
POST https://api.hibob.com/v1/tasks/{taskId}/complete : This API endpoint is used to mark a task as complete.

Time Off

POST https://api.hibob.com/v1/timeoff/employees/{id}/adjustments : This API endpoint allows you to create a balance adjustment for a specific employee identified by their ID or email address.
GET https://api.hibob.com/v1/timeoff/employees/{id}/balance : This API retrieves the time off balance for a specified employee based on a given policy type and date.
POST https://api.hibob.com/v1/timeoff/employees/{id}/requests : This API endpoint allows the submission of a new time off request for an employee.
DELETE https://api.hibob.com/v1/timeoff/employees/{id}/requests/{requestId} : The Cancel Time Off Request API allows you to cancel an existing time off request for an employee.
GET https://api.hibob.com/v1/timeoff/outtoday : This API endpoint returns a list of people who have a time off request for today or a specified date.
GET https://api.hibob.com/v1/timeoff/policies : This API endpoint retrieves details about a specific time off policy by its name.
GET https://api.hibob.com/v1/timeoff/policies/names : This API endpoint retrieves a list of policy names for a user's defined policy type.
GET https://api.hibob.com/v1/timeoff/policy-types : This API endpoint retrieves a list of all policy type names available in the system.
GET https://api.hibob.com/v1/timeoff/policy-types/{policyType} : This API endpoint retrieves details about a specific policy type in the time-off system.
POST https://api.hibob.com/v1/timeoff/policy-types/{policyType}/reason-codes : This API endpoint allows adding a list of reason codes for a specified policy type.
GET https://api.hibob.com/v1/timeoff/requests/changes : This API endpoint retrieves a list of time off requests that have been changed (created, canceled, or deleted) since a specified date.
GET https://api.hibob.com/v1/timeoff/whosout : This API endpoint retrieves time off information for a specified date range.

HiBob API FAQs

How do I get started with the HiBob API?

Answer: To begin using the HiBob API:some text
1. Set up your account by determining your integration type (e.g., developing for your organization or becoming a Bob Partner).
2. Obtain service user credentials for authorization.
3. Utilize the API Reference Guide to test endpoints and develop your application efficiently.
Source: Getting Started with Bob's API

What authentication method does the HiBob API use?

Answer: The HiBob API uses service user credentials for authentication. You need to create a service user in Bob, which provides an ID and Token necessary for authorization. These credentials are then used in the HTTP authorization header for API requests.
Source: API Service Users

Are there rate limits for the HiBob API?

Answer: Yes, HiBob enforces rate limits to ensure fair usage. While specific limits are not detailed in the provided documentation, it's recommended to implement error handling for potential rate limiting responses and to consult HiBob support for detailed rate limit information.
Source: Rate Limiting

Can I retrieve employee data using the HiBob API?

Answer: Yes, you can retrieve employee data using the HiBob API. The /people/search endpoint allows you to access employee fields, including custom fields, based on permissions granted to the service user.
Source: Read Employee Data

Does the HiBob API support webhooks for real-time data updates?

Answer: Yes, HiBob supports webhooks, allowing you to subscribe to events in Bob and be notified in real-time when changes occur. This enables you to build event-driven integrations with HiBob.
Source: Getting Started with Bob Webhooks

Get Started with HiBob API Integration

Knit API offers a convenient solution for quick and seamless integration with HiBob API. Our AI-powered integration platform allows you to build any HiBob API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, CRM, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to HiBob API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Employment Hero API Directory

Employment Hero is a comprehensive cloud-based human resources software solution designed to cater to the needs of small and medium-sized businesses. As an all-in-one platform, it centralizes a variety of HR functions, including hiring, HR management, payroll, and employee engagement, making it an essential tool for businesses looking to streamline their HR processes. The software is highly customizable, allowing organizations to create an integrated Human Resource Information System (HRIS) and payroll system that aligns with their specific requirements. This flexibility ensures that businesses can efficiently manage their workforce while focusing on growth and productivity.

One of the standout features of Employment Hero is its ability to manage the entire employee lifecycle. From recruitment and onboarding to payroll, time and attendance, and people management, the platform offers a suite of modules designed to simplify HR tasks. Additionally, Employment Hero can integrate seamlessly with other HR and payroll software, facilitating the handling of employee data such as new hires, salary adjustments, and benefit deductions. This integration capability, particularly through the Employment Hero API, is crucial for businesses aiming to consolidate their HR operations into a single, cohesive system, thereby enhancing efficiency and reducing administrative burdens.

Key highlights of Employment Hero APIs

Employment Hero offers a suite of APIs designed to facilitate seamless integration with its HR and payroll platforms. These APIs enable developers to automate processes, manage employee data, and integrate various HR functionalities into their applications. Below is an overview of the available APIs, their functionalities, authentication methods, and rate limits.

Available APIs and Functionalities:

HRIS API:
- Functionality: Provides access to core HR data, including employee records, organizational information, and related HR functionalities.
- Use Cases: Automating employee onboarding, updating employee details, and retrieving organizational data.
- Documentation: Employment Hero API - Australia
Payroll API:
- Functionality: Offers endpoints to manage payroll operations, such as processing payroll, managing deductions, and generating payslips.
- Use Cases: Automating payroll calculations, integrating with accounting systems, and retrieving payroll reports.
- Documentation: Employment Hero Payroll API Reference - KeyPay
Careers Page API:
- Functionality: Allows integration of Employment Hero's careers page with an organization's website, ensuring job listings are synchronized.
- Use Cases: Displaying current job openings on a company's website and automating job posting updates.
- Documentation: API Reference 1 - Australia

Authentication Methods:

OAuth 2.0:
- Employment Hero's APIs primarily use OAuth 2.0 for secure authentication. Developers must register their applications through the Employment Hero Developer Portal to obtain client credentials (Client ID and Client Secret). The authentication flow involves obtaining an access token, which is then used to authorize API requests.
- Steps:
  1. Register your application in the Developer Portal.
  2. Obtain client credentials.
  3. Authorize the application to receive an authorization code.
  4. Exchange the authorization code for an access token.
  5. Use the access token to authenticate API requests.
- Reference: API Reference - Australia
API Key Authentication:
- Some APIs, like the Careers Page API, utilize API key authentication. Users can generate an API access token within the Employment Hero platform, which is then included in the request headers to authenticate API calls.
- Reference: API Reference 1 - Australia

Rate Limits:

Employment Hero enforces rate limits to ensure fair usage and maintain system performance. While specific rate limits may vary across different APIs, it's essential to implement error handling for potential rate limiting responses. Developers are advised to consult the respective API documentation or contact Employment Hero support for detailed rate limit information.

Additional Resources:

Developer Portal: Access to API documentation, client registration, and other developer tools.some text
- Employment Hero API - Australia
Payroll API Reference: Detailed documentation for payroll-related API endpoints.some text
- Employment Hero Payroll API Reference - KeyPay

For comprehensive information and to get started with the Employment Hero API, refer to their official API documentation. Employment Hero Developer

‍

Employment Hero API Endpoints

Organisation APIs

GET https://api.employmenthero.com/api/v1/organisations : This API retrieves a list of organisations from Employment Hero. The request must include an access token in the Authorization header, which is obtained from the Employment Hero Authorisation Server. The API uses the GET method and the endpoint is https://api.employmenthero.com/api/v1/organisations. The response includes details of each organisation such as its unique identifier, name, creation date, and last update date.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id : This API endpoint retrieves detailed information about a specific organisation using its UUID. The request requires an Authorization header with a bearer token for authentication. The response includes various details about the organisation such as its name, phone number, country, logo URL, primary address, end of week, typical work day, payroll admin emails, subscription plan, superfund name, employee counts, time zone, and creation date.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/certifications : This API endpoint retrieves a list of all certifications for a specific organisation identified by the organisation_id. The request requires an Authorization header with a bearer token for authentication. The response includes a data object containing an array of certification objects, each with an id, name, and status. Pagination details such as items per page, current page index, total pages, and total items are also provided in the response.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/custom_fields : This API endpoint retrieves a list of all custom fields for a specific organisation. The request requires an 'organisation_id' as a path parameter and an 'Authorization' header with a bearer token. The response includes a data object containing an array of custom field objects, each with details such as id, name, hint, description, type, onboarding status, requirement status, permissions, and options. The response also provides pagination details including items per page, current page index, total pages, and total items.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/policies : This API endpoint retrieves a list of all policies for a specific organisation identified by the organisation_id. The request requires an Authorization header with a bearer token for authentication. The response includes a data object containing an array of policy objects, each with details such as id, name, induction status, and creation date. Pagination details such as items per page, current page index, total pages, and total items are also provided.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/teams : The 'Get All Teams' API retrieves an array of all teams associated with a specified organisation. The request requires an 'organisation_id' as a path parameter and an 'Authorization' header with a bearer token for authentication. The response includes a 'data' object containing an array of team objects, each with an 'id', 'name', and 'status'. Additionally, pagination details such as 'item_per_page', 'page_index', 'total_pages', and 'total_items' are provided.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/leave_requests : The Get Leave Requests API retrieves a list of all leave requests for a specified organisation. The request requires an organisation_id as a path parameter and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of leave request objects, each with details such as id, start_date, end_date, total_hours, comment, status, leave_balance_amount, leave_category_name, reason, and employee_id.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/rostered_shifts : The 'List Rostered Shifts' API allows users to retrieve all rostered shifts accessible by the current user within a specified organisation. The API supports pagination and filtering by various parameters such as date range, shift statuses, location IDs, member IDs, and more. The request requires an organisation ID as a path parameter and an authorization bearer token in the headers. Optional query parameters include from_date, to_date, statuses, location_ids, member_ids, unassigned_shifts_only, and exclude_shifts_overlapping_from_date. The response includes a list of shifts with details such as start and end times, status, location, member information, and shift swap details.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/unavailabilities : The List Unavailabilities API retrieves all unavailability records that match the specified conditions for a given organisation. The API requires an organisation ID as a path parameter and supports optional query parameters such as from_date, to_date, location_id, member_id, item_per_page, and page_index to filter the results. The response includes a list of unavailability records with details such as member ID, description, start and end dates, and recurring patterns. The API uses a bearer token for authorization.

Employee APIs

GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees : The Get Employees API retrieves an array of all employees managed by a specified organisation. The API requires an organisation ID as a path parameter and an authorization bearer token in the headers. The response includes a data object containing an array of employee objects, each with detailed information such as ID, email, name, address, job title, and more. If there are no employees, the array will be empty.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id : This API endpoint retrieves a specific employee's details from the Employment Hero platform. It requires the organisation ID and employee ID as path parameters, and an authorization bearer token in the headers. The response includes detailed information about the employee, such as their name, contact details, job title, and associated managers and cost centres.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/bank_accounts : This API endpoint retrieves a list of all bank accounts for a specific employee within an organisation. The request requires the organisation_id and employee_id as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of bank account records, each with details such as account name, account number, BSB, amount, and whether it is the primary account. Pagination details such as items per page, page index, total pages, and total items are also provided.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/certifications : This API endpoint retrieves a list of all certifications assigned to a specific employee within an organisation. The request requires the organisation_id and employee_id as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of certification items, each with details such as certification ID, name, type, expiry date, completion date, status, and any driver problems. The response also includes pagination details like items per page, current page index, total pages, and total items.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/custom_fields : This API endpoint retrieves a list of all custom fields for a specific employee within an organisation. It requires the organisation_id and employee_id as path parameters and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of employee custom field objects, each with properties such as id, value, name, description, and type. The response also includes pagination details like items per page, current page index, total pages, and total items.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/emergency_contacts : This API endpoint retrieves a list of all emergency contacts for a specific employee within an organisation. It requires the organisation_id and employee_id as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of emergency contact objects, each with details such as contact name, contact numbers, relationship, and contact type. Pagination details such as items per page, page index, total pages, and total items are also provided.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/employment_histories : This API endpoint retrieves the complete employment history for a specific employee within a given organisation. It requires the organisation_id and employee_id as path parameters and an Authorization header with a bearer token for authentication. The response includes an array of employment history records, each containing details such as the position title, start and end dates, and employment type. The response also provides pagination details including items per page, current page index, total pages, and total items.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/pay_details : This API endpoint retrieves a list of all pay details for a specific employee within a given organisation. The request requires the organisation_id and employee_id as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of pay details, each with properties such as id, effective_from, classification, industrial_instrument, pay_rate_template, anniversary_date, salary, salary_type, pay_unit, pay_category, leave_allowance_template, change_reason, and comments. The response also includes pagination details like item_per_page, page_index, total_pages, and total_items.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/payslips : This API endpoint retrieves a list of all payslips for a specific employee within an organisation. It requires the organisation ID and employee ID as path parameters, and an Authorization header with a bearer token for authentication. The response includes a data object containing an array of payslip records, each with details such as employee name, total deductions, net pay, wages, tax, and other payroll-related information. The response also includes pagination details like items per page, current page index, total pages, and total items.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/superannuation_detail : This API endpoint retrieves the superannuation detail for a specific employee within a given organisation. It requires the organisation_id and employee_id as path parameters, and an Authorization header with a bearer token. The response includes details such as the fund name, member number, product code, and other relevant superannuation account information. If the employee does not have a superannuation detail, a not found error will be returned.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/tax_declaration : The Get Tax Declaration Detail API retrieves the tax declaration details for a specific employee within an organisation. It requires the organisation_id and employee_id as path parameters, and an Authorization header with a bearer token. The response includes details such as the employee's first and last name, tax file number, residency status, and any applicable tax debts. If no tax declaration is found, a not found error is returned.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/employees/:employee_id/timesheet_entries : The Get Timesheet Entries API retrieves a list of all timesheet entries for a specific employee within an organisation. The API requires the organisation ID and employee ID as path parameters. The employee ID can be a specific UUID or '-' to retrieve timesheets for all employees. Optional query parameters include start_date and end_date to filter the timesheet entries by date range. The request must include an Authorization header with a bearer token. The response contains a data object with an array of timesheet entries, each entry includes details such as date, start and end times, status, units, and associated cost centre.
GET https://api.employmenthero.com/api/v1/organisations/:organisation_id/teams/:team_id/employees : This API retrieves all employees associated with a specific team within a managed organization. It requires the organization ID and team ID as path parameters and an authorization bearer token in the headers. The response includes an array of employee objects, each containing detailed information such as ID, email, name, job title, and more. The response also provides pagination details like items per page, current page index, total pages, and total items.

Authorization APIs

GET https://oauth.employmenthero.com/oauth2/authorize : The Obtain Access Token API is used to initiate the OAuth 2.0 authorization process to obtain an access token for accessing private data over the Employment Hero API. The API requires the client ID, redirect URI, and response type as query parameters. The user will be prompted to log in and grant permissions, after which they will be redirected to the specified redirect URI with an authorization code. This code can then be used to obtain the access token. The Employment Hero account used for authorization can only access data within its roles or permissions.
POST https://oauth.employmenthero.com/oauth2/token : The Refresh Access Token API is used to obtain a new access token using a refresh token. Access tokens expire after 15 minutes, and this API allows for continuous usage by providing a new access token and a new refresh token, invalidating the previous refresh token. The API requires the client_id, client_secret, grant_type, and refresh_token as query parameters. The response includes a new access_token, refresh_token, token_type, expires_in, and scope.

Employment Hero API FAQs

How can I access the Employment Hero API?

Answer: To access the Employment Hero API, you need to have a Platinum subscription or higher. Once subscribed, you can register your application through the Employment Hero Developer Portal to obtain client credentials, including a Client ID and Client Secret. These credentials are necessary for authenticating your API requests using the OAuth 2.0 protocol.
Source: API Reference - Australia

What authentication method does the Employment Hero API use?

Answer: The Employment Hero API utilizes the OAuth 2.0 protocol for secure authentication. After registering your application and obtaining client credentials, you will perform an authorization flow to receive an access token. This token must be included in the Authorization header of your API requests.
Source: API Reference - Australia

Are there rate limits for the Employment Hero API?

Answer: Yes, Employment Hero enforces rate limits to ensure fair usage and maintain system performance. While specific rate limits are not publicly detailed, it's recommended to implement error handling for potential rate limiting responses and to contact Employment Hero support for detailed rate limit information.
Source: Employment Hero API - Australia

Can I retrieve employee data using the Employment Hero API?

Answer: Yes, the Employment Hero API provides endpoints to retrieve employee data. For example, you can use the /v1/employees endpoint to fetch a list of employees. Ensure that your application has the necessary scopes and permissions to access this data.
Source: API Reference - Australia

Does the Employment Hero API support webhooks for real-time data updates?

Answer: As of the latest available information, the Employment Hero API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
Source: Employment Hero API - Australia

Get Started with Employment Hero API Integration

Knit API offers a convenient solution for quick and seamless integration with Employment Hero API. Our AI-powered integration platform allows you to build any Employment Hero API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Employment Hero API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

Okta API Directory

Okta provides a comprehensive suite of APIs that enabledevelopers to integrate robust identity and access management functionalitiesinto their applications. These APIs facilitate operations such as userauthentication, authorization, and management, ensuring secure and seamlessuser experiences.

Core Functionalities:

User Management: Create, retrieve, update, and deactivate users in your organization.
Group Management: Organize users into groups, assign permissions, and manage group memberships.
Authentication and Authorization: Implement secure authentication mechanisms and manage authorization policies using OAuth 2.0 and OpenID Connect protocols.
Event and Log Management: Access system logs and monitor events for auditing and compliance purposes.

Integration Use Cases:

Single Sign-On (SSO): Integrate Okta's SSO capabilities to provide seamless access to multiple applications with a single set of credentials.
Multi-Factor Authentication (MFA): Enhance security by implementing MFA, requiring users to provide additional verification factors during authentication.
API Access Management: Secure your APIs by managing access tokens and scopes, ensuring that only authorized clients can access specific resources.

Supported Protocols:

RESTful API: The Okta API adheres to REST principles, utilizing standard HTTP methods for resource manipulation.
OAuth 2.0 and OpenID Connect: Okta supports these protocols for secure authentication and authorization, enabling integration with a wide range of applications.

Authentication Mechanisms:

API Tokens: Authenticate API requests using tokens, which can be generated and managed within the Okta Admin Console.developer.okta.com
OAuth 2.0 Access Tokens: For fine-grained access control, use scoped OAuth 2.0 access tokens to authenticate with Okta's management APIs.developer.okta.com

Rate Limiting Policies:

Usage Limits: To protect the service for all customers, Okta APIs are subject to rate limits. These limits mitigate denial-of-service attacks and abusive actions such as rapidly updating configurations, aggressive polling and concurrency, or excessive API calls.developer.okta.com

For comprehensive information and to get started with the Okta API, refer to the official Okta API documentation.

‍

Okta API Endpoints

Group Management

POST https://{yourOktaDomain}/api/v1/groups : The 'Create a Group' API allows you to create a new group in Okta with a specified profile and type.
PUT https://{yourOktaDomain}/api/v1/groups/{groupId} : The Replace a Group API allows you to replace the profile for a group with the OKTA_GROUP type.
GET https://{yourOktaDomain}/api/v1/groups/{groupId}/apps : The 'List all Assigned Applications' API retrieves all applications assigned to a specific group in Okta.
GET https://{yourOktaDomain}/api/v1/groups/{groupId}/users : The 'List all Member Users' API retrieves all users that are members of a specified group in Okta.
POST https://{yourOktaDomain}/api/v1/groups/rules : The 'Create a Group Rule' API allows you to create a rule in Okta that dynamically adds users to specified groups based on certain conditions.
PUT https://{yourOktaDomain}/api/v1/groups/rules/{groupRuleId} : The Replace a Group Rule API allows you to update an existing group rule in Okta.
POST https://{yourOktaDomain}/api/v1/groups/rules/{groupRuleId}/lifecycle/activate : The 'Activate a Group Rule' API activates a specific group rule identified by the 'groupRuleId'.
POST https://{yourOktaDomain}/api/v1/groups/rules/{groupRuleId}/lifecycle/deactivate : This API deactivates a specific group rule identified by the groupRuleId.

User Management

GET https://{yourOktaDomain}/api/v1/users : The 'List all Users' API retrieves a list of users from the Okta system.
DELETE https://{yourOktaDomain}/api/v1/users/{userId} : The 'Delete a User' API permanently deletes a user from the Okta system.
GET https://{yourOktaDomain}/api/v1/users/{userId}/appLinks : The 'List all Assigned Application Links' API retrieves all appLinks for applications assigned to a specific Okta user.
GET https://{yourOktaDomain}/api/v1/users/{userId}/blocks : The 'List all User Blocks' API retrieves information about how a specific user is blocked from accessing their account in Okta.
GET https://{yourOktaDomain}/api/v1/users/{userId}/clients : The 'List all Clients' API retrieves all client resources for which the specified user has grants or tokens.
GET https://{yourOktaDomain}/api/v1/users/{userId}/clients/{clientId}/grants : The 'List all Grants for a Client' API retrieves all grants for a specified user and client in Okta.
GET https://{yourOktaDomain}/api/v1/users/{userId}/clients/{clientId}/tokens : This API endpoint lists all refresh tokens issued for a specified user and client in Okta.
DELETE https://{yourOktaDomain}/api/v1/users/{userId}/clients/{clientId}/tokens/{tokenId} : This API revokes a specified refresh token for a client in Okta.
PUT https://{yourOktaDomain}/api/v1/users/{userIdOrLogin}/linkedObjects/{primaryRelationshipName}/{primaryUserId} : This API replaces the linked object value for 'primary' in Okta.
DELETE https://{yourOktaDomain}/api/v1/users/{userIdOrLogin}/linkedObjects/{relationshipName} : The 'Delete a Linked Object' API allows you to delete linked objects for a user in Okta.
GET https://{yourOktaDomain}/api/v1/users/{userId}/groups : The 'List all Groups' API retrieves all groups of which a specified user is a member in Okta.
GET https://{yourOktaDomain}/api/v1/users/{userId}/idps : This API endpoint lists all Identity Providers (IdPs) associated with a specific Okta user.
POST https://{yourOktaDomain}/api/v1/users/{userId}/lifecycle/activate : The Activate a User API is used to activate a user in the Okta system.
POST https://{yourOktaDomain}/api/v1/users/{userId}/lifecycle/deactivate : The 'Deactivate a User' API deactivates a user in the Okta system.
POST https://{yourOktaDomain}/api/v1/users/{userId}/lifecycle/expire_password : The Expire Password API allows you to expire a user's password in Okta, transitioning the user to the PASSWORD_EXPIRED status.
POST https://{yourOktaDomain}/api/v1/users/{userId}/lifecycle/expire_password_with_temp_password : This API expires a user's password and sets a temporary password for the user.
POST https://{yourOktaDomain}/api/v1/users/{userId}/lifecycle/reactivate : The 'Reactivate a User' API allows you to reactivate a user in Okta.
POST https://{yourOktaDomain}/api/v1/users/{userId}/lifecycle/reset_factors : The 'Reset all Factors' API resets all factors for the specified user in Okta.
POST https://{yourOktaDomain}/api/v1/users/{userId}/lifecycle/reset_password : This API generates a one-time token (OTT) that can be used to reset a user's password.
POST https://{yourOktaDomain}/api/v1/users/{userId}/lifecycle/suspend : The 'Suspend a User' API allows you to suspend a user in Okta.
POST https://{yourOktaDomain}/api/v1/users/{userId}/lifecycle/unlock : The 'Unlock a User' API allows you to unlock a user in Okta who has a LOCKED_OUT status or is blocked from unknown devices while having an ACTIVE status.
POST https://{yourOktaDomain}/api/v1/users/{userId}/lifecycle/unsuspend : The Unsuspend a User API allows you to unsuspend a user in Okta, returning them to the ACTIVE state.
DELETE https://{yourOktaDomain}/api/v1/users/{userId}/sessions : The 'Revoke all User Sessions' API revokes all active identity provider sessions of a specified user in Okta.

User Type Management

POST https://{yourOktaDomain}/api/v1/meta/types/user : The 'Create a User Type' API allows you to create a new custom user type in Okta.
DELETE https://{yourOktaDomain}/api/v1/meta/types/user/{typeId} : The 'Delete a User Type' API allows you to permanently delete a user type in Okta.

User Credential Management

POST https://{yourOktaDomain}/api/v1/users/{userId}/credentials/change_password : The Change Password API allows you to change a user's password by validating the user's current password.
POST https://{yourOktaDomain}/api/v1/users/{userId}/credentials/change_recovery_question : The Change Recovery Question API allows you to change a user's recovery question and answer credential by validating the user's current password.
POST https://{yourOktaDomain}/api/v1/users/{userId}/credentials/forgot_password : The 'Initiate Forgot Password' API initiates the forgot password flow for a user in Okta.
POST https://{yourOktaDomain}/api/v1/users/{userId}/credentials/forgot_password_recovery_question : The 'Reset Password with Recovery Question' API allows resetting a user's password by providing the correct answer to a recovery question.

User Factor Management

POST https://{yourOktaDomain}/api/v1/users/{userId}/factors : The 'Enroll a Factor' API allows you to enroll a supported Factor for a specified user in Okta.
GET https://{yourOktaDomain}/api/v1/users/{userId}/factors/catalog : The 'List all supported Factors' API retrieves a list of all the supported factors that can be enrolled for a specified user in Okta.
GET https://{yourOktaDomain}/api/v1/users/{userId}/factors/questions : This API endpoint lists all available security questions for a specified user in Okta.
DELETE https://{yourOktaDomain}/api/v1/users/{userId}/factors/{factorId} : The 'Unenroll a Factor' API allows you to unenroll an existing Factor for a specified user in Okta.
POST https://{yourOktaDomain}/api/v1/users/{userId}/factors/{factorId}/lifecycle/activate : The 'Activate a Factor' API is used to activate a specific factor for a user in Okta.
POST https://{yourOktaDomain}/api/v1/users/{userId}/factors/{factorId}/resend : The 'Resend a Factor Enrollment' API allows you to resend an SMS, call, or email factor challenge as part of an enrollment flow.
GET https://{yourOktaDomain}/api/v1/users/{userId}/factors/{factorId}/transactions/{transactionId} : The 'Retrieve a Factor Transaction Status' API allows you to retrieve the status of a push Factor verification transaction for a specific user in Okta.
POST https://{yourOktaDomain}/api/v1/users/{userId}/factors/{factorId}/verify : The 'Verify a Factor' API is used to verify an OTP for a Factor in Okta.

User Grant Management

DELETE https://{yourOktaDomain}/api/v1/users/{userId}/grants : The 'Revoke all User Grants' API is used to revoke all grants for a specified user in Okta.
DELETE https://{yourOktaDomain}/api/v1/users/{userId}/grants/{grantId} : The 'Revoke a User Grant' API allows you to revoke a specific grant for a specified user in Okta.

Organization Management

GET https://{yourOktaDomain}/idp/myaccount/organization : This API retrieves the details of an organization in Okta.
GET https://{yourOktaDomain}/{accountId}/api/v1/orgs : The 'List all Orgs' API allows users to retrieve a list of organizations associated with a specific Aerial Account.
GET https://{yourOktaDomain}/{accountId}/api/v1/orgs/{orgId} : The 'Retrieve an Org by ID' API allows users to retrieve details of an organization within an Aerial Account using the organization's ID.
GET https://{yourOktaDomain}/{accountId}/api/v1/orgs/{orgId}/products : This API endpoint lists all enabled products for a specified Okta organization.
PUT https://{yourOktaDomain}/{accountId}/api/v1/orgs/{orgId}/status : This API allows you to change the status of an organization (Org) in Okta.

Okta API FAQs

How do I authenticate with the Okta API?
- Answer: The Okta API supports multiple authentication methods, including OAuth 2.0 and API tokens. For OAuth 2.0, you can use various grant types such as Authorization Code, Implicit, and Client Credentials, depending on your application's needs. For API token-based authentication, you generate an API token in the Okta Admin Console and include it in the Authorization header of your requests as a bearer token.
What are the rate limits for the Okta API?
- Answer: Okta enforces rate limits to ensure fair usage and maintain system performance. The specific rate limits vary depending on the endpoint and your organization's subscription plan. It's essential to consult the Rate Limits documentation for detailed information and implement error handling in your application to manage rate limiting responses gracefully.
Can I manage users using the Okta API?
- Answer: Yes, the Okta API provides endpoints to manage users, including creating, updating, retrieving, and deactivating user accounts. The Users API allows you to perform CRUD operations on user profiles, manage credentials, and handle user lifecycle states.
Does Okta support SCIM for user provisioning?
- Answer: Yes, Okta supports the System for Cross-domain Identity Management (SCIM) protocol for user provisioning and deprovisioning. This allows for automated user management between Okta and SCIM-compliant applications. You can find more information and frequently asked questions about SCIM in Okta's SCIM FAQ.developer.okta.com
Where can I find more information and support for the Okta API?
- Answer: For comprehensive information, you can refer to the Core Okta API documentation. Additionally, the Okta Developer Community is a valuable resource where you can ask questions, share knowledge, and find discussions related to Okta's APIs.developer.okta.com

‍

Get Started with Okta API Integration

Obtain API Credentials: Sign in to your Okta Admin Console to generate API tokens or configure OAuth 2.0 applications, which are necessary for authenticating API requests.
Explore API Endpoints: Familiarize yourself with the available API endpoints and their functionalities. The Okta Developer Reference provides detailed information on each API.developer.okta.com
Utilize Postman Collections: Okta offers public API collections on Postman, facilitating testing and understanding of API endpoints. These collections can be accessed through the Postman API Network.postman.com
Implement API Calls: Use standard HTTP methods (GET, POST, PUT, DELETE) to interact with the APIs, ensuring that requests are authenticated and properly structured according to the API specifications.

For quick and seamless access to Okta API, Knit API offers a convenient solution. By integrating with Knit just once, you can integrate with multiple HRIS and identity tools in one go. Knit takes care of all the authentication, authorization, and ongoing integration maintenance, this approach not only saves time but also ensures a smooth and reliable connection to your Okta API.

Additional Resources:

Okta Developer Portal: The Okta Developer Portal provides comprehensive guides, SDKs, and tools to assist in integrating Okta's identity services into your applications.
API Access Management: For securing your APIs, Okta's API Access Management extends security policies and user provisioning into APIs, providing well-defined OAuth interfaces for developers.developer.okta.com

By leveraging Okta's APIs, you can enhance your applications with secure and scalable identity management solutions, streamlining authentication processes and protecting user data

‍

iCIMS Directory

iCIMS is a leading software company specializing in talent acquisition solutions through its robust platform, the iCIMS Talent Cloud. This comprehensive platform is tailored to assist organizations in attracting, engaging, hiring, and advancing talent, with a strong emphasis on recruitment and internal mobility. By leveraging iCIMS, businesses can streamline their hiring processes, potentially reducing the time-to-fill positions by up to 50%. The software's Applicant Tracking System (ATS) is designed to simplify and accelerate recruitment workflows, enabling HR teams to efficiently manage the complexities of hiring.

Globally trusted by organizations, iCIMS software empowers businesses to build, retain, and scale their workforce effectively. It provides essential tools for talent acquisition and management, ensuring that companies can attract and hire the best talent while optimizing their recruitment strategies. As a vital component of the human resources domain, iCIMS enhances the efficiency of HR operations, making it an indispensable asset for modern businesses seeking to improve their talent acquisition processes.

Key highlights of iCIMS APIs

Configurable and Flexible Integrations:
- iCIMS API allows for customizable integrations that can be tailored to meet specific business needs.
Secure and Reliable:
- The API ensures secure data transactions and reliable performance.
Data Import and Export:
- It supports data imports and exports using flat-file or file-based transfers, facilitating easy data management.
Native Integrations:
- iCIMS provides native integrations with various HR systems, enhancing the functionality of the iCIMS Talent Cloud.
Custom Integrations:
- The API allows for the creation of custom integrations, enabling businesses to connect iCIMS with third-party tools.
Streamlined HR Tech Stack:
- By integrating with iCIMS, businesses can centralize their HR technology, improving efficiency and reducing complexity.
Robust Recruiting Solutions:
- Integrations with iCIMS Talent Cloud products help create comprehensive solutions for recruiting and retaining talent.
Two Main Integration Paths:
- Businesses can choose between customer-specific integrations or iCIMS-defined integrations, providing flexibility in how integrations are implemented.
Partner Opportunities:
- iCIMS offers partnership opportunities for businesses looking to build repeatable integrations, driving mutual business growth.
Assessment Integrations:
- iCIMS Assessments integrations allow businesses to leverage a wide range of assessment types, enhancing the recruitment process.

iCIMS API Endpoints

Applicant Workflows

POST https://api.icims.com/customers/{{customerId}}/applicantworkflows : Create a new application
GET https://api.icims.com/customers/{{customerId}}/applicantworkflows/{{applicationId}} : Get all interview details for an application
POST https://api.icims.com/customers/{{customerId}}/search/applicantworkflows : Get all job applications

Jobs

POST https://api.icims.com/customers/{{customerId}}/jobs : Create job
GET https://api.icims.com/customers/{{customerId}}/jobs/{{jobId}} : Get recruiters assigned to a job
POST https://api.icims.com/customers/{{customerId}}/search/jobs : List all jobs

People

PATCH https://api.icims.com/customers/{{customerId}}/people/{{candidateId}} : Add tag to candidate
GET https://api.icims.com/customers/{{customerId}}/people/{{candidate_id}}/fields/resume/text : Get all attachments for an application

‍

iCIMS API FAQs

How do I access the iCIMS API documentation?

Answer: To access the iCIMS API documentation, visit the iCIMS Developer Community. This platform provides comprehensive resources for developers, including API references, integration guides, and best practices.
Source: iCIMS Developer Community

What authentication methods are supported by the iCIMS API?

Answer: The iCIMS API supports multiple authentication methods:some text
- OAuth 2.0: Recommended for secure and scalable integrations.
- HMAC (Hash-Based Message Authentication Code): Provides an additional layer of security for API requests.
Source: Connecting and Authentication - iCIMS Developer Resources

Are there rate limits for the iCIMS API?

Answer: Yes, iCIMS enforces rate limits to ensure fair usage:some text
- Default Limit: 10,000 API calls per day per customer.
- Reset Time: Limits reset daily at 12:00 AM UTC.
- Headers: Each API response includes headers indicating the current rate limit status.
Source: Connecting and Authentication - iCIMS Developer Resources

Can I retrieve candidate information using the iCIMS API?

Answer: Yes, you can retrieve candidate information using the iCIMS API. The Profiles API allows access to various profile types, including candidate profiles.
Source: Profiles API - iCIMS Developer Resources

Does the iCIMS API support webhooks for real-time data updates?

Answer: As of the latest available information, iCIMS does not natively support webhooks. However, you can use the API to poll for changes or integrate with third-party services that provide webhook functionality to achieve similar outcomes.
Source: iCIMS Developer Community

‍

Get Started with iCIMS API Integration

Knit API offers a convenient solution for quick and seamless integration with iCIMS API. Our AI-powered integration platform allows you to build any iCIMS API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, CRM, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to iCIMS API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Humi API Directory

Humi HR software is a robust all-in-one human resources information system (HRIS) tailored for Canadian businesses, particularly small to medium-sized enterprises. It offers a comprehensive suite of tools designed to streamline HR processes, making it an invaluable asset for companies looking to enhance their human resources management. By consolidating various HR functions into a single platform, Humi HR software helps businesses manage payroll, HR, benefits, and insurance with ease. Its user-friendly interface and extensive features, such as employee data management, payroll management, and benefits administration, empower organizations to improve efficiency, reduce errors, and save valuable time.

Beyond its core functionalities, Humi HR software excels in providing seamless onboarding and offboarding workflows, performance management, compliance and reporting tools, and digital document management. These features ensure that businesses can maintain a high level of organization and compliance while focusing on their growth and development. A key aspect of Humi's appeal is its ability to integrate with other systems through the Humi API, allowing businesses to customize and extend the software's capabilities to meet their unique needs. This flexibility makes Humi HR a versatile solution for modern HR challenges.

Key highlights of Humi HR APIs

Humi offers a Partners API that enables developers to access and manage employee data within third-party applications, facilitating seamless integration with the Humi HR platform. This API adheres to the JSON:API specification, ensuring standardized data exchange. Source: GitHub

Key Features of the Humi Partners API:

Authentication: Utilizes a token-based system. Tokens are included in the Authorization header as a Bearer token for each request.
Data Format: Employs JSON for both requests and responses, aligning with the JSON:API spec
Endpoints: Provides access to employee information and time-off data. Key endpoints include:some text
- Employees:some text
  - List Employees: GET /v1/employees
  - Retrieve Employee Details: GET /v1/employees/{employeeId}
- Time Off:some text
  - List Time Off Requests: GET /v1/timeoff
  - Retrieve Time Off Details: GET /v1/timeoff/{employeeId}
Webhooks: Supports event-driven interactions with webhooks for events such as:some text
- Employee Created
- Employee Updated
- Employee Terminated
- Employee Deleted
- Company Created
- Company Updated

‍

Humi HR API Endpoints

Employee

GET https://partners.humi.ca/v1/employees/:employeeId : Get Employee Details

Payroll

GET https://partners.humi.ca/v1/payroll/additional_incomes : Get Additional Incomes for a Company
POST https://partners.humi.ca/v1/payroll/employee_time_worked : Employee Time Worked

Time Off

GET https://partners.humi.ca/v1/timeoff : Get Approved Time Off Requests
GET https://partners.humi.ca/v1/timeoff/:employeeId : Get Approved Time Off Requests for Employee

Humi API FAQs

How can I access the Humi HR API?

Answer: To access the Humi HR API, you need to obtain a Humi Partners API Token. This token allows you to access employee data within third-party applications. To request a token, contact Humi support at support@humi.ca with the subject "Requesting Humi Partners API Token."
GitHub

What authentication method does the Humi HR API use?

Answer: The Humi HR API uses token-based authentication. Once you have obtained your API token, include it in the Authorization header of your HTTP requests as follows: Authorization: Bearer your-token-here.

Are there rate limits for the Humi HR API?

Answer: The official documentation does not specify explicit rate limits for the Humi HR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.

Can I retrieve employee data using the Humi HR API?

Answer: Yes, the Humi HR API provides endpoints to retrieve employee data. For example, you can use the GET /v1/employees endpoint to fetch a list of employees, and GET /v1/employees/:employeeId to retrieve details of a specific employee.

Does the Humi HR API support webhooks for real-time data updates?

Answer: Yes, the Humi HR API supports webhooks for real-time data updates. Events such as EmployeeCreated, EmployeeUpdated, EmployeeTerminated, and EmployeeDeleted can trigger webhooks, allowing your application to receive immediate notifications when these events occur.

Get Started with Humi API Integration

Obtain an API Token: Contact Humi at support@humi.ca to request a Partners API token. Note that the API is in a closed beta phase, and access is provided upon request.
Authenticate Requests: Include the obtained token in the Authorization header of your HTTP requests as follows:
makefile
Copy code
Authorization: Bearer your-token-here
Make API Calls: Utilize the available endpoints to interact with employee and time-off data. For example, to list employees:
bash
Copy code
GET https://partners.humi.ca/v1/employees
Handle Responses: Responses conform to the JSON:API specification, providing structured data for easy parsing and integration.

Additional Resources:

Sample Node.js Client: A sample Node.js client is available to demonstrate API usage and can serve as a reference for implementation.
Integration Use Cases: For practical examples of integration scenarios, refer to the Humi-HR API Integration Use Cases, which provide insights into common API interactions. Knit Developers

About Knit

Knit API offers a convenient solution for quick and seamless integration with Humi HR API. Our AI-powered integration platform allows you to build any Humi API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Humi HR API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

Sage Recruitment API Directory

Sage-ATS, also known as Sage People or Sage HR, is a comprehensive cloud-based human resources management solution that integrates an advanced Applicant Tracking System (ATS). This innovative software is specifically designed to streamline the hiring process, making it an indispensable tool for businesses aiming to enhance their recruitment strategies. By automating and organizing recruitment activities, Sage-ATS empowers organizations to attract, hire, and manage talent more efficiently. Key features include candidate tracking, seamless job board integration, and a visual pipeline tool that provides a clear overview of the hiring funnel, all of which contribute to reducing the time-to-fill positions and improving the overall candidate experience.

Serving the domain of human resources, Sage-ATS focuses on talent acquisition and recruitment management, addressing common HR challenges with its robust functionalities. The software's ability to integrate with various platforms through the Sage Recruitment API further enhances its utility, allowing businesses to customize and optimize their recruitment processes. This API integration process is crucial for organizations seeking to leverage Sage-ATS's full potential, ensuring a smooth and efficient recruitment workflow. As a result, Sage-ATS not only simplifies recruitment but also supports strategic HR initiatives, making it a vital asset for modern businesses.

Key highlights of Sage-ATS APIs

1. Automation and Efficiency:
- Automates recruitment, selection, and onboarding processes, improving efficiency and reducing manual work.
2. Seamless Integration:
- Ensures smooth data flow by integrating with various applications and systems, reducing manual data entry.
3. Enhanced Productivity:
- Improves overall productivity and efficiency by integrating with other systems.
4. Custom Integration:
- Supports custom integration features, allowing data imports from non-natively supported systems, providing flexibility.
5. Bi-directional Synchronization:
- Ensures consistent data updates across integrated systems through bi-directional synchronization.
6. Unified API Access:
- Simplifies integration for applications interacting with multiple ATS platforms by unifying them into a single access point.

Sage-ATS API Endpoints

Applicant Endpoints

GET https://subdomain.sage.hr/api/recruitment/applicants/{id} : Get Applicant Details
GET https://subdomain.sage.hr/api/recruitment/applicants/{id}/actions : List Applicant's Recruitment Pipeline Actions

Position Endpoints

GET https://subdomain.sage.hr/api/recruitment/positions : List Recruitment Positions
GET https://subdomain.sage.hr/api/recruitment/positions/{id} : Get Position Details
GET https://subdomain.sage.hr/api/recruitment/positions/{id}/applicants : List Applicants for a Position

Sage HR ATS API FAQs

How do I enable API access in Sage HR ATS?some text
- Answer: To enable API access in Sage HR:some text
  1. Click on your name in the top-right corner and select Settings.
  2. Navigate to Integrations > API.
  3. Click Enable API Access to activate the API and generate your unique API key.
- Source: How does Sage HR API work?
What authentication method does the Sage HR ATS API use?some text
- Answer: The Sage HR API uses an API key for authentication. Include your API key in the X-Auth-Token header of every request sent to the endpoint URL.
- Source: How does Sage HR API work?
Are there rate limits for the Sage HR ATS API?some text
- Answer: The official documentation does not specify explicit rate limits for the Sage HR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
- Source: Sage HR API Reference
Can I retrieve employee data using the Sage HR ATS API?some text
- Answer: Yes, you can retrieve employee data by making a GET request to the /employees endpoint. This will list active employees in the company.
- Source: Sage HR API Reference
Does the Sage HR ATS API support webhooks?some text
- Answer: As of the latest available information, the Sage HR API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
- Source: Sage HR API Reference

‍

Get Started with Sage HR ATS API Integration

For quick and seamless integration with Sage HR API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Sage HR API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Sage ATS API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

Personio API Directory

Personio is a comprehensive cloud-based HR software tailored specifically for small and medium-sized enterprises (SMEs) aiming to streamline and automate their HR processes. This robust platform offers a suite of tools designed to enhance HR management, recruitment, performance management, and time management. By centralizing employee data, Personio enables businesses to efficiently track attendance, manage payroll, oversee job postings, and handle applicant tracking. Additionally, it facilitates performance reviews and the management of working hours and leave requests, making it an invaluable asset for companies seeking to digitize their HR operations and minimize administrative burdens.

One of the standout features of Personio is its ability to integrate seamlessly with other systems through the Personio API. This integration capability allows businesses to connect Personio with various third-party applications, enhancing the software's functionality and ensuring a smooth flow of data across platforms. By leveraging the Personio API, companies can customize their HR processes to better fit their unique needs, further optimizing their HR management and operational efficiency.

Key highlights of Personio APIs

1. Easy Data Access:
- Seamlessly read and write company, census, and payroll data, including deductions and benefits contributions.
2. Automation:
- Supports automated data transfer to streamline administrative processes and reduce manual data entry.
3. Custom Integration:
- Open API allows for easy integration with other software solutions, connecting existing systems with Personio.
4. Third-Party Integrations:
- Integrates with applications like Xero and DATEV for effortless data transfer and enhanced HR processes.
5. Unified API via Merge:
- Connects products with Personio and other applications to help businesses close more deals and retain customers.
6. Scalable:
- Designed to support companies with 10 to 2000 employees, offering scalability as business needs grow.
7. Developer-Friendly:
- Enables the creation of automations, scripts, and applications to enhance HR processes.

Personio API Endpoints

Absence Management

POST https://api.personio.de/v1/company/absence-periods : The 'Create an Absence Period' API allows you to add absence data for absence types with a time unit set to hours. It does not support creating periods for absence types with certificate requirements enabled. The API requires headers for partner and application identifiers. The request body must include employee ID, time-off type ID, start and end dates, and optionally start and end times for partial-day absences, half-day indicators, comments, and approval settings. A successful response returns details of the created absence period, including its ID, measurement unit, effective duration, employee and absence type details, and timestamps. Error responses include codes and messages for invalid requests, not found errors, validation errors, and internal server errors.
DELETE https://api.personio.de/v1/company/absence-periods/{id} : This API deletes an absence period by its ID for absence types with the time unit set to hours. The request requires the absence period ID as a path parameter. Optional headers include 'X-Personio-Partner-ID' and 'X-Personio-App-ID' for partner and application identification. A successful response (200) returns a success message indicating the absence period was deleted. If the request is invalid (400), an error message is returned. If the absence period ID is not found (404), an error message is also returned.

Attendance Management

POST https://api.personio.de/v1/company/attendances : The 'Create an Attendance' API endpoint allows for adding attendance data for company employees. It supports adding attendances for one or multiple employees simultaneously. The request body should contain a list of attendance periods, each with details such as employee ID, date, start and end times, break duration, project ID, and comments. The API requires optional headers for partner and application identifiers. On success, it returns the IDs of created attendance periods. In case of errors, detailed messages are provided. The API also supports an optional 'skip_approval' parameter to manage approval flows.
GET https://api.personio.de/v1/company/attendances/projects : The List Projects API provides a list of all company projects. It is a GET request to the endpoint https://api.personio.de/v1/company/attendances/projects. The request can include optional headers such as X-Personio-Partner-ID and X-Personio-App-ID for partner and application identification. The response includes a success flag and a data array containing project details such as id, type, name, active status, and timestamps for creation and last update.
PATCH https://api.personio.de/v1/company/attendances/projects/{id} : The 'Update Project by ID' API allows users to update the details of a specific project identified by its numeric ID. The API endpoint is 'https://api.personio.de/v1/company/attendances/projects/{id}' and uses the PATCH method. The request requires the 'id' path parameter to specify the project to be updated. The request body can include 'name' and 'active' fields to update the project's name and availability status, respectively. The response includes a success status and the updated project details if successful (HTTP 200), or error messages if the request fails due to invalid data (HTTP 400) or if the project is not found (HTTP 404).
PATCH https://api.personio.de/v1/company/attendances/{id} : The 'Update Attendance by ID' API endpoint allows updating attendance data for company employees. The endpoint requires the attendance ID as a path parameter and accepts optional body parameters such as date, start_time, end_time, break, comment, project_id, and skip_approval. Headers may include X-Personio-Partner-ID and X-Personio-App-ID for identification. The response includes a success status and a message or error details if the request fails.

Custom Reports

GET https://api.personio.de/v1/company/custom-reports/columns : The 'List Custom Report Column Labels' API endpoint provides human-readable labels for report table columns. It is useful for matching column IDs to their translations, especially when dealing with custom attributes or absence data. The API accepts optional query parameters such as 'columns' to filter specific columns, 'locale' for translating localized fields, and 'report_id' to filter results by report ID. If no report ID is provided, all columns for the company are returned. The response includes metadata about the request and detailed information about each column, including its ID, human-readable label, and data type.
GET https://api.personio.de/v1/company/custom-reports/reports : The 'List Custom Reports' API endpoint allows users to retrieve metadata about existing custom reports in their Personio account. The API supports filtering the results by report IDs and status through query parameters. The request headers can include 'X-Personio-Partner-ID' and 'X-Personio-App-ID' for identification purposes. The successful response (HTTP 200) includes metadata such as total elements, current page, and total pages, along with detailed information about each report, including its ID, name, description, author, type, status, date range, and filters. In case of an error (HTTP 500), the response provides details about the error, including a trace ID, timestamp, and error specifics.
GET https://api.personio.de/v1/company/custom-reports/reports/{report_id} : The 'Get Custom Report by ID' API endpoint allows users to retrieve data of an existing custom report by specifying the report ID. The endpoint requires the 'report_id' as a path parameter. Optional query parameters include 'locale' for translating localized fields, 'page' for pagination, and 'limit' to specify the number of employees returned per page. Headers can include 'X-Personio-Partner-ID' and 'X-Personio-App-ID' for partner and application identification. The response includes a success status, metadata about the report, and detailed data about the report's attributes, including employee information and various attributes such as performance targets, salary, and compensation details. The API handles various response codes, including 200 for success, 400 for bad requests, 404 for report not found, and 500 for internal server errors.

Document Management

GET https://api.personio.de/v1/company/document-categories : The 'List Document Categories' API endpoint is used to fetch all document categories of a company. It requires optional headers 'X-Personio-Partner-ID' and 'X-Personio-App-ID' for partner and application identification. The response includes a success flag and a list of document categories, each with an ID, type, and name attribute.
POST https://api.personio.de/v1/company/documents : This API endpoint allows for uploading documents to the profiles of company employees. It requires a POST request to the specified URL with necessary headers and body parameters. The body parameters include the document title, employee ID, category ID, and the file itself, among others. The response will indicate success with details of the uploaded document or provide error messages if the upload fails due to invalid parameters or non-existent employee or category IDs.

Employee Management

GET https://api.personio.de/v1/company/employees : The 'List Company Employees' API allows users to retrieve a list of employees from a company. The API endpoint is 'https://api.personio.de/v1/company/employees' and it uses the GET method. Users can filter the results using query parameters such as 'limit', 'offset', 'email', 'attributes[]', and 'updated_since'. The 'updated_since' filter is applied only to attributes that are whitelisted as part of the API Credentials. The API requires optional headers 'X-Personio-Partner-ID' and 'X-Personio-App-ID'. The response includes a list of employees with detailed attributes such as 'id', 'first_name', 'last_name', 'email', 'gender', 'status', and more. The response is in JSON format and includes a 'success' boolean and a 'data' array containing employee details.
GET https://api.personio.de/v1/company/employees/attributes : The 'List Allowed Employee Attributes' API endpoint allows users to retrieve a list of all the attributes that can be associated with employees in the Personio system. This includes standard attributes like first name, last name, email, and more specialized attributes such as hire date, termination date, and salary details. The API requires optional headers for partner and application identification. The response includes a success flag and a data array containing objects with details about each attribute, including its key, label, type, universal ID, and any options available for list-type attributes.
GET https://api.personio.de/v1/company/employees/custom-attributes : The 'List Allowed Custom Attributes' API endpoint allows users to retrieve a list of custom attributes available for employees in the Personio system. This endpoint is an alias for /company/employees/attributes. The API uses the GET method and requires optional headers for partner and application identification. The response includes a success flag and a data array containing objects with details about each attribute, such as key, label, type, universal ID, and options for list-type attributes. The available attribute types include standard, date, integer, decimal, list, link, tags, and multiline.
GET https://api.personio.de/v1/company/employees/{employee_id} : The 'Get Employee by ID' API allows users to retrieve detailed information about a specific employee using their unique employee ID. The API requires the 'employee_id' as a path parameter, which is mandatory. Optional headers include 'X-Personio-Partner-ID' and 'X-Personio-App-ID' for partner and application identification. The response includes a success flag and a data object containing comprehensive employee attributes such as personal details (first name, last name, email, gender), employment details (position, supervisor, employment type, weekly working hours), and other organizational information (department, office, subcompany, cost centers, holiday calendar, work schedule). In case of an error, the response will include an error object with a code and message.
GET https://api.personio.de/v1/company/employees/{employee_id}/absences/balance : This API retrieves the absence balance for a specific employee identified by the employee_id path parameter. The request requires optional headers for partner and application identifiers. The response includes a success flag and a data array containing details of various absence types, their effective balance, and available balance. If the request fails, an error object with a code and message is returned.
GET https://api.personio.de/v1/company/employees/{employee_id}/profile-picture/{width} : The Get Employee Profile Picture API retrieves the profile picture of a specified employee. It requires the employee's numeric ID and the desired width of the image as path parameters. The API supports optional headers for partner and application identification. If the profile picture is available, it returns the image in the specified width. If the employee does not exist, the profile picture is missing, or the attribute is not whitelisted, a 404 error is returned with details in the response body.

Time-Off Management

GET https://api.personio.de/v1/company/time-off-types : The List Time-Off Types API provides a list of absence types for absences with time units set to either days or hours. It includes types such as 'Paid vacation', 'Parental leave', or 'Home office'. The API supports pagination through 'limit' and 'offset' query parameters. The response includes a success flag and an array of time-off type objects, each containing details like id, name, unit, category, legacy category, and other attributes related to the time-off type.
POST https://api.personio.de/v1/company/time-offs : The 'Create a Time-Off' API allows you to add absence data for employees for absence types with a time unit set to days. The API requires the employee ID, time-off type ID, start and end dates, and whether the start and end dates are half-days. Optional parameters include a comment and a flag to skip approval. The API returns a success status and details of the created time-off, including the time-off type, employee details, and certificate status. Error responses include invalid requests, not found errors, and validation errors.
DELETE https://api.personio.de/v1/company/time-offs/{id} : The 'Delete Time-Off by ID' API allows users to delete an absence period by specifying its ID in the path parameters. The API uses the DELETE method and requires the 'id' path parameter to identify the absence period to be deleted. Optional headers 'X-Personio-Partner-ID' and 'X-Personio-App-ID' can be included for partner and application identification. Upon successful deletion, a 200 response is returned with a success message. If the ID is invalid, a 400 error response is returned, and if the absence period is not found, a 404 error response is returned.

Recruiting

POST https://api.personio.de/v1/recruiting/applications : This API allows you to create applications in Personio by sending a POST request to the specified endpoint. The request body must include details such as the job position ID, applicant's first and last name, and email. Optional fields include recruiting channel ID, external posting ID, message, application date, tags, phase, files, and attributes. The response will indicate success with a 201 status code or provide error details if the request fails.
POST https://api.personio.de/v1/recruiting/applications/documents : This API endpoint allows users to upload documents that can later be attached to applications. The request requires a multipart-form-data file upload with a maximum size of 20MB. Supported file types include pdf, pptx, xlsx, docx, and many others. The request headers must include the company's Personio ID and an authorization bearer token. Upon successful upload, the response returns a UUID for the file, which can be used to attach the file to an application. The response also includes the file size, MIME type, original filename, and file extension. Error responses include unauthorized access, forbidden access, payload too large, unprocessable entity, too many requests, and internal server error.

Job Positions

GET https://api.personio.de/xml : The Retrieve Open Positions API allows users to access the job positions XML feed from the Company Career Site. The API supports multiple languages, specified by the 'language' query parameter, which is required. The available languages are German (de), English (en), French (fr), Spanish (es), Dutch (nl), Italian (it), and Portuguese (pt). The request headers may include 'X-Personio-Partner-ID' and 'X-Personio-App-ID' for partner and application identification, respectively, and must include 'X-Company-ID' for the company's Personio ID. The response includes an array of job postings, each containing details such as job ID, subcompany, office, department, recruiting category, job name, job descriptions, employment type, seniority, schedule, years of experience, keywords, occupation, occupation category, and creation date.

Personio API FAQs

How do I generate API credentials in Personio?

Answer: To generate API credentials in Personio:some text
1. Navigate to Settings > Integrations > API Credentials.
2. Click on Generate new credentials.
3. Select the desired scopes and readable attributes for the API key.
4. Save the generated client_id and client_secret securely.
Source: Generate and manage API credentials - Personio

What authentication method does the Personio API use?

Answer: The Personio API uses OAuth 2.0 for authentication. After obtaining your client_id and client_secret, you can request an access token by making a POST request to the authentication endpoint. This token must be included in the Authorization header of your subsequent API requests.
Source: Get started with Personio API - Personio Developer Hub

Are there rate limits for the Personio API?

Answer: Yes, Personio enforces rate limits to ensure fair usage:some text
- Documents and Applications Endpoints: Limited to 20 requests per 60 seconds per company.
- Other Endpoints: Specific rate limits are not publicly documented; it's recommended to implement error handling for potential 429 Too Many Requests responses.
Source: Introduction - Personio Developer Hub

Can I retrieve employee data using the Personio API?

Answer: Yes, you can retrieve employee data by making a GET request to the /v1/company/employees endpoint. Ensure that the desired employee attributes are whitelisted in your API credentials settings to access them via the API.
Source: List Employees - Personio Developer Hub

Does the Personio API support webhooks?

Answer: Yes, Personio supports webhooks for specific events, such as when an employee's profile is created, updated, or deleted. You can configure webhooks to receive real-time notifications for these events.
Source: Personio Developer Hub

‍

Get Started with Personio API Integration

For quick and seamless integration with Personio API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Personio API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Personio API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

Hubspot API Directory

HubSpot is a cloud-based software platform designed to facilitate business growth by offering an integrated suite of tools for marketing, sales, customer service, and customer relationship management (CRM). Known for its user-friendly interface and robust integration capabilities, HubSpot provides businesses with the resources needed to enhance their operations and customer interactions. The platform is particularly popular among companies focusing on digital marketing and customer engagement strategies, making it a versatile solution for businesses of all sizes and industries.

HubSpot's comprehensive offerings include the Marketing Hub, which aids businesses in attracting visitors, converting leads, and closing customers through features like email marketing, social media management, and SEO analytics. The Sales Hub empowers sales teams to manage pipelines and automate tasks efficiently, while the Service Hub focuses on improving customer satisfaction with tools for ticketing and feedback management. Additionally, HubSpot's CRM offers a centralized database for tracking and nurturing leads, and the CMS Hub provides an intuitive content management system for website creation and optimization.

Key highlights of Hubspot APIs

1. Easy Data Access:
- The HubSpot API facilitates seamless access to data, enhancing accuracy and efficiency in business operations.
2. Automation:
- Supports marketing automation, sales enablement, and customer service, streamlining processes and increasing productivity.
3. Custom Integration:
- Enables seamless data exchange between HubSpot and other systems, improving overall productivity.
4. Real-Time Sync:
- Utilizes webhooks for prompt notifications of changes, ensuring up-to-date data synchronization.
5. Scalable:
- Capable of handling up to 150 requests per second, accommodating growing business needs.
6. Developer-Friendly:
- Extensive documentation and support make it accessible for developers to implement and manage.
7. Global Support:
- Implied by HubSpot's international presence, offering assistance across different regions.
8. Error Handling and Logging:
- Standard features included to manage and troubleshoot integration issues effectively.
9. Rate Limiting:
- Ensures fair usage and prevents abuse by limiting the number of requests per second.
10. Version Control:
- Maintains stability and compatibility across different API versions.
11. Data Transformation:
- Managed within integration logic to suit specific business requirements.
12. Webhook Support:
- Allows for event subscriptions, enhancing real-time data handling capabilities.
13. Detailed Analytics and Reporting:
- Likely includes features for comprehensive data insights to aid decision-making.
14. Sandbox Environment:
- A 60-day testing environment is available for development and experimentation.

Hubspot API Endpoints

Imports

POST /crm/v3/imports/ : Start a New Import
GET https://api.hubapi.com/crm/v3/imports/ : Get Active Imports
GET https://api.hubapi.com/crm/v3/imports/{importId} : Get Import Information
POST https://api.hubapi.com/crm/v3/imports/{importId}/cancel : Cancel an Active Import
GET https://api.hubapi.com/crm/v3/imports/{importId}/errors : Get Import Errors

CRM Object Schemas

GET https://api.hubapi.com/crm-object-schemas/v3/schemas : Get All CRM Object Schemas
DELETE https://api.hubapi.com/crm-object-schemas/v3/schemas/ : Delete a Schema
PATCH https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType} : Update Object Schema
POST https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType}/associations : Create an Association Between Object Types
DELETE https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType}/associations/{associationIdentifier} : Remove an Association from a Schema
DELETE https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType}/purge : Delete CRM Object Schema

Exports

POST https://api.hubapi.com/crm/v3/exports/export/async : Start an Export of CRM Data
GET https://api.hubapi.com/crm/v3/exports/export/async/tasks/{taskId}/status : Get Export Task Status

Calling Extensions

POST https://api.hubapi.com/crm/v3/extensions/calling/recordings/ready : Mark Recording as Ready for Transcription
POST https://api.hubapi.com/crm/v3/extensions/calling/{appId}/settings : Configure a Calling Extension
PATCH https://api.hubapi.com/crm/v3/extensions/calling/{appId}/settings/recording : Update Calling App's Recording Settings

Cards

GET https://api.hubapi.com/crm/v3/extensions/cards-dev/sample-response : Get Sample Card Detail Response
GET https://api.hubapi.com/crm/v3/extensions/cards-dev/{appId} : Get All Cards for a Given App
DELETE https://api.hubapi.com/crm/v3/extensions/cards-dev/{appId}/{cardId} : Delete Card Definition

Video Conferencing

DELETE https://api.hubapi.com/crm/v3/extensions/videoconferencing/settings/{appId} : Delete Video Conference Application Settings

Lists

POST https://api.hubapi.com/crm/v3/lists/ : Create List
GET https://api.hubapi.com/crm/v3/lists/folders : Retrieve Folder with Child Nodes
PUT https://api.hubapi.com/crm/v3/lists/folders/move-list : Move List to Folder
DELETE https://api.hubapi.com/crm/v3/lists/folders/{folderId} : Delete CRM Folder
PUT https://api.hubapi.com/crm/v3/lists/folders/{folderId}/move/{newParentFolderId} : Move a Folder in CRM
PUT https://api.hubapi.com/crm/v3/lists/folders/{folderId}/rename : Rename a Folder in CRM
GET https://api.hubapi.com/crm/v3/lists/idmapping : Translate Legacy List Id to Modern List Id
GET https://api.hubapi.com/crm/v3/lists/object-type-id/{objectTypeId}/name/{listName} : Fetch List by Name
GET https://api.hubapi.com/crm/v3/lists/records/{objectTypeId}/{recordId}/memberships : Get Lists Record is Member Of
POST https://api.hubapi.com/crm/v3/lists/search : Search Lists by Name or Page Through All Lists
GET https://api.hubapi.com/crm/v3/lists/{listId} : Fetch List by ID
DELETE https://api.hubapi.com/crm/v3/lists/{listId}/memberships : Delete All Records from a List
PUT https://api.hubapi.com/crm/v3/lists/{listId}/memberships/add : Add Records to a List
PUT https://api.hubapi.com/crm/v3/lists/{listId}/memberships/add-and-remove : Add and/or Remove Records from a List
PUT https://api.hubapi.com/crm/v3/lists/{listId}/memberships/add-from/{sourceListId} : Add All Records from a Source List to a Destination List
GET https://api.hubapi.com/crm/v3/lists/{listId}/memberships/join-order : Fetch List Memberships Ordered by Added to List Date
PUT https://api.hubapi.com/crm/v3/lists/{listId}/memberships/remove : Remove Records from a List
PUT https://api.hubapi.com/crm/v3/lists/{listId}/restore : Restore a Deleted List
PUT https://api.hubapi.com/crm/v3/lists/{listId}/update-list-filters : Update List Filter Definition
PUT https://api.hubapi.com/crm/v3/lists/{listId}/update-list-name : Update List Name

CRM Objects

GET https://api.hubapi.com/crm/v3/objects/calls : Read a Page of Calls
POST https://api.hubapi.com/crm/v3/objects/calls/batch/archive : Archive a Batch of Calls by ID
POST https://api.hubapi.com/crm/v3/objects/calls/batch/create : Create a Batch of Calls
POST https://api.hubapi.com/crm/v3/objects/calls/batch/read : Read a Batch of Calls by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/calls/batch/update : Update a Batch of Calls by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/calls/batch/upsert : Create or Update a Batch of Calls by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/calls/search : Search Calls in CRM
PATCH https://api.hubapi.com/crm/v3/objects/calls/{callId} : Partial Update of CRM Call Object
GET https://api.hubapi.com/crm/v3/objects/carts : Read a Page of Carts
POST https://api.hubapi.com/crm/v3/objects/carts/batch/archive : Archive a Batch of Carts by ID
POST https://api.hubapi.com/crm/v3/objects/carts/batch/create : Create a Batch of Carts
POST https://api.hubapi.com/crm/v3/objects/carts/batch/read : Read a Batch of Carts by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/carts/batch/update : Update a Batch of Carts by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/carts/batch/upsert : Create or Update a Batch of Carts by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/carts/search : Search Carts in CRM
DELETE https://api.hubapi.com/crm/v3/objects/carts/{cartId} : Delete Cart Object
GET https://api.hubapi.com/crm/v3/objects/commerce_payments : List Commerce Payments
POST https://api.hubapi.com/crm/v3/objects/commerce_payments/batch/read : Read a Batch of Commerce Payments by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/commerce_payments/search : Search Commerce Payments
GET https://api.hubapi.com/crm/v3/objects/commerce_payments/{commercePaymentId} : Get Commerce Payment Details
POST https://api.hubapi.com/crm/v3/objects/communications : Create a Communication
POST https://api.hubapi.com/crm/v3/objects/communications/batch/archive : Archive a Batch of Communications by ID
POST https://api.hubapi.com/crm/v3/objects/communications/batch/create : Create a Batch of Communications
POST https://api.hubapi.com/crm/v3/objects/communications/batch/read : Read a Batch of Communications by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/communications/batch/update : Update a Batch of Communications by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/communications/batch/upsert : Create or Update a Batch of Communications by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/communications/search : Search Communications in CRM
PATCH https://api.hubapi.com/crm/v3/objects/communications/{communicationId} : Partial Update of Communication Object
POST https://api.hubapi.com/crm/v3/objects/companies : Create a Company
POST https://api.hubapi.com/crm/v3/objects/companies/batch/archive : Archive a Batch of Companies by ID
POST https://api.hubapi.com/crm/v3/objects/companies/batch/create : Create a Batch of Companies
POST https://api.hubapi.com/crm/v3/objects/companies/batch/read : Read a Batch of Companies by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/companies/batch/update : Update a Batch of Companies by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/companies/batch/upsert : Create or Update a Batch of Companies by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/companies/merge : Merge Two Companies with Same Type
POST https://api.hubapi.com/crm/v3/objects/companies/search : Search Companies in CRM
DELETE https://api.hubapi.com/crm/v3/objects/companies/{companyId} : Delete a Company Object
POST https://api.hubapi.com/crm/v3/objects/contacts : Create a Contact in HubSpot CRM
POST https://api.hubapi.com/crm/v3/objects/contacts/batch/archive : Archive a Batch of Contacts by ID
POST https://api.hubapi.com/crm/v3/objects/contacts/batch/create : Create a Batch of Contacts
POST https://api.hubapi.com/crm/v3/objects/contacts/batch/read : Read a Batch of Contacts by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/contacts/batch/update : Update a Batch of Contacts by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/contacts/batch/upsert : Create or Update a Batch of Contacts by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/contacts/gdpr-delete : GDPR Delete Contact
POST https://api.hubapi.com/crm/v3/objects/contacts/merge : Merge Two Contacts with Same Type
POST https://api.hubapi.com/crm/v3/objects/contacts/search : Search Contacts in CRM
DELETE https://api.hubapi.com/crm/v3/objects/contacts/{contactId} : Delete Contact by ID
GET https://api.hubapi.com/crm/v3/objects/deals : Read a Page of Deals
POST https://api.hubapi.com/crm/v3/objects/deals/batch/archive : Archive a Batch of Deals by ID
POST https://api.hubapi.com/crm/v3/objects/deals/batch/create : Create a Batch of Deals
POST https://api.hubapi.com/crm/v3/objects/deals/batch/read : Read a Batch of Deals by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/deals/batch/update : Update a Batch of Deals by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/deals/batch/upsert : Create or Update a Batch of Deals by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/deals/merge : Merge Two Deals with Same Type
POST https://api.hubapi.com/crm/v3/objects/deals/search : Search Deals in CRM
POST https://api.hubapi.com/crm/v3/objects/deals/splits/batch/read : Read a Batch of Deal Split Objects by Deal Object Internal ID
POST https://api.hubapi.com/crm/v3/objects/deals/splits/batch/upsert : Create or Replace Deal Splits for Deals
DELETE https://api.hubapi.com/crm/v3/objects/deals/{dealId} : Delete a Deal Object
POST https://api.hubapi.com/crm/v3/objects/discounts : Create a Discount
POST https://api.hubapi.com/crm/v3/objects/discounts/batch/archive : Archive a Batch of Discounts by ID
POST https://api.hubapi.com/crm/v3/objects/discounts/batch/create : Create a Batch of Discounts
POST https://api.hubapi.com/crm/v3/objects/discounts/batch/read : Read a Batch of Discounts by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/discounts/batch/update : Update a Batch of Discounts by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/discounts/batch/upsert : Create or Update a Batch of Discounts by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/discounts/search : Search Discounts in CRM
PATCH https://api.hubapi.com/crm/v3/objects/discounts/{discountId} : Partial Update of Discount Object
GET https://api.hubapi.com/crm/v3/objects/emails : Read a Page of Emails
POST https://api.hubapi.com/crm/v3/objects/emails/batch/archive : Archive a Batch of Emails by ID
POST https://api.hubapi.com/crm/v3/objects/emails/batch/create : Create a Batch of Emails
POST https://api.hubapi.com/crm/v3/objects/emails/batch/read : Read a Batch of Emails by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/emails/batch/update : Update a Batch of Emails by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/emails/batch/upsert : Create or Update a Batch of Emails by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/emails/search : Search Emails in CRM
GET https://api.hubapi.com/crm/v3/objects/emails/{emailId} : Get Email Object Details
GET https://api.hubapi.com/crm/v3/objects/feedback_submissions : Get Feedback Submissions
POST https://api.hubapi.com/crm/v3/objects/feedback_submissions/batch/read : Read a Batch of Feedback Submissions by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/feedback_submissions/search : Search Feedback Submissions
GET https://api.hubapi.com/crm/v3/objects/feedback_submissions/{feedbackSubmissionId} : Get Feedback Submission Details
POST https://api.hubapi.com/crm/v3/objects/fees : Create a Fee with Given Properties
POST https://api.hubapi.com/crm/v3/objects/fees/batch/archive : Archive a Batch of Fees by ID
POST https://api.hubapi.com/crm/v3/objects/fees/batch/create : Create a Batch of Fees
POST https://api.hubapi.com/crm/v3/objects/fees/batch/read : Read a Batch of Fees by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/fees/batch/update : Update a Batch of Fees by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/fees/batch/upsert : Create or Update a Batch of Fees by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/fees/search : Search Fees in CRM
GET https://api.hubapi.com/crm/v3/objects/fees/{feeId} : Get Fee Object Details
GET https://api.hubapi.com/crm/v3/objects/goal_targets : Read a Page of Goal Targets
POST https://api.hubapi.com/crm/v3/objects/goal_targets/batch/read : Read a Batch of Goal Targets by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/goal_targets/search : Search Goal Targets
GET https://api.hubapi.com/crm/v3/objects/goal_targets/{goalTargetId} : Read Goal Target Object
GET https://api.hubapi.com/crm/v3/objects/invoices : Read a Page of Invoices
POST https://api.hubapi.com/crm/v3/objects/invoices/batch/read : Read a Batch of Invoices by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/invoices/search : Search Invoices in CRM
GET https://api.hubapi.com/crm/v3/objects/invoices/{invoiceId} : Get Invoice Details
POST https://api.hubapi.com/crm/v3/objects/leads : Create a Lead
POST https://api.hubapi.com/crm/v3/objects/leads/batch/archive : Archive a Batch of Leads by ID
POST https://api.hubapi.com/crm/v3/objects/leads/batch/create : Create a Batch of Leads
POST https://api.hubapi.com/crm/v3/objects/leads/batch/read : Read a Batch of Leads by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/leads/batch/update : Update a Batch of Leads by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/leads/batch/upsert : Create or Update a Batch of Leads by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/leads/search : Search Leads in CRM
DELETE https://api.hubapi.com/crm/v3/objects/leads/{leadsId} : Delete Lead Object
POST https://api.hubapi.com/crm/v3/objects/line_items : Create Line Item
POST https://api.hubapi.com/crm/v3/objects/line_items/batch/archive : Archive a Batch of Line Items by ID
POST https://api.hubapi.com/crm/v3/objects/line_items/batch/create : Create a Batch of Line Items
POST https://api.hubapi.com/crm/v3/objects/line_items/batch/read : Read a Batch of Line Items by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/line_items/batch/update : Update a Batch of Line Items by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/line_items/batch/upsert : Create or Update a Batch of Line Items by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/line_items/search : Search Line Items in CRM
PATCH https://api.hubapi.com/crm/v3/objects/line_items/{lineItemId} : Partial Update of Line Item Object
GET https://api.hubapi.com/crm/v3/objects/meetings : Read a Page of Meetings
POST https://api.hubapi.com/crm/v3/objects/meetings/batch/archive : Archive a Batch of Meetings by ID
POST https://api.hubapi.com/crm/v3/objects/meetings/batch/create : Create a Batch of Meetings
POST https://api.hubapi.com/crm/v3/objects/meetings/batch/read : Read a Batch of Meetings by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/meetings/batch/update : Update a Batch of Meetings by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/meetings/batch/upsert : Create or Update a Batch of Meetings by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/meetings/search : Search Meetings in CRM
DELETE https://api.hubapi.com/crm/v3/objects/meetings/{meetingId} : Archive Meeting Object
POST https://api.hubapi.com/crm/v3/objects/notes : Create a Note in HubSpot CRM
POST https://api.hubapi.com/crm/v3/objects/notes/batch/archive : Archive a Batch of Notes by ID
POST https://api.hubapi.com/crm/v3/objects/notes/batch/create : Create a Batch of Notes
POST https://api.hubapi.com/crm/v3/objects/notes/batch/read : Read a Batch of Notes by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/notes/batch/update : Update a Batch of Notes by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/notes/batch/upsert : Create or Update a Batch of Notes by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/notes/search : Search CRM Notes
PATCH https://api.hubapi.com/crm/v3/objects/notes/{noteId} : Partial Update of CRM Note Object
GET https://api.hubapi.com/crm/v3/objects/orders : Read a Page of Orders
POST https://api.hubapi.com/crm/v3/objects/orders/batch/archive : Archive a Batch of Orders by ID
POST https://api.hubapi.com/crm/v3/objects/orders/batch/create : Create a Batch of Orders
POST https://api.hubapi.com/crm/v3/objects/orders/batch/read : Read a Batch of Orders by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/orders/batch/update : Update a Batch of Orders by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/orders/batch/upsert : Create or Update a Batch of Orders by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/orders/search : Search Orders in CRM
GET https://api.hubapi.com/crm/v3/objects/orders/{orderId} : Read Order Object by ID
GET https://api.hubapi.com/crm/v3/objects/postal_mail : Read a Page of Postal Mail
POST https://api.hubapi.com/crm/v3/objects/postal_mail/batch/archive : Archive a Batch of Postal Mail by ID
POST https://api.hubapi.com/crm/v3/objects/postal_mail/batch/create : Create a Batch of Postal Mail
POST https://api.hubapi.com/crm/v3/objects/postal_mail/batch/read : Read a Batch of Postal Mail by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/postal_mail/batch/update : Update a Batch of Postal Mail by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/postal_mail/batch/upsert : Create or Update a Batch of Postal Mail by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/postal_mail/search : Search Postal Mail Objects in CRM
DELETE https://api.hubapi.com/crm/v3/objects/postal_mail/{postalMailId} : Delete Postal Mail Object
POST https://api.hubapi.com/crm/v3/objects/products : Create a Product
POST https://api.hubapi.com/crm/v3/objects/products/batch/archive : Archive a Batch of Products by ID
POST https://api.hubapi.com/crm/v3/objects/products/batch/create : Create a Batch of Products
POST https://api.hubapi.com/crm/v3/objects/products/batch/read : Read a Batch of Products by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/products/batch/update : Update a Batch of Products by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/products/batch/upsert : Create or Update a Batch of Products by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/products/search : Search Products in CRM
GET https://api.hubapi.com/crm/v3/objects/products/{productId} : Get Product Details by Product ID
GET https://api.hubapi.com/crm/v3/objects/quotes : Read a Page of Quotes
POST https://api.hubapi.com/crm/v3/objects/quotes/batch/archive : Archive a Batch of Quotes by ID
POST https://api.hubapi.com/crm/v3/objects/quotes/batch/create : Create a Batch of Quotes
POST https://api.hubapi.com/crm/v3/objects/quotes/batch/read : Read a Batch of Quotes by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/quotes/batch/update : Update a Batch of Quotes by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/quotes/batch/upsert : Create or Update a Batch of Quotes by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/quotes/search : Search Quotes in CRM
GET https://api.hubapi.com/crm/v3/objects/quotes/{quoteId} : Get Quote Details by Quote ID
GET https://api.hubapi.com/crm/v3/objects/subscriptions : Read a Page of Subscriptions
POST https://api.hubapi.com/crm/v3/objects/subscriptions/batch/read : Read a Batch of Subscriptions by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/subscriptions/search : Search Subscriptions in CRM
GET https://api.hubapi.com/crm/v3/objects/subscriptions/{subscriptionId} : Get Subscription Details
GET https://api.hubapi.com/crm/v3/objects/tasks : Read a Page of Tasks
POST https://api.hubapi.com/crm/v3/objects/tasks/batch/archive : Archive a Batch of Tasks by ID
POST https://api.hubapi.com/crm/v3/objects/tasks/batch/create : Create a Batch of Tasks
POST https://api.hubapi.com/crm/v3/objects/tasks/batch/read : Read a Batch of Tasks by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/tasks/batch/update : Update a Batch of Tasks by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/tasks/batch/upsert : Create or Update a Batch of Tasks by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/tasks/search : Search CRM Tasks
DELETE https://api.hubapi.com/crm/v3/objects/tasks/{taskId} : Delete Task Object
GET https://api.hubapi.com/crm/v3/objects/taxes : Read a Page of Taxes
POST https://api.hubapi.com/crm/v3/objects/taxes/batch/archive : Archive a Batch of Taxes by ID
POST https://api.hubapi.com/crm/v3/objects/taxes/batch/create : Create a Batch of Taxes
POST https://api.hubapi.com/crm/v3/objects/taxes/batch/read : Read a Batch of Taxes by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/taxes/batch/update : Update a Batch of Taxes by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/taxes/batch/upsert : Create or Update a Batch of Taxes by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/taxes/search : Search Taxes in CRM
DELETE https://api.hubapi.com/crm/v3/objects/taxes/{taxId} : Delete Tax Object
GET https://api.hubapi.com/crm/v3/objects/tickets : Read a Page of Tickets
POST https://api.hubapi.com/crm/v3/objects/tickets/batch/archive : Archive a Batch of Tickets by ID
POST https://api.hubapi.com/crm/v3/objects/tickets/batch/create : Create a Batch of Tickets
POST https://api.hubapi.com/crm/v3/objects/tickets/batch/read : Read a Batch of Tickets by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/tickets/batch/update : Update a Batch of Tickets by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/tickets/batch/upsert : Create or Update a Batch of Tickets by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/tickets/merge : Merge Two Tickets with Same Type
POST https://api.hubapi.com/crm/v3/objects/tickets/search : Search CRM Tickets
GET https://api.hubapi.com/crm/v3/objects/tickets/{ticketId} : Get Ticket Details by Ticket ID
GET https://api.hubapi.com/crm/v3/objects/{objectType} : Read a Page of CRM Objects
POST https://api.hubapi.com/crm/v3/objects/{objectType}/batch/archive : Archive a Batch of CRM Objects by ID
POST https://api.hubapi.com/crm/v3/objects/{objectType}/batch/create : Create a Batch of CRM Objects
POST https://api.hubapi.com/crm/v3/objects/{objectType}/batch/read : Read a Batch of CRM Objects by Internal ID or Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/{objectType}/batch/update : Update a Batch of CRM Objects
POST https://api.hubapi.com/crm/v3/objects/{objectType}/batch/upsert : Create or Update a Batch of CRM Objects by Unique Property Values
POST https://api.hubapi.com/crm/v3/objects/{objectType}/search : Search CRM Objects
PATCH https://api.hubapi.com/crm/v3/objects/{objectType}/{objectId} : Partial Update of CRM Object

CRM Owners

GET https://api.hubapi.com/crm/v3/owners/ : Get a Page of CRM Owners
GET https://api.hubapi.com/crm/v3/owners/{ownerId} : Read an Owner by Given ID or UserID

Pipelines

GET https://api.hubapi.com/crm/v3/pipelines/{objectType} : Retrieve All Pipelines for a Specified Object Type
PUT https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId} : Replace a Pipeline
GET https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/audit : Get Pipeline Audit
GET https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/stages : Get Pipeline Stages
DELETE https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} : Delete a Pipeline Stage
GET https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit : Get Audit of Pipeline Stage Changes

Properties

POST https://api.hubapi.com/crm/v3/properties/{objectType} : Create a Property for a Specified Object Type
POST https://api.hubapi.com/crm/v3/properties/{objectType}/batch/archive : Archive a Batch of Properties
POST https://api.hubapi.com/crm/v3/properties/{objectType}/batch/create : Create a Batch of Properties
POST https://api.hubapi.com/crm/v3/properties/{objectType}/batch/read : Read a Batch of Properties
GET https://api.hubapi.com/crm/v3/properties/{objectType}/groups : Read All Property Groups for Specified Object Type
PATCH https://api.hubapi.com/crm/v3/properties/{objectType}/groups/{groupName} : Update a Property Group
DELETE https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName} : Archive a Property

Associations

GET https://api.hubapi.com/crm/v4/associations/definitions/configurations/all : Get All User Configurations
GET https://api.hubapi.com/crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType} : Get User Configurations on Association Definitions
POST https://api.hubapi.com/crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create : Batch Create User Configurations Between Two Object Types
POST https://api.hubapi.com/crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}/batch/purge : Batch Delete User Configurations Between Two Object Types
POST https://api.hubapi.com/crm/v4/associations/definitions/configurations/{fromObjectType}/{toObjectType}/batch/update : Batch Update User Configurations Between Two Object Types
POST https://api.hubapi.com/crm/v4/associations/usage/high-usage-report/{userId} : Generate High Usage Report for User
POST https://api.hubapi.com/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/associate/default : Create Default Associations
POST https://api.hubapi.com/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/labels/archive : Delete Specific Association Labels
POST https://api.hubapi.com/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/read : Batch Read Associations for CRM Objects
GET https://api.hubapi.com/crm/v4/associations/{fromObjectType}/{toObjectType}/labels : Get Association Types Between Object Types
DELETE https://api.hubapi.com/crm/v4/associations/{fromObjectType}/{toObjectType}/labels/{associationTypeId} : Delete Association Definition
PUT https://api.hubapi.com/crm/v4/objects/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId} : Create Default Association Between Two Object Types
GET https://api.hubapi.com/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType} : List All Associations of an Object by Object Type
DELETE https://api.hubapi.com/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId} : Delete Associations Between Two Records

Timeline Events

POST https://api.hubapi.com/integrators/timeline/v3/events : Create a Single Timeline Event
POST https://api.hubapi.com/integrators/timeline/v3/events/batch/create : Create Multiple Timeline Events
GET https://api.hubapi.com/integrators/timeline/v3/events/{eventTemplateId}/{eventId} : Get Event Details
GET https://api.hubapi.com/integrators/timeline/v3/events/{eventTemplateId}/{eventId}/detail : Get Event Detail Template Rendered
GET https://api.hubapi.com/integrators/timeline/v3/events/{eventTemplateId}/{eventId}/render : Render Event Template as HTML
POST https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates : Create Event Template for App
DELETE https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId} : Delete Event Template for App
POST https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens : Add Token to Event Template
DELETE https://api.hubapi.com/integrators/timeline/v3/{appId}/event-templates/{eventTemplateId}/tokens/{tokenName} : Remove Token from Event Template

‍

HubSpot API FAQs

How do I authenticate with the HubSpot API?

Answer: HubSpot offers multiple authentication methods for its API:some text
- Private Apps: Generate a personal access token within your HubSpot account. This method is recommended for most integrations.
- OAuth: Use OAuth 2.0 for applications that require user authorization.
- API Key: HubSpot is deprecating API keys in favor of private apps. It's advisable to transition to using private apps for authentication.
Source: HubSpot API Authentication

What are the rate limits for the HubSpot API?

Answer: HubSpot enforces rate limits to ensure fair usage:some text
- Private Apps: The default limit is 100 requests per 10 seconds.
- OAuth Apps: The default limit is 100 requests per 10 seconds per app per account.
- API Key: The default limit is 100 requests per 10 seconds.
- Some APIs may have stricter limits; always refer to the specific API documentation for details.
Source: HubSpot API Usage Guidelines

How can I retrieve all contacts using the HubSpot API?

Answer: To retrieve all contacts, use the CRM API's contacts endpoint:some text
- Send a GET request to /crm/v3/objects/contacts.
- Use pagination by including the after parameter to navigate through large sets of contacts.
- You can also specify properties to include in the response using the properties parameter.
Source: HubSpot CRM API | Contacts

Does HubSpot support webhooks for real-time data updates?

Answer: Yes, HubSpot provides a Webhooks API that allows you to subscribe to specific events, such as contact creation or property changes. When these events occur, HubSpot sends HTTP POST requests to your configured endpoint.
Source: HubSpot Webhooks API

Can I create custom objects in HubSpot via the API?

Answer: Yes, HubSpot's CRM API allows you to define and manage custom objects. This enables you to tailor HubSpot's data structure to fit your business needs.
Source: HubSpot CRM API | Custom Objects‍

‍

Get Started with Hubspot API Integration

For quick and seamless integration with HubSpot API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any HubSpot API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to HubSpot API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

FreshBooks API Directory

FreshBooks is a leading cloud-based accounting software tailored specifically for small businesses and freelancers. It offers an intuitive platform that simplifies financial management through its web and mobile applications. With FreshBooks, users can efficiently handle invoicing, expense tracking, time tracking, online payments, financial reporting, and project management. This makes it an ideal solution for small business owners, freelancers, and self-employed professionals, especially those in service-oriented industries such as consulting, design, and agency work. By streamlining accounting tasks, FreshBooks enables users to dedicate more time to their core business activities, enhancing productivity and growth.

One of the standout features of FreshBooks is its robust API integration capabilities. The FreshBooks API allows developers to seamlessly connect the software with other applications, facilitating data synchronization and automation of workflows. This integration potential is particularly beneficial for businesses looking to customize their accounting processes and improve operational efficiency. As you explore the FreshBooks API, you'll discover how it can be leveraged to create a more cohesive and efficient business ecosystem.

Key highlights of FreshBooks APIs

Authentication: Utilizes OAuth 2.0 for secure authentication, ensuring only authorized applications can access user data.
Data Formats: Communicates using JSON, compatible with a wide range of programming languages and platforms.
Extensive Documentation: Provides comprehensive guides and references for developers.
SDKs and Libraries: Offers official SDKs for Python and Node.js, with community-supported libraries for Java and PHP.

‍

FreshBooks API Endpoints

Accounting

GET https://api.freshbooks.com/accounting/account/<accountId>/bill_payments/bill_payments : List Bill Payments
PUT https://api.freshbooks.com/accounting/account/<accountId>/bill_payments/bill_payments/<billPaymentId> : Edit Payment to Bill
GET https://api.freshbooks.com/accounting/account/<accountId>/bill_vendors/bill_vendors : Get Vendors
PUT https://api.freshbooks.com/accounting/account/<accountId>/bill_vendors/bill_vendors/<vendorId> : Delete Vendor
POST https://api.freshbooks.com/accounting/account/<accountId>/bills/bills : Create a Bill
GET https://api.freshbooks.com/accounting/account/<accountId>/bills/bills/ : Get Bills
PUT https://api.freshbooks.com/accounting/account/<accountId>/bills/bills/<billId> : Delete Bill
POST https://api.freshbooks.com/accounting/account/<accountId>/expenses/expenses?include%5B%5D=attachment : Create Expense With Attachment
POST https://api.freshbooks.com/accounting/account/<accountId>/invoices/invoices : Create Invoice with Attachment
GET https://api.freshbooks.com/accounting/account/<accountId>/invoices/invoices/<invoiceId> : Get Single Invoice
GET https://api.freshbooks.com/accounting/account/<accountId>/users/clients : List Clients
PUT https://api.freshbooks.com/accounting/account/<accountId>/users/clients/ : Update Existing Client Profile with Secondary Contacts
GET https://api.freshbooks.com/accounting/account/<accountId>/users/clients/<customerId> : Get Single Client
GET https://api.freshbooks.com/accounting/account/<accountId>/users/clients/?include%5B%5D=recent_contacts : Get Client Profile and Associated Secondary Contacts
POST https://api.freshbooks.com/accounting/account/<account_id>/journal_entries/journal_entries : Add Journal Entry
GET https://api.freshbooks.com/accounting/account/<account_id>/journal_entries/journal_entry_details : Get Journal Entry Details
GET https://api.freshbooks.com/accounting/account/<account_id>/journal_entry_accounts/journal_entry_accounts : Get Accounts
GET https://api.freshbooks.com/accounting/account/<account_id>/projects/tasks : Listing Tasks
PUT https://api.freshbooks.com/accounting/account/<account_id>/projects/tasks/<task_id> : Delete a Task
GET https://api.freshbooks.com/accounting/account/<accountid> : Example Searches for Accounting Endpoint
POST https://api.freshbooks.com/accounting/account/<accountid>/credit_notes/credit_notes : Create Credit Note
PUT https://api.freshbooks.com/accounting/account/<accountid>/credit_notes/credit_notes/<creditid> : Delete Credit
POST https://api.freshbooks.com/accounting/account/<accountid>/estimates/estimates : Create Single Estimate
GET https://api.freshbooks.com/accounting/account/<accountid>/estimates/estimates/<estimateid> : Get Single Estimate
PUT https://api.freshbooks.com/accounting/account/<accountid>/estimates/estimates/<id> : Delete Single Estimate
GET https://api.freshbooks.com/accounting/account/<accountid>/expenses/categories : List Expense Categories
GET https://api.freshbooks.com/accounting/account/<accountid>/expenses/categories/<id> : Get Single Expense Category
GET https://api.freshbooks.com/accounting/account/<accountid>/expenses/expenses : List Expenses
GET https://api.freshbooks.com/accounting/account/<accountid>/expenses/expenses/<expenseid> : Get Single Expense
GET https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles : Listing Invoice Profiles
PUT https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles/<profileid> : Delete an Invoice Profile
GET https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles?include%5B%5D=next_issue_date : Including the next issue date
GET https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles?search%5Bclientid%5D=23482 : Search example with clientid
GET https://api.freshbooks.com/accounting/account/<accountid>/invoice_profiles/invoice_profiles?search%5Bcurrency_code%5D=USD : Search example with currency code
GET https://api.freshbooks.com/accounting/account/<accountid>/invoices/invoices : Example Sort (accounting endpoint)
GET https://api.freshbooks.com/accounting/account/<accountid>/items/items : List Items
PUT https://api.freshbooks.com/accounting/account/<accountid>/items/items/<id> : Update Single Item
GET https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/ : List Other Income Entries
DELETE https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<id> : Delete Other Income Entry
GET https://api.freshbooks.com/accounting/account/<accountid>/other_incomes/other_incomes/<incomeid> : Get Single Other Income
GET https://api.freshbooks.com/accounting/account/<accountid>/payments/payments : List Payments
PUT https://api.freshbooks.com/accounting/account/<accountid>/payments/payments/<id> : Update Single Payment
GET https://api.freshbooks.com/accounting/account/<accountid>/systems/gateways : List Gateways
DELETE https://api.freshbooks.com/accounting/account/<accountid>/systems/gateways/<id> : Delete Single Gateway
GET https://api.freshbooks.com/accounting/account/<accountid>/systems/systems/<id> : Get System
GET https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes : List Taxes
PUT https://api.freshbooks.com/accounting/account/<accountid>/taxes/taxes/<id> : Update Single Tax
PUT https://api.freshbooks.com/accounting/account/<accountid>/users/clients/<clientid> : Remove all Secondary Contacts
GET https://api.freshbooks.com/accounting/account/<accountid>/users/staffs : List Staff
GET https://api.freshbooks.com/accounting/account/<accountid>/users/staffs/<id> : Get Single Staff
GET https://api.freshbooks.com/account/{account_id}/projects/tasks : Search Examples for Tasks
POST https://api.freshbooks.com/accounting/businesses/{business_uuid}/ledger_accounts/accounts : Create Account
GET https://api.freshbooks.com/accounting/businesses/{bussiness_uuid}/ledger_accounts/accounts : Get Single Account
GET https://api.freshbooks.com/accounting/businesses/{bussiness_uuid}/ledger_accounts/accounts/{accountId} : Get Account

Authentication

GET https://api.freshbooks.com/auth/api/v1/businesses/<business_id>/team_members : List Team Members
GET https://api.freshbooks.com/auth/api/v1/businesses/<business_id>/team_members/<team_member_uuid> : Get Single Team Member
GET https://api.freshbooks.com/auth/api/v1/users/me : Get Companies Information
POST https://api.freshbooks.com/auth/oauth/revoke : Revoking a Bearer/Refresh Token
POST https://api.freshbooks.com/auth/oauth/token : Get Bearer token via refresh code

Comments

POST https://api.freshbooks.com/comments/business/<businessid>/service : Create a Service
PUT https://api.freshbooks.com/comments/business/<businessid>/service/<service_id>/rate : Update a Service Rate
GET https://api.freshbooks.com/comments/business/<businessid>/service/<serviceid> : Get Single Service
GET https://api.freshbooks.com/comments/business/<businessid>/service/<serviceid>/rate : Get Single Service Rate
GET https://api.freshbooks.com/comments/business/<businessid>/services : List Services

Events

GET https://api.freshbooks.com/events/account/<account_id>/events/callbacks : List all webhook callbacks
PUT https://api.freshbooks.com/events/account/<account_id>/events/callbacks/<callback_id> : Resend verification code

Payments

POST https://api.freshbooks.com/payments/account/<account_id>/invoice/<invoice_id>/payment_options : Add payment gateway to the invoice
GET https://api.freshbooks.com/payments/account/<account_id>/payment_options : Check Online Payment Gateways Available
GET https://api.freshbooks.com/payments/account/<accountid>/invoice/<invoiceid>/payment_options : See Payment Options on an Invoice
GET https://api.freshbooks.com/payments/account/<accountid>/payment_options?entity_type=invoice : Get the Default Invoice Payment Options

Projects

POST https://api.freshbooks.com/projects/business/<business_id>/project : Create a Single Project
DELETE https://api.freshbooks.com/projects/business/<business_id>/project/<project_id> : Delete a Single Project
GET https://api.freshbooks.com/projects/business/<business_id>/projects : List Projects
GET https://api.freshbooks.com/projects/business/<businessid>/projects : Example Sort (project endpoint)

Test

GET https://api.freshbooks.com/test : Test Call

Time Tracking

GET https://api.freshbooks.com/timetracking/business/<business_id>/time_entries : List Time Entries Update From A Particular Time
PUT https://api.freshbooks.com/timetracking/business/<business_id>/time_entries/<time_entry_id> : Update a Time Entry
GET https://api.freshbooks.com/timetracking/business/<business_id>/time_entries/{time_entrie_id} : Get A Single Time Entry
GET https://api.freshbooks.com/timetracking/business/<businessid> : Example Searches for Timetracking Endpoint

Uploads

POST https://api.freshbooks.com/uploads/account/<accountId>/attachments : Upload Attachment
POST https://api.freshbooks.com/uploads/account/<account_id>/attachments : Upload Invoice Attachment
POST https://api.freshbooks.com/uploads/account/<account_id>/images : Upload Logo / Banner

‍

Freshbooks API FAQs

How do I authenticate with the FreshBooks API?

Answer: The FreshBooks API uses OAuth 2.0 for authentication. To authenticate:some text
1. Create an OAuth application in your FreshBooks account to obtain a Client ID and Client Secret.
2. Direct users to authorize your application, which provides an authorization code.
3. Exchange the authorization code for an access token.
4. Use the access token in the Authorization header of your API requests.
Source: FreshBooks API Introduction

What are the rate limits for the FreshBooks API?

Answer: FreshBooks enforces rate limits to ensure fair usage and maintain system performance. While specific rate limits are not publicly detailed, it's recommended to implement error handling for potential rate limiting responses and to contact FreshBooks support for detailed rate limit information.
Source: FreshBooks API Introduction

Can I retrieve client information using the FreshBooks API?

Answer: Yes, the FreshBooks API provides endpoints to manage clients. For example, you can use the /accounting/account/<accountId>/users/clients endpoint to list all clients associated with your account.
Source: Client API | FreshBooks

Does the FreshBooks API support webhooks for real-time data updates?

Answer: Yes, FreshBooks supports webhooks, allowing you to receive real-time notifications for specific events, such as when an invoice is created or updated. You can configure webhook subscriptions to specify which events you want to receive notifications for.
Source: Webhook Callbacks - FreshBooks API

Are there official SDKs or client libraries for the FreshBooks API?

Answer: Yes, FreshBooks provides official SDKs to facilitate integration:some text
- Node.js SDK: An officially maintained wrapper for Node.js developers.
Source: Getting Started with FreshBooks NodeJS SDK

Get Started with Frehbooks API Integration

Create a FreshBooks Account: Sign up for a FreshBooks account if you don’t already have one.

Register Your Application: Access the FreshBooks Developer Hub to create a new application and get your Client ID and Client Secret.

Authenticate Using OAuth 2.0: Implement the OAuth 2.0 flow to obtain an access token, enabling API interactions on behalf of users.

Utilize SDKs and Libraries: Leverage the available SDKs for easier integration.

Explore API Endpoints: Familiarize yourself with the API endpoints to create clients, send invoices, and track expenses.

‍

Additional Resources:

Postman Collection: FreshBooks Postman Workspace for testing and understanding API endpoints.
API Libraries and SDKs: Official and community-supported libraries are available on the FreshBooks API Libraries page.
Developer Community: Join the FreshBooks Developer Community for support and updates.

About Knit

Knit API offers a convenient solution for quick and seamless integration with Freshbooks API. Our AI-powered integration platform allows you to build any Freshbooks API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Freshbooks API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

Factorial API Directory

Factorial HR is a robust cloud-based human resources management software designed to streamline and automate a wide array of HR processes for businesses. Tailored to meet the needs of companies of all sizes, from small startups to large enterprises, Factorial HR offers a user-friendly platform that simplifies the complexities of human resources management. By centralizing employee information and automating routine tasks, it empowers HR professionals to focus on strategic initiatives that drive organizational growth.

At its core, Factorial HR excels in employee management by consolidating employee data, tracking attendance, and monitoring work hours. It also automates payroll processes, ensuring accurate and timely salary payments while managing deductions. The software facilitates seamless time-off and leave management, performance evaluations, recruitment, and onboarding. Additionally, Factorial HR aids businesses in maintaining compliance with labor laws through comprehensive reporting and documentation capabilities. With its extensive features, Factorial HR is an indispensable tool for businesses seeking to enhance their HR operations and employee experience.

Key highlights of Factorial HR APIs

Core Functionalities:

Employee Management: Access and manage detailed information about employees, including personal details, employment history, and contact information.
Time Off Management: Retrieve and handle data related to employee leave requests, balances, and histories.
Document Management: Create, retrieve, and manage documents associated with employees and the organization.
Job Catalog: Manage job titles, roles, and levels within the organization.

Integration Use Cases:

Onboarding Automation: Streamline the onboarding process by integrating employee data into internal systems.
Payroll Synchronization: Ensure consistency between HR records and payroll systems by syncing employee and compensation data.
Custom Reporting: Generate tailored reports by extracting and analyzing HR data to meet specific business needs.

Supported Protocols:

RESTful API: The Factorial HR API follows REST principles, facilitating straightforward HTTP requests and responses.

Authentication Mechanisms:

API Keys: Suitable for internal company developments, API keys provide a straightforward method to start making requests to the public API.
OAuth 2.0: Required for marketplace integrations, OAuth 2.0 allows making requests on behalf of a user or a company, providing a secure channel for token exchange.

Rate Limiting Policies:

Usage Limits: While specific rate limits are not publicly detailed, it's advisable to implement efficient API call practices and handle potential rate limit responses gracefully.

For comprehensive information and to get started with the Factorial HR API, refer to their official API documentation.

Factorial HR API Endpoints

Attendance

POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/break_configurations : Create Break Configuration
PUT https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/break_configurations/{id} : Update Break Configuration
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/estimated_times : Get Estimated Attendance Times for Employees
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/open_shifts : Retrieve Current Open Shifts for Specified Employees
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/overtime_requests : Get Overtime Requests
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/overtime_requests/approve : Approve Overtime Request
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/overtime_requests/reject : Reject Overtime Request
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/overtime_requests/{id} : Get Overtime Request Details
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts : Get All Shifts
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/autofill : Autofill Employee Shifts
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/break_end : End Break in Open Shift
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/break_start : Start Break in Open Shift
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/clock_in : Clock In a Shift
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/clock_out : Clock Out Shift
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/toggle_clock : Toggle Shift Clock In/Out
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/shifts/{id} : Get Shift Details
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/attendance/worked_times : Get Worked Times

Companies

GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/companies/legal_entities : Get Legal Entities
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/companies/legal_entities/{id} : Get Legal Entity Details

Documents

POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/documents : Create Document
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/documents/move_to_trash_bin : Move Documents to Trash Bin
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/documents/restore_from_trash_bin : Restore Documents from Trash Bin
PUT https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/documents/{id} : Update Document
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/download_urls/bulk_create : Generate Temporal URLs for Document Downloads
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/folders : Get All Document Folders
PUT https://api.factorialhr.com/apis/{api_id}-10-01/resources/documents/folders/{id} : Update Folder

Employee Updates

GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/absences : Retrieve Absence Employee Updates
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/contract_changes : Retrieve Employee Contract Change Updates
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/contract_changes/{id} : Retrieve Employee Contract Change Details
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/summaries : Retrieve Employee Updates Summaries
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/summaries/{id} : Retrieve Employee Updates Summary
GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employee_updates/terminations : Retrieve Termination Employee Updates

Employees

GET https://api.factorialhr.com/apis/{api_id}-10-01/resources/employees/employees : Get Employee Information

Time Off

POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/timeoff/leaves : Create a Leave
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/timeoff/leaves/approve : Approve Employee Time-off Requests
POST https://api.factorialhr.com/apis/{api_id}-10-01/resources/timeoff/leaves/reject : Reject Employee Time-off Requests
PUT https://api.factorialhr.com/apis/{api_id}-10-01/resources/timeoff/leaves/{id} : Update Leave Details

Factorial API FAQs

How can I obtain an API key for the Factorial API?

Answer: Administrators can generate an API key by navigating to the Factorial platform's left sidebar, clicking on "Configuration," selecting the "API" option, and then creating a new API key.
FactorialHR API Documentation

Can I customize the permissions of the API key in Factorial?

Answer: No, the API key provides access to all information within the platform and cannot be customized. For more granular access control, consider using OAuth 2.0 to access specific data.
FactorialHR API Documentation

Does the API key expire?

Answer: No, the API key does not expire.
FactorialHR API Documentation

What are the rate limits for the Factorial API?

Answer: The Factorial API enforces rate limits to ensure fair usage:some text
- POST requests on /api/v2 endpoints: Limited to 200 requests per minute.
- POST requests on /api/v1 endpoints: Limited to 100 requests per minute.
  FactorialHR API Documentation

How can I access employee job titles using the Factorial API?

Answer: Employee job titles are available through the "Contract versions" endpoint. Since each employee can have multiple contract versions, it's essential to retrieve the latest contract version to obtain the current job title.
FactorialHR API Documentation

Get Started with Factorial API Integration

Knit API offers a convenient solution for quick and seamless integration with Factorial API. Our AI-powered integration platform allows you to build any Factorial API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to Factorial API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

CharlieHR API Directory

CharlieHR is a comprehensive human resources software solution tailored specifically for small businesses, aiming to streamline and automate HR tasks with ease. Designed with user-friendliness in mind, CharlieHR offers a suite of features that simplify the management of HR activities such as onboarding new hires, managing time off, performance management, and conducting engagement surveys. The platform also handles perks and benefits, making it a versatile tool for both managers and employees to navigate their HR responsibilities efficiently.

With a focus on small businesses, CharlieHR provides essential tools for tracking time off and sick leave, as well as monitoring employee work schedules. Its secure data storage and intuitive interface allow users to view, action, and report on various HR aspects effortlessly. Trusted by over 7000 companies, CharlieHR is renowned for its ability to empower teams to manage their own HR activities, reducing the need for a large HR department and enabling businesses to build high-performing teams. For those looking to integrate CharlieHR into their existing systems, the CharlieHR API offers seamless integration capabilities, enhancing the software's functionality and adaptability.

‍

Key highlights of CharlieHR APIs

Core Functionalities:

Employee Management: Access and manage detailed information about team members, including personal details, employment history, and contact information.
Time Off Management: Retrieve and handle data related to employee leave requests, balances, and histories.
Company and Department Data: Obtain information about the organization, its departments, and office locations.

Integration Use Cases:

Onboarding Automation: Streamline the onboarding process by integrating employee data into internal systems.
Payroll Synchronization: Ensure consistency between HR records and payroll systems by syncing employee and compensation data.
Custom Reporting: Generate tailored reports by extracting and analyzing HR data to meet specific business needs.

Supported Protocols:

RESTful API: The CharlieHR API follows REST principles, facilitating straightforward HTTP requests and responses.

Authentication Mechanisms:

API Key Authentication: Secure access is granted through API keys, which can be generated within the CharlieHR platform. CharlieHR Help Center

Rate Limiting Policies:

Usage Limits: While specific rate limits are not publicly detailed, it's advisable to implement efficient API call practices and handle potential rate limit responses gracefully.

‍

CharlieHR API Endpoints

Bank Accounts

GET https://charliehr.com/api/v1/bank_accounts : Get Bank Account Information for Team Members
GET https://charliehr.com/api/v1/bank_accounts/:team_member_id : Retrieve Bank Account Details

Company

GET https://charliehr.com/api/v1/company : Company Show
GET https://charliehr.com/api/v1/offices : List Company Offices
GET https://charliehr.com/api/v1/offices/:id : Show Office Details
GET https://charliehr.com/api/v1/teams : List All Teams for Authenticated Company
GET https://charliehr.com/api/v1/teams/:id : Get Team Details

Leave Management

GET https://charliehr.com/api/v1/leave_allowances : Leave Allowances Index
GET https://charliehr.com/api/v1/leave_requests : Leave Requests Index
GET https://charliehr.com/api/v1/leave_requests/:id : Leave Requests Show
GET https://charliehr.com/api/v1/team_members/:id/leave_allowance : Team Members Leave Allowance
GET https://charliehr.com/api/v1/team_members/:id/leave_requests : Team Members Leave Requests

Salaries

GET https://charliehr.com/api/v1/salaries : Get Salary Details

Team Members

GET https://charliehr.com/api/v1/team_members : Get Team Members
GET https://charliehr.com/api/v1/team_members/:id : Get Team Member Details
GET https://charliehr.com/api/v1/team_members/:id/notes : Get Team Member Notes

Notes

GET https://charliehr.com/api/v1/team_member_note_types : Team Member Note Types Index‍
GET https://charliehr.com/api/v1/team_member_note_types/:id : Show Team Member Note Type

CharlieHR API FAQs

How do I generate API keys in CharlieHR?

Answer: To generate API keys in CharlieHR:some text
1. Log in to your CharlieHR account as an Admin or Super Admin.
2. Expand the Company section from the side navigation.
3. Click on Integrations.
4. Navigate to the API Access tab.
5. Follow the instructions to generate the keys in the Your API Keys section.
6. You will be provided with a Client ID and a Client Secret. Copy these credentials and store them securely, as they will only be displayed once.
Source: Integrate CharlieHR with selected Apps

What authentication method does the CharlieHR API use?

Answer: The CharlieHR API uses OAuth 2.0 for authentication. After generating your Client ID and Client Secret, you can obtain an access token by following the OAuth 2.0 flow. This token must be included in the Authorization header of your API requests.
Source: Integrate CharlieHR with selected Apps

Are there rate limits for the CharlieHR API?

Answer: The official documentation does not specify explicit rate limits for the CharlieHR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
Source: CharlieHR API - Developer docs, APIs, SDKs, and auth.

Can I retrieve employee data using the CharlieHR API?

Answer: Yes, you can retrieve employee data using the CharlieHR API. For example, to list all team members, you can make a GET request to the /team_members endpoint.
Source: API Documentation - CharlieHR

Does the CharlieHR API support webhooks for real-time data updates?

Answer: As of the latest available information, the CharlieHR API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
Source: CharlieHR API - Developer docs, APIs, SDKs, and auth.

‍

Get Started with CharlieHR API Integration

Knit API offers a convenient solution for quick and seamless integration with CharlieHR API. Our AI-powered integration platform allows you to build any CharlieHR API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, CRM, HRIS, Accounting, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to CharlieHR API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Freshsales API Directory

Freshworks is a leading provider of AI-powered software solutions, dedicated to enhancing business operations across customer service, IT service management (ITSM), enterprise service management (ESM), and sales and marketing. By focusing on improving customer engagement and streamlining sales processes, Freshworks offers a suite of tools designed to automate marketing efforts and optimize IT service delivery. Their solutions are versatile, catering to businesses of all sizes and industries, making them a popular choice for organizations seeking to improve efficiency and customer satisfaction.

One of the standout offerings from Freshworks is Freshsales, a comprehensive sales CRM that empowers businesses to manage their sales processes effectively. With features like lead scoring, email tracking, and workflow automation, Freshsales helps sales teams close deals faster and more efficiently. The Freshsales API plays a crucial role in this ecosystem by allowing seamless integration with other tools and platforms, enabling businesses to customize and extend their CRM capabilities to suit their unique needs. This API integration process is vital for businesses looking to leverage Freshsales to its fullest potential.

Key highlights of Freshsales APIs

Authentication: Utilizes API keys for secure authentication, ensuring that only authorized applications can access user data.

Data Formats: Communicates using JSON, making it compatible with a wide range of programming languages and platforms.

Comprehensive Documentation: Provides detailed guides and references to assist developers in effectively utilizing the API.

SDKs and Libraries: Offers official SDKs and community-supported libraries to streamline the development process.

Freshsales API Endpoints

Appointments

POST https://domain.myfreshworks.com/crm/sales/api/appointments : Create an Appointment
GET https://domain.myfreshworks.com/crm/sales/api/appointments/:appointment_id : View an Appointment
DELETE https://domain.myfreshworks.com/crm/sales/api/appointments/[:appointment_id] : Delete an Appointment

Contacts

POST https://domain.myfreshworks.com/crm/sales/api/contacts : Create a Contact
DELETE https://domain.myfreshworks.com/crm/sales/api/contacts/[id] : Delete a Contact
GET https://domain.myfreshworks.com/crm/sales/api/contacts/[id]/activities.json : List all Activities
POST https://domain.myfreshworks.com/crm/sales/api/contacts/[id]/clone : Clone a Contact
DELETE https://domain.myfreshworks.com/crm/sales/api/contacts/[id]/forget : Forget a Contact
POST https://domain.myfreshworks.com/crm/sales/api/contacts/bulk_assign_owner : Bulk Assign Owner to Contacts
POST https://domain.myfreshworks.com/crm/sales/api/contacts/bulk_destroy : Bulk Delete Contacts
POST https://domain.myfreshworks.com/crm/sales/api/contacts/bulk_upsert : Bulk Upsert Contact
GET https://domain.myfreshworks.com/crm/sales/api/contacts/lists/[id] : Fetch All Contacts from the List
POST https://domain.myfreshworks.com/crm/sales/api/contacts/upsert : Upsert a Contact
GET https://domain.myfreshworks.com/crm/sales/api/contacts/view/[view_id] : List All Contacts
GET https://domain.myfreshworks.com/crm/sales/api/contacts/{id}/document_associations : List all Files and Links

CPQ Documents

POST https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents : Create a Document
PUT https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id] : Update a Document
DELETE https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id]/forget : Forget a Document
GET https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id]/related_products : Get Related Products
PUT https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id]/restore : Restore a Document
PUT https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/[id]?include=products : Edit Products of the Document
POST https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/cpq_documents_bulk_assign : Bulk-assign Owner to Documents
POST https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/cpq_documents_bulk_delete : Bulk-delete Documents
POST https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/cpq_documents_bulk_restore : Bulk-restore Documents
PUT https://domain.myfreshworks.com/crm/sales/api/cpq/cpq_documents/cpq_documents_bulk_update : Bulk-update Documents

Products

POST https://domain.myfreshworks.com/crm/sales/api/cpq/products : Create a Product
DELETE https://domain.myfreshworks.com/crm/sales/api/cpq/products/[id] : Delete a Product
PUT https://domain.myfreshworks.com/crm/sales/api/cpq/products/[id]/restore : Restore a Product
PUT https://domain.myfreshworks.com/crm/sales/api/cpq/products/[id]?include=product_pricings : Delete Prices of the Product
POST https://domain.myfreshworks.com/crm/sales/api/cpq/products/products_bulk_assign : Bulk-assign Owner to Products
POST https://domain.myfreshworks.com/crm/sales/api/cpq/products/products_bulk_delete : Bulk-delete Products
POST https://domain.myfreshworks.com/crm/sales/api/cpq/products/products_bulk_restore : Bulk-restore Products
PUT https://domain.myfreshworks.com/crm/sales/api/cpq/products/products_bulk_update : Bulk-update Products

Custom Module

POST https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name] : Create a Record in Custom Module
DELETE https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name]/[id] : Delete a Record in Custom Module
POST https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name]/[id]/clone : Clone a Custom Module Record
DELETE https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name]/[id]/forget : Forget a Record in Custom Module
POST https://domain.myfreshworks.com/crm/sales/api/custom_module/[entity_name]/bulk_destroy : Bulk-delete Records in Custom Module
GET https://domain.myfreshworks.com/crm/sales/api/custom_module/[module_name]/view/[view_id] : Fetch Records from a Specific View in a Custom Module

Deals

POST https://domain.myfreshworks.com/crm/sales/api/deals : Create a Deal
PUT https://domain.myfreshworks.com/crm/sales/api/deals/[id] : Update a Deal
POST https://domain.myfreshworks.com/crm/sales/api/deals/[id]/clone : Clone a Deal
DELETE https://domain.myfreshworks.com/crm/sales/api/deals/[id]/forget : Forget a Deal
PUT https://domain.myfreshworks.com/crm/sales/api/deals/[id]?include=products : Add Products to the Deal
POST https://domain.myfreshworks.com/crm/sales/api/deals/bulk_destroy : Bulk Delete Deals
POST https://domain.myfreshworks.com/crm/sales/api/deals/bulk_upsert : Bulk Upsert Deal
POST https://domain.myfreshworks.com/crm/sales/api/deals/upsert : Upsert a Deal
GET https://domain.myfreshworks.com/crm/sales/api/deals/view/[view_id] : List All Deals

Documents and Links

POST https://domain.myfreshworks.com/crm/sales/api/document_links : Create a Link
POST https://domain.myfreshworks.com/crm/sales/api/documents : Create a File

Job Status

GET https://domain.myfreshworks.com/crm/sales/api/job_statuses/[id] : Job Status Tracking API

Marketing Lists

GET https://domain.myfreshworks.com/crm/sales/api/lists : Fetch All Marketing Lists
PUT https://domain.myfreshworks.com/crm/sales/api/lists/[id] : Update a Marketing List
PUT https://domain.myfreshworks.com/crm/sales/api/lists/[list_id]/add_contacts : Copy Contacts to List
PUT https://domain.myfreshworks.com/crm/sales/api/lists/[list_id]/move_contacts : Move Contacts from List
PUT https://domain.myfreshworks.com/crm/sales/api/lists/[list_id]/remove_contacts : Remove Contacts From List

Lookup

GET https://domain.myfreshworks.com/crm/sales/api/lookup : Lookup Search API

Notes

POST https://domain.myfreshworks.com/crm/sales/api/notes : Create a Note
DELETE https://domain.myfreshworks.com/crm/sales/api/notes/[id] : Delete a Note

Phone Calls

POST https://domain.myfreshworks.com/crm/sales/api/phone_calls : Create a Manual Call Log

Sales Accounts

POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts : Create an Account
GET https://domain.myfreshworks.com/crm/sales/api/sales_accounts/[id] : View an Account
POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts/[id]/clone : Clone an Account
DELETE https://domain.myfreshworks.com/crm/sales/api/sales_accounts/[id]/forget : Forget an Account
POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts/bulk_destroy : Bulk Delete Accounts
POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts/bulk_upsert : Bulk Upsert Account
POST https://domain.myfreshworks.com/crm/sales/api/sales_accounts/upsert : Upsert an Account
GET https://domain.myfreshworks.com/crm/sales/api/sales_accounts/view/[view_id] : List All Accounts

Sales Activities

GET https://domain.myfreshworks.com/crm/sales/api/sales_activities : List All Sales Activities
GET https://domain.myfreshworks.com/crm/sales/api/sales_activities/[:sales_activity_id] : View a Sales Activity

Settings

GET https://domain.myfreshworks.com/crm/sales/api/settings/:entity_type/forms : Get a list of all fields in a custom module
GET https://domain.myfreshworks.com/crm/sales/api/settings/contacts/fields : List All Contact Fields
GET https://domain.myfreshworks.com/crm/sales/api/settings/deals/fields : List All Deal Fields
POST https://domain.myfreshworks.com/crm/sales/api/settings/module_customizations : Create Custom Modules
GET https://domain.myfreshworks.com/crm/sales/api/settings/module_customizations/[id] : Get a list of custom modules
GET https://domain.myfreshworks.com/crm/sales/api/settings/sales_accounts/fields : List All Account Fields
GET https://domain.myfreshworks.com/crm/sales/api/settings/sales_activities/fields : List All Sales Activity Fields

Tasks

GET https://domain.myfreshworks.com/crm/sales/api/tasks : List All Tasks
DELETE https://domain.myfreshworks.com/crm/sales/api/tasks/[:task_id] : Delete Task
GET https://domain.myfreshworks.com/crm/sales/api/tasks/[id] : View Task Details

‍

Freshsales API FAQs

How do I obtain an API key in Freshsales?

Answer: To obtain your API key in Freshsales:some text
1. Log in to your Freshsales account.
2. Click on your profile picture in the top-right corner and select Profile Settings.
3. Navigate to the API Settings tab.
4. Your API key will be displayed under Your API key.
Source: Freshsales API Documentation

What authentication method does the Freshsales API use?

Answer: The Freshsales API uses token-based authentication. Include your API key in the Authorization header of your HTTP requests, formatted as Token token=YOUR_API_KEY.
Source: Freshsales API Documentation

Are there rate limits for the Freshsales API?

Answer: Yes, Freshsales enforces rate limits to ensure fair usage. The default limit is 1000 API requests per hour. Exceeding this limit will result in a 429 Too Many Requests response.
Source: Freshsales API Rate Limits

Can I retrieve contact data using the Freshsales API?

Answer: Yes, you can retrieve contact data by making a GET request to the /api/contacts endpoint. This will return a list of contacts and their details.
Source: Freshsales API Documentation

Does the Freshsales API support webhooks?

Answer: As of the latest available information, Freshsales does not natively support webhooks. However, you can use the API to poll for changes or integrate with third-party services that provide webhook functionality to achieve similar outcomes.
Source: Freshsales API Documentation

Get Started with Freshsales API Integration

Generate an API Key: Log in to your Freshsales account, navigate to your profile settings, and locate the API settings to generate your unique API key.

Configure API Requests: Use the API key in the authorization header of your HTTP requests to authenticate.

Explore API Endpoints: Familiarize yourself with various API endpoints to perform operations such as creating contacts, managing deals, and retrieving account information.

‍

Additional Resources:

Postman Collection: Freshsales offers a Postman collection to facilitate testing and understanding of API endpoints. Postman
Developer Community: Engage with the Freshsales developer community for support, insights, and updates related to the API. Freshworks Developers

‍

About Knit

For quick and seamless integration with Freshsales API, Knit API offers a convenient solution. Our AI powered integration platform allows you to build any Freshsales API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Freshsales API.

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Deel API Directory

Deel is a cutting-edge software platform designed to streamline payroll, HR management, and Employer of Record (EOR) solutions for businesses looking to expand their global workforce. By enabling companies to hire and pay employees in over 150 countries, Deel addresses the complexities of international compliance, taxes, and local labor laws. This makes it an invaluable tool for organizations aiming to manage their global workforce efficiently and effectively.

One of the standout features of Deel is its robust API integration capabilities, which allow businesses to seamlessly connect Deel's functionalities with their existing systems. The Deel API facilitates smooth data exchange and process automation, enhancing the overall efficiency of global HR operations. As companies increasingly seek to leverage technology for workforce management, understanding the Deel API integration process becomes crucial for optimizing their international hiring strategies.

Key highlights of Deel APIs

Comprehensive Resource Management: The API provides access to various resources, including Contracts, Tasks, Timesheets, Milestones, Off-cycle Payments, Invoice Adjustments, Organizations, Legal Entities, Lookups, and Groups. Deel
Authentication: Utilizes token-based authentication, supporting both personal and organization tokens. Personal tokens are linked to individual users and inherit their permissions, while organization tokens are associated with service users, offering broader access without expiration. Deel
Sandbox Environment: Deel provides a sandbox environment with sample data, enabling developers to test API integrations thoroughly before deploying them in a production setting.

Deel API Endpoints

Adjustments

POST https://api.letsdeel.com/rest/v2/adjustments : This API endpoint allows the creation of a new adjustment.
GET https://api.letsdeel.com/rest/v2/adjustments/categories : This API endpoint retrieves all adjustment categories for your organization.
DELETE https://api.letsdeel.com/rest/v2/adjustments/{adjustment_id} : The Delete Adjustment API allows users to delete an existing adjustment by specifying the adjustment_id in the path parameters.

Candidates

POST https://api.letsdeel.com/rest/v2/candidates : This API endpoint allows you to add a candidate to Deel.
PATCH https://api.letsdeel.com/rest/v2/candidates/{candidate_id} : The Update Candidate API allows you to update the details of an existing candidate using their candidate ID.

Contract Templates

GET https://api.letsdeel.com/rest/v2/contract-templates : This API endpoint retrieves a list of contract templates available in your organization.

Contracts

GET https://api.letsdeel.com/rest/v2/contracts : This API endpoint retrieves a list of contracts from the Deel platform.
GET https://api.letsdeel.com/rest/v2/contracts/custom_fields : This API endpoint fetches all custom fields associated with contracts, providing additional data necessary for contract management.
GET https://api.letsdeel.com/rest/v2/contracts/custom_fields/{field_id} : This API endpoint allows users to access details of a specific custom field associated with a contract.
POST https://api.letsdeel.com/rest/v2/contracts/gp : This API endpoint allows the creation of a Global Payroll contract.
PATCH https://api.letsdeel.com/rest/v2/contracts/{contract_id} : This API endpoint allows you to add an external ID to a Deel contract.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/adjustments : This API endpoint retrieves all adjustments for a specific contract identified by the 'contract_id' path parameter.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/amendments : This API endpoint allows you to amend the details of a contract.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/custom_fields : This API endpoint retrieves all custom field values for a specific contract, allowing for enhanced contract management with detailed, custom-configured data.
DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/custom_fields/{field_id} : This API endpoint allows the deletion of a specific custom field's value from a contract.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/documents : This API endpoint allows users to attach a file to a contract document in the Deel system.
DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/invitations : The Remove Contract Invitation API allows you to delete an invitation for a worker to sign a contract.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/invoice-adjustments : This API endpoint retrieves invoice line items for a specified contract ID.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones : This API endpoint allows you to add a new milestone to a specified contract in the Deel system.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones/many/reviews : This API endpoint allows users to review a batch of milestones by approving or rejecting submitted work.
DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones/{milestone_id} : This API endpoint allows the user to delete a specific milestone from a contract using the DELETE method.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/milestones/{milestone_id}/reviews : This API endpoint allows users to review a milestone by approving or declining the submitted work.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/off-cycle-payments : This API endpoint retrieves a list of off-cycle payments for a specified contract ID.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/off-cycle-payments/{offcycle_payment_id} : This API endpoint retrieves a single off-cycle payment for a specified contract.
DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/premium : This API endpoint is used to remove Deel Premium from an existing contract.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/preview : This API endpoint retrieves the content of an IC and EOR contract agreement in HTML format.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/signatures : This API endpoint allows a client to sign a contract on the Deel platform.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks : This API endpoint retrieves a list of tasks associated with a specific contract identified by the 'contract_id' path parameter.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks/many/reviews : This API endpoint allows users to review multiple tasks associated with a specific contract by either approving or declining the submitted work.
DELETE https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks/{task_id} : This API endpoint allows the user to delete a specific task from a contract in the Deel system.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/tasks/{task_id}/reviews : This API endpoint allows users to review a single task to either approve or decline the submitted work.
POST https://api.letsdeel.com/rest/v2/contracts/{contract_id}/terminations : This API endpoint is used to terminate an active contract on the Deel platform.
GET https://api.letsdeel.com/rest/v2/contracts/{contract_id}/timesheets : This API endpoint retrieves a list of timesheets associated with a specific contract.

Departments

GET https://api.letsdeel.com/rest/v2/departments : This API endpoint retrieves a list of departments within an organization.

EOR

POST https://api.letsdeel.com/rest/v2/eor : This API endpoint is used to create an Employee of Record (EOR) contract quote.
POST https://api.letsdeel.com/rest/v2/eor/employment_cost : This API endpoint is used to determine the Employer of Record (EOR) employee costs across the globe.
GET https://api.letsdeel.com/rest/v2/eor/validations/{country_code} : The 'Retrieve Hiring Guide Data for a Country' API endpoint allows users to obtain detailed hiring guide data for a specified country.
GET https://api.letsdeel.com/rest/v2/eor/workers/{worker_id}/payslips/{payslip_id}/download : This API endpoint allows users to retrieve the download URL for an EOR (Employer of Record) payslip.
GET https://api.letsdeel.com/rest/v2/eor/{contract_id}/benefits : This API endpoint retrieves the benefits associated with a specific EOR (Employer of Record) contract.

Global Payroll

GET https://api.letsdeel.com/rest/v2/gp/legal-entities/{legal_entity_id}/reports : This API endpoint retrieves a list of global payroll events associated with a specific legal entity.
GET https://api.letsdeel.com/rest/v2/gp/reports/{gp_report_id}/gross_to_net : This API endpoint retrieves a list of global payroll reports detailing gross-to-net calculations for a specified report ID.
GET https://api.letsdeel.com/rest/v2/gp/reports/{gp_report_id}/gross_to_net/csv : This API endpoint allows users to download global payroll reports detailing gross-to-net calculations in CSV format.
PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/address : This API endpoint allows updating the address of a Global Payroll employee.
GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/banks : This API endpoint retrieves all bank accounts associated with a specific employee identified by the 'worker_id' path parameter.
GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/banks/guide : This API endpoint retrieves the bank form guide for a specific employee identified by the worker_id.
PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/banks/{bank_id} : This API endpoint allows modification of a bank account for an employee.
PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/compensation : This API endpoint allows updating the compensation of a Global Payroll employee.
PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/employee-information : This API endpoint allows updating the Global Payroll employee information for a specific worker identified by the 'worker_id' path parameter.
GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/payslips : This API endpoint retrieves the payslips for a specific employee identified by the worker_id.
GET https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/payslips/{payslip_id}/download : This API endpoint allows you to get the download URL for a GP payslip.
PATCH https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/pto-policy : This API endpoint allows updating the PTO (Paid Time Off) policy of a Global Payroll employee.
POST https://api.letsdeel.com/rest/v2/gp/workers/{worker_id}/terminations : This API endpoint is used to request a termination for a global payroll employee.

Invoice Adjustments

POST https://api.letsdeel.com/rest/v2/invoice-adjustments : This API endpoint allows you to create an invoice adjustment on Deel.
POST https://api.letsdeel.com/rest/v2/invoice-adjustments/many/reviews : This API endpoint allows users to review multiple invoice adjustments by approving or declining a batch.
DELETE https://api.letsdeel.com/rest/v2/invoice-adjustments/{invoice_adjustment_id} : The Delete Invoice Adjustment API allows users to delete an existing invoice adjustment by specifying the invoice_adjustment_id in the path parameters.
POST https://api.letsdeel.com/rest/v2/invoice-adjustments/{invoice_adjustment_id}/reviews : This API endpoint allows users to review an invoice adjustment by either approving or declining it.

Invoices

GET https://api.letsdeel.com/rest/v2/invoices : This API endpoint retrieves a list of paid invoices for your workforce.
GET https://api.letsdeel.com/rest/v2/invoices/deel : This API endpoint retrieves a list of invoices related to Deel fees.

Legal Entities

GET https://api.letsdeel.com/rest/v2/legal-entities : This API endpoint retrieves a list of legal entities associated with your account.

Lookups

GET https://api.letsdeel.com/rest/v2/lookups/countries : This API endpoint retrieves a list of countries supported by Deel.
GET https://api.letsdeel.com/rest/v2/lookups/currencies : This API endpoint retrieves the list of currencies used by Deel.
GET https://api.letsdeel.com/rest/v2/lookups/job-titles : This API endpoint retrieves a list of pre-defined job titles available on the Deel platform.
GET https://api.letsdeel.com/rest/v2/lookups/seniorities : This API endpoint retrieves a list of pre-defined seniority levels for roles in the Deel platform.
GET https://api.letsdeel.com/rest/v2/lookups/time-off-types : This API endpoint retrieves a list of pre-defined time off types available on the Deel platform.

Managers

GET https://api.letsdeel.com/rest/v2/managers : This API endpoint retrieves a list of all organization managers.

Organizations

GET https://api.letsdeel.com/rest/v2/organizations : This API endpoint retrieves the current organization details.

Payments

GET https://api.letsdeel.com/rest/v2/payments : The Retrieve Payments List API endpoint allows users to retrieve a list of payments made to Deel.
GET https://api.letsdeel.com/rest/v2/payments/{payment_id}/breakdown : The 'Get Payment Breakdown' API endpoint allows users to retrieve a detailed breakdown of a payment made to Deel.

People

POST https://api.letsdeel.com/rest/v2/people : This API endpoint allows you to create an employee hired under your own entity in Deel HR.
GET https://api.letsdeel.com/rest/v2/people/custom_fields : This API endpoint fetches all custom fields associated with People records, providing additional personalized information.
GET https://api.letsdeel.com/rest/v2/people/custom_fields/{field_id} : This API endpoint allows users to access details of a specific custom field by using the custom field ID.
GET https://api.letsdeel.com/rest/v2/people/{worker_id} : This API endpoint retrieves a single person in your organization using the unique worker ID.
PUT https://api.letsdeel.com/rest/v2/people/{worker_id}/custom_fields : This API endpoint allows you to add or update custom field values for a specific worker, ensuring their profile is up-to-date with the latest information.
DELETE https://api.letsdeel.com/rest/v2/people/{worker_id}/custom_fields/{field_id} : This API endpoint allows you to delete a specific custom field value from a worker's profile.
PUT https://api.letsdeel.com/rest/v2/people/{worker_id}/department : This API endpoint allows updating the department information of a worker identified by the 'worker_id' path parameter.
PATCH https://api.letsdeel.com/rest/v2/people/{worker_id}/personal : This API endpoint allows updating a worker's personal information using a PATCH request.
PUT https://api.letsdeel.com/rest/v2/people/{worker_id}/working-location : This API endpoint allows updating the working location of a worker identified by the 'worker_id' path parameter.

Teams

GET https://api.letsdeel.com/rest/v2/teams : This API endpoint retrieves a list of teams within your organization.

Timesheets

POST https://api.letsdeel.com/rest/v2/timesheets : This API endpoint allows users to submit work for a contractor by creating a timesheet.
POST https://api.letsdeel.com/rest/v2/timesheets/many/reviews : This API endpoint allows users to review a batch of timesheets to either approve or reject submitted work.
DELETE https://api.letsdeel.com/rest/v2/timesheets/{timesheet_id} : This API endpoint allows the user to delete a single timesheet entry by specifying the timesheet ID in the path parameters.
POST https://api.letsdeel.com/rest/v2/timesheets/{timesheet_id}/reviews : This API endpoint allows users to review a timesheet by approving or declining the submitted work.

Webhooks

POST https://api.letsdeel.com/rest/v2/webhooks : This API endpoint allows you to create a new webhooks subscription on the Deel platform.
GET https://api.letsdeel.com/rest/v2/webhooks/events/types : This API endpoint retrieves a list of webhook event types from the Deel platform.
DELETE https://api.letsdeel.com/rest/v2/webhooks/{id} : This API endpoint allows the user to delete a webhook subscription by specifying the webhook's unique identifier in the path parameter.

Workers

GET https://api.letsdeel.com/rest/v2/workers/{worker_id}/documents : This API endpoint retrieves a list of documents associated with a specific worker identified by the 'worker_id' path parameter.
GET https://api.letsdeel.com/rest/v2/workers/{worker_id}/documents/{document_id}/download : This API endpoint retrieves the download link for a specific worker's document in the Deel system.

Deel API FAQs‍

General Questions

1. What is the Deel API?

The Deel API allows developers to integrate Deel’s global hiring, payroll, and contract management features into their applications, automating HR and financial operations.

2. Who can use the Deel API?

The API is available for Deel customers and partners who need to integrate Deel’s features into their internal systems for automated contract management, payments, invoicing, and compliance tracking.

3. How do I get access to the Deel API?

You can access the Deel API by navigating to the Developer Center in your Deel account and generating an API token. Deel also provides a sandbox environment for testing.

4. Does Deel provide an API sandbox for testing?

Yes, Deel offers a sandbox environment that allows developers to test integrations before deploying them in a live setting. You can set up a sandbox account through the Developer Center.

Authentication & Security

5. How does authentication work in the Deel API?

Deel uses token-based authentication with two types of tokens:

Personal Tokens (linked to individual users, inheriting their permissions)
Organization Tokens (associated with service users, offering broader access)

All requests must include an Authorization: Bearer <your-token> header.

6. How do I generate an API token?

To generate an API token:

Log in to Deel and go to the Developer Center.
Click "Create API Token" and select either a personal or organization token.
Set the required scopes for API access.
Copy and securely store your token.

Endpoints & Functionalities

7. What key features does the Deel API support?

The Deel API includes endpoints for:

Contracts – Create, retrieve, and manage contracts.
Tasks – Automate task management.
Timesheets – Log and track work hours.
Milestones – Set and manage contract deliverables.
Payments – Automate salary and invoice processing.
Invoice Adjustments – Modify invoices dynamically.

8. How do I retrieve employee contract details via the API?

You can use the Contracts API endpoint:‍

GET /v1/contracts/{contract_id}
Authorization: Bearer <your-token>

This will return details about the specified contract.

9. Can I use the Deel API to process payroll?

Yes. The API enables payroll processing by integrating with Deel’s payments and invoice systems. You can schedule payments, retrieve payroll summaries, and handle tax compliance.

10. How do I manage invoices through the API?

You can use the invoice endpoints to create, retrieve, and adjust invoices:

GET /v1/invoices/{invoice_id}
Authorization: Bearer <your-token>

Integration & Compliance

11. What programming languages are supported for API integration?

The Deel API is RESTful and communicates using JSON, making it compatible with most programming languages, including Python, Node.js, Java, Ruby, and PHP.

12. Does the Deel API comply with global data security regulations?

Yes. Deel adheres to strict GDPR, SOC 2, and ISO 27001 compliance standards, ensuring secure handling of HR and payroll data.

13. What rate limits apply to the Deel API?

The Deel API enforces rate limits to prevent excessive API calls. Specific rate limits depend on the API tier and contract agreement.

14. Can I integrate Deel with other HR or accounting platforms?

Yes. Deel API can be integrated with HR systems (e.g., BambooHR, Workday), ERP software, and accounting tools (e.g., QuickBooks, Xero).

Support & Troubleshooting

15. Where can I find Deel API documentation?

You can find the official Deel API documentation at Deel API Docs.

16. How do I report API issues?

For technical support, contact Deel’s API support team at support@deel.com or submit a request through the Deel Developer Center.

17. What should I do if my API token is compromised?

If your API token is compromised:

Revoke the old token immediately from the Developer Center.
Generate a new token and update your API integrations.
Monitor for unauthorized API activity and notify Deel support if needed.

Get Started with Deel API Integration

Access the Developer Center: Log in to your Deel account, navigate to the 'More' icon, select 'Apps,' and then click on 'Developer Center' to enter the platform. Deel
Generate an Access Token:
- Choose between a personal token or an organization token based on your integration requirements.Deel
- Specify the necessary scopes for the token to control its access levels.
- Generate the token and securely store it, as it will not be visible again. Deel
Create a Sandbox Account: Within the Developer Center, initiate the creation of a sandbox account using your email and a password. Confirm the setup to access the testing environment.
Explore API Endpoints: Familiarize yourself with the available endpoints to effectively manage resources such as contracts, tasks, and payments. Detailed information on each endpoint is available in the API documentation. Deel

Additional Resources:

API Documentation: Comprehensive guides and references are available to assist developers in effectively utilizing the API. Deel
Integration Guides: For practical examples and best practices, refer to integration guides that provide insights into common API interactions.

For quick and seamless integration with Deel API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Deel API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, HRIS, Payroll and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Deel API.

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Zoho Books API Directory

Zoho Books is a robust cloud-based accounting software designed to streamline financial management for small and medium-sized businesses. As part of the comprehensive Zoho suite of business applications, Zoho Books offers a wide array of features that cater to diverse accounting needs. It empowers businesses to efficiently manage their financial operations, from invoicing and expense tracking to inventory management and tax compliance. With its user-friendly interface and powerful tools, Zoho Books simplifies complex accounting tasks, enabling businesses to focus on growth and profitability.

One of the standout features of Zoho Books is its ability to seamlessly integrate with various third-party applications through the Zoho Books API. This integration capability allows businesses to customize their accounting processes and connect Zoho Books with other essential business tools, enhancing productivity and operational efficiency. The Zoho Books API provides developers with the flexibility to automate workflows, synchronize data, and build custom solutions tailored to specific business requirements, making it an invaluable asset for businesses looking to optimize their financial management systems.

Zoho Books API Endpoints

Bank Accounts

GET https://www.zohoapis.com/books/v3/bankaccounts : List view of accounts
GET https://www.zohoapis.com/books/v3/bankaccounts/rules : Get Rules List
GET https://www.zohoapis.com/books/v3/bankaccounts/rules/{rule_id} : Get a rule
DELETE https://www.zohoapis.com/books/v3/bankaccounts/rules/{rule_id}?organization_id={organization_id} : Delete a rule
POST https://www.zohoapis.com/books/v3/bankaccounts/rules?organization_id={organization_id} : Create a rule
PUT https://www.zohoapis.com/books/v3/bankaccounts/{accountId} : Update bank account
POST https://www.zohoapis.com/books/v3/bankaccounts/{account_id}/active : Activate account
POST https://www.zohoapis.com/books/v3/bankaccounts/{account_id}/inactive : Deactivate account
GET https://www.zohoapis.com/books/v3/bankaccounts/{bank_account_id}/statement/lastimported : Get last imported statement
DELETE https://www.zohoapis.com/books/v3/bankaccounts/{bank_account_id}/statement/{statement_id}?organization_id={organization_id} : Delete last imported statement
POST https://www.zohoapis.com/books/v3/bankaccounts?organization_id={organization_id} : Create a bank account

Bank Statements

POST https://www.zohoapis.com/books/v3/bankstatements?organization_id={organization_id} : Import a Bank/Credit Card Statement

Bank Transactions

GET https://www.zohoapis.com/books/v3/banktransactions : Get transactions list
GET https://www.zohoapis.com/books/v3/banktransactions/?organization_id={organization_id} : Get transaction
POST https://www.zohoapis.com/books/v3/banktransactions/uncategorized/categorize/paymentrefunds?organization_id={organization_id} : Categorize as Customer Payment Refund
POST https://www.zohoapis.com/books/v3/banktransactions/uncategorized/categorize/vendorpaymentrefunds?organization_id={organization_id} : Categorize as Vendor Payment Refund
POST https://www.zohoapis.com/books/v3/banktransactions/uncategorized/{transaction_id}/exclude : Exclude a transaction
POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/categorize/creditnoterefunds?organization_id={organization_id} : Categorize as credit note refunds
POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/categorize/customerpayments?organization_id={organization_id} : Categorize as customer payment
POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/categorize/expenses?organization_id={organization_id} : Categorize as expense
POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/categorize/vendorcreditrefunds?organization_id={organization_id} : Categorize as vendor credit refunds
POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/categorize/vendorpayments?organization_id={organization_id} : Categorize a vendor payment
POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/categorize?organization_id={organization_id} : Categorize an uncategorized transaction
GET https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/match : Get matching transactions
POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/match?organization_id={organization_id} : Match a transaction
POST https://www.zohoapis.com/books/v3/banktransactions/uncategorizeds/{uncategorized_id}/restore : Restore a transaction
POST https://www.zohoapis.com/books/v3/banktransactions/{transaction_id}/uncategorize : Uncategorize a categorized transaction
POST https://www.zohoapis.com/books/v3/banktransactions/{transaction_id}/unmatch : Unmatch a matched transaction
POST https://www.zohoapis.com/books/v3/banktransactions?organization_id={organization_id} : Create a transaction for an account

Base Currency Adjustment

GET https://www.zohoapis.com/books/v3/basecurrencyadjustment : List base currency adjustment
GET https://www.zohoapis.com/books/v3/basecurrencyadjustment/accounts : List account details for base currency adjustment
DELETE https://www.zohoapis.com/books/v3/basecurrencyadjustment/{adjustment_id}?organization_id={organization_id} : Delete a base currency adjustment
GET https://www.zohoapis.com/books/v3/basecurrencyadjustments/{basecurrencyadjustment_id}?organization_id={organization_id} : Get a base currency adjustment

Bills

PUT https://www.zohoapis.com/books/v3/bill/{bill_id}/customfields : Update custom field in existing bills
POST https://www.zohoapis.com/books/v3/bills : Create a bill
GET https://www.zohoapis.com/books/v3/bills/editpage/frompurchaseorders : Convert PO to Bill
PUT https://www.zohoapis.com/books/v3/bills/{billId} : Update a bill
POST https://www.zohoapis.com/books/v3/bills/{bill_id}/approve : Approve a bill
GET https://www.zohoapis.com/books/v3/bills/{bill_id}/attachment : Get a bill attachment
GET https://www.zohoapis.com/books/v3/bills/{bill_id}/comments : List bill comments & history
POST https://www.zohoapis.com/books/v3/bills/{bill_id}/comments?organization_id={organization_id} : Add comment to a bill
GET https://www.zohoapis.com/books/v3/bills/{bill_id}/payments : List bill payments
POST https://www.zohoapis.com/books/v3/bills/{bill_id}/status/open : Mark a bill as open
POST https://www.zohoapis.com/books/v3/bills/{bill_id}/status/void : Void a bill
POST https://www.zohoapis.com/books/v3/bills/{bill_id}/submit : Submit a bill for approval
GET https://www.zohoapis.com/books/v3/bills/{bill_id}?organization_id={organization_id} : Get a bill
POST https://www.zohoapis.com/books/v3/bills?organization_id={organization_id} : Create a bill

Chart of Accounts

GET https://www.zohoapis.com/books/v3/chartofaccounts : List chart of accounts
GET https://www.zohoapis.com/books/v3/chartofaccounts/transactions : List of transactions for an account
DELETE https://www.zohoapis.com/books/v3/chartofaccounts/transactions/{transaction_id} : Delete a transaction
GET https://www.zohoapis.com/books/v3/chartofaccounts/{accountId} : Get an account
POST https://www.zohoapis.com/books/v3/chartofaccounts/{account_id}/active : Mark an account as active
POST https://www.zohoapis.com/books/v3/chartofaccounts/{account_id}/inactive : Mark an account as inactive
DELETE https://www.zohoapis.com/books/v3/chartofaccounts/{account_id}?organization_id={organization_id} : Delete a Bank account
POST https://www.zohoapis.com/books/v3/chartofaccounts?organization_id={organization_id} : Create an account

Custom Modules

DELETE https://www.zohoapis.com/books/v3/cm_debtor : Delete Custom Modules
DELETE https://www.zohoapis.com/books/v3/cm_debtor/{record_id}?organization_id={organization_id} : Delete individual records

Contacts

GET https://www.zohoapis.com/books/v3/contacts : List Contacts
POST https://www.zohoapis.com/books/v3/contacts/contactpersons/{contact_person_id}/primary : Mark as primary contact person
PUT https://www.zohoapis.com/books/v3/contacts/contactpersons/{contact_person_id}?organization_id={organization_id} : Update a contact person
POST https://www.zohoapis.com/books/v3/contacts/contactpersons?organization_id={organization_id} : Create a contact person
PUT https://www.zohoapis.com/books/v3/contacts/{contactId} : Update a Contact
POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/active : Mark as Active
GET https://www.zohoapis.com/books/v3/contacts/{contact_id}/address : Get Contact Addresses
DELETE https://www.zohoapis.com/books/v3/contacts/{contact_id}/address/{address_id}?organization_id={organization_id} : Delete Additional Address
POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/address?organization_id={organization_id} : Add Additional Address
GET https://www.zohoapis.com/books/v3/contacts/{contact_id}/comments : List Comments
GET https://www.zohoapis.com/books/v3/contacts/{contact_id}/contactpersons : List contact persons
GET https://www.zohoapis.com/books/v3/contacts/{contact_id}/contactpersons/{contact_person_id} : Get a contact person
POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/email?organization_id={organization_id} : Email Contact
POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/inactive : Mark as Inactive
POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/paymentreminder/disable : Disable Payment Reminders
POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/paymentreminder/enable : Enable Payment Reminders
POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/portal/enable?organization_id={organization_id} : Enable Portal Access
GET https://www.zohoapis.com/books/v3/contacts/{contact_id}/refunds : List Refunds
GET https://www.zohoapis.com/books/v3/contacts/{contact_id}/statements/email?organization_id={organization_id} : Get Statement Mail Content
POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/track1099 : Track a contact for 1099 reporting
POST https://www.zohoapis.com/books/v3/contacts/{contact_id}/untrack1099 : Untrack 1099
DELETE https://www.zohoapis.com/books/v3/contacts/{contact_id}?organization_id={organization_id} : Delete a Contact
PUT https://www.zohoapis.com/books/v3/contacts?organization_id={organization_id} : Update a contact using a custom field's unique value

Credit Notes

GET https://www.zohoapis.com/books/v3/creditnotes : List all Credit Notes
GET https://www.zohoapis.com/books/v3/creditnotes/refunds : List credit note refunds
GET https://www.zohoapis.com/books/v3/creditnotes/templates : List credit note template
POST https://www.zohoapis.com/books/v3/creditnotes/{credit_note_id}/status/open : Convert Credit Note to Open
GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id} : Get a credit note
POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/approve : Approve a credit note
GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/comments : List credit note comments & history
GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/email : Get email content of a credit note
POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/email?organization_id={organization_id} : Email a credit note
GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/emailhistory : Email history
GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/invoices : List invoices credited
DELETE https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/invoices/{invoice_id} : Delete invoices credited
POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/invoices?organization_id={organization_id} : Credit to an invoice
GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/refunds : List refunds of a credit note
GET https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/refunds/{creditnote_refund_id} : Get credit note refund
PUT https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/refunds/{refund_id}?organization_id={organization_id} : Update credit note refund
POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/refunds?organization_id={organization_id} : Refund Credit Note
POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/status/draft : Convert Credit Note to Draft
POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/status/void : Void a Credit Note
POST https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/submit?organization_id={organization_id} : Submit a credit note for approval
PUT https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}/templates/{template_id}?organization_id={organization_id} : Update a credit note template
DELETE https://www.zohoapis.com/books/v3/creditnotes/{creditnote_id}?organization_id={organization_id} : Delete a credit note
POST https://www.zohoapis.com/books/v3/creditnotes?organization_id={organization_id} : Create a credit note

CRM

POST https://www.zohoapis.com/books/v3/crm/account/import?organization_id={organization_id} : Import a customer using the CRM account ID
POST https://www.zohoapis.com/books/v3/crm/contact/import?organization_id={organization_id} : Import a customer using CRM contact ID
POST https://www.zohoapis.com/books/v3/crm/vendor/import : Import a vendor using the CRM vendor ID

Customer Payments

PUT https://www.zohoapis.com/books/v3/customerpayment/{customerpayment_id}/customfields : Update custom field in existing customerpayments
GET https://www.zohoapis.com/books/v3/customerpayments : List Customer Payments
PUT https://www.zohoapis.com/books/v3/customerpayments/{customerpayment_id}/refunds/?organization_id={organization_id} : Update a refund
POST https://www.zohoapis.com/books/v3/customerpayments/{customerpayment_id}/refunds?organization_id={organization_id} : Refund an excess customer payment
PUT https://www.zohoapis.com/books/v3/customerpayments/{paymentId} : Update a payment
GET https://www.zohoapis.com/books/v3/customerpayments/{payment_id}/refunds : List refunds of a customer payment
DELETE https://www.zohoapis.com/books/v3/customerpayments/{payment_id}/refunds/?organization_id={organization_id} : Delete a Refund
GET https://www.zohoapis.com/books/v3/customerpayments/{payment_id}?organization_id={organization_id} : Retrieve a payment
PUT https://www.zohoapis.com/books/v3/customerpayments?organization_id={organization_id} : Update a payment using a custom field's unique value

Debtor

GET https://www.zohoapis.com/books/v3/debtor : Get Record List of a Custom Module
POST https://www.zohoapis.com/books/v3/debtor?organization_id={organization_id} : Create Custom Modules
GET https://www.zohoapis.com/books/v3/debtors/{debtor_id} : Get Individual Record Details
PUT https://www.zohoapis.com/books/v3/debtors/{debtor_id}?organization_id={organization_id} : Update Custom Module

Employees

DELETE https://www.zohoapis.com/books/v3/employee/?organization_id={organization_id} : Delete an employee
GET https://www.zohoapis.com/books/v3/employees : List employees
GET https://www.zohoapis.com/books/v3/employees/?organization_id={organization_id} : Get an employee
POST https://www.zohoapis.com/books/v3/employees?organization_id={organization_id} : Create an employee

Estimates

GET https://www.zohoapis.com/books/v3/estimates : List estimates
POST https://www.zohoapis.com/books/v3/estimates/email : Email multiple estimates
GET https://www.zohoapis.com/books/v3/estimates/pdf : Bulk export estimates
GET https://www.zohoapis.com/books/v3/estimates/print : Bulk print estimates
GET https://www.zohoapis.com/books/v3/estimates/templates : List Estimate Template
GET https://www.zohoapis.com/books/v3/estimates/{estimate_id} : Get an estimate
POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/approve : Approve an estimate.
GET https://www.zohoapis.com/books/v3/estimates/{estimate_id}/comments : List estimate comments & history
POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/comments?organization_id={organization_id} : Add Comments to Estimate
PUT https://www.zohoapis.com/books/v3/estimates/{estimate_id}/customfields : Update custom field in existing estimates
GET https://www.zohoapis.com/books/v3/estimates/{estimate_id}/email : Get estimate email content
POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/email?organization_id={organization_id} : Email an estimate
POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/status/accepted : Mark an estimate as accepted
POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/status/declined : Mark an estimate as declined
POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/status/sent : Mark an estimate as sent
POST https://www.zohoapis.com/books/v3/estimates/{estimate_id}/submit : Submit an estimate for approval
PUT https://www.zohoapis.com/books/v3/estimates/{estimate_id}/templates/{template_id}?organization_id={organization_id} : Update estimate template
PUT https://www.zohoapis.com/books/v3/estimates/{estimate_id}?organization_id={organization_id} : Update an Estimate
POST https://www.zohoapis.com/books/v3/estimates?organization_id={organization_id} : Create an Estimate

Expenses

GET https://www.zohoapis.com/books/v3/expenses : List Expenses
GET https://www.zohoapis.com/books/v3/expenses/{expense_id} : Get an Expense
GET https://www.zohoapis.com/books/v3/expenses/{expense_id}/comments : List expense History & Comments
POST https://www.zohoapis.com/books/v3/expenses/{expense_id}/receipt : Add receipt to an expense
PUT https://www.zohoapis.com/books/v3/expenses/{expense_id}?organization_id={organization_id} : Update an Expense
PUT https://www.zohoapis.com/books/v3/expenses?organization_id={organization_id} : Update an expense using a custom field's unique value

Invoices

PUT https://www.zohoapis.com/books/v3/invoice/{invoice_id}/customfields : Update custom field in existing invoices
POST https://www.zohoapis.com/books/v3/invoices : Create an invoice
POST https://www.zohoapis.com/books/v3/invoices/email : Email invoices
DELETE https://www.zohoapis.com/books/v3/invoices/expenses/receipt?organization_id={organization_id} : Delete the expense receipt
POST https://www.zohoapis.com/books/v3/invoices/fromsalesorder : Create an instant invoice
POST https://www.zohoapis.com/books/v3/invoices/paymentreminder : Bulk invoice reminder
GET https://www.zohoapis.com/books/v3/invoices/pdf : Bulk export Invoices
GET https://www.zohoapis.com/books/v3/invoices/print : Bulk print invoices
GET https://www.zohoapis.com/books/v3/invoices/templates : List invoice templates
PUT https://www.zohoapis.com/books/v3/invoices/{invoiceId} : Update an invoice
PUT https://www.zohoapis.com/books/v3/invoices/{invoice_id}/address/billing?organization_id={organization_id} : Update billing address
PUT https://www.zohoapis.com/books/v3/invoices/{invoice_id}/address/shipping?organization_id={organization_id} : Update shipping address
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/approve : Approve an invoice
GET https://www.zohoapis.com/books/v3/invoices/{invoice_id}/attachment : Get an invoice attachment
DELETE https://www.zohoapis.com/books/v3/invoices/{invoice_id}/attachment?organization_id={organization_id} : Delete an attachment
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/comments : Add comment to an invoice
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/credits?organization_id={organization_id} : Apply credits
GET https://www.zohoapis.com/books/v3/invoices/{invoice_id}/creditsapplied : List credits applied
DELETE https://www.zohoapis.com/books/v3/invoices/{invoice_id}/creditsapplied/{credit_id} : Delete applied credit
GET https://www.zohoapis.com/books/v3/invoices/{invoice_id}/email : Get invoice email content
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/email?organization_id={organization_id} : Email an invoice
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/paymentreminder/disable : Disable payment reminder
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/paymentreminder/enable : Enable payment reminder
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/paymentreminder?organization_id={organization_id} : Remind Customer
GET https://www.zohoapis.com/books/v3/invoices/{invoice_id}/payments : List invoice payments
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/status/draft : Mark as draft
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/status/sent : Mark an invoice as sent
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/status/void : Void an invoice
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/submit?organization_id={organization_id} : Submit an invoice for approval
PUT https://www.zohoapis.com/books/v3/invoices/{invoice_id}/templates/{template_id}?organization_id={organization_id} : Update invoice template
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/writeoff : Write off invoice
POST https://www.zohoapis.com/books/v3/invoices/{invoice_id}/writeoff/cancel : Cancel write off
GET https://www.zohoapis.com/books/v3/invoices/{invoice_id}?organization_id={organization_id} : Get an invoice
PUT https://www.zohoapis.com/books/v3/invoices?organization_id={organization_id} : Update an invoice using a custom field's unique value

Items

PUT https://www.zohoapis.com/books/v3/item/{item_id}/customfields : Update custom field in existing items
GET https://www.zohoapis.com/books/v3/items : List items
PUT https://www.zohoapis.com/books/v3/items/{item_id}?organization_id={organization_id} : Update an item
PUT https://www.zohoapis.com/books/v3/items?organization_id={organization_id} : Update an item using a custom field's unique value

Journals

GET https://www.zohoapis.com/books/v3/journals : Get journal list
POST https://www.zohoapis.com/books/v3/journals/comments?organization_id={organization_id} : Add comment to a journal
GET https://www.zohoapis.com/books/v3/journals/{journalEntryId} : Get journal
POST https://www.zohoapis.com/books/v3/journals/{journal_id}/attachment?organization_id={organization_id} : Add attachment to a journal
POST https://www.zohoapis.com/books/v3/journals/{journal_id}/status/publish : Mark a journal as published
DELETE https://www.zohoapis.com/books/v3/journals/{journal_id}?organization_id={organization_id} : Delete a journal
POST https://www.zohoapis.com/books/v3/journals?organization_id={organization_id} : Create a journal

Projects

GET https://www.zohoapis.com/books/v3/projects : List projects
GET https://www.zohoapis.com/books/v3/projects/timeentries : List time entries
GET https://www.zohoapis.com/books/v3/projects/timeentries/runningtimer/me?organization_id={organization_id} : Get current running timer
POST https://www.zohoapis.com/books/v3/projects/timeentries/timer/stop?organization_id={organization_id} : Stop timer
DELETE https://www.zohoapis.com/books/v3/projects/timeentries/{time_entry_id}?organization_id={organization_id} : Delete time entry
GET https://www.zohoapis.com/books/v3/projects/timeentries/{timeentrie_id} : Get a time entry
POST https://www.zohoapis.com/books/v3/projects/timeentries/{timeentrie_id}/timer/start?organization_id={organization_id} : Start timer
PUT https://www.zohoapis.com/books/v3/projects/timeentries/{timeentrie_id}?organization_id={organization_id} : Update time entry
DELETE https://www.zohoapis.com/books/v3/projects/timeentries?organization_id={organization_id} : Delete time entries
GET https://www.zohoapis.com/books/v3/projects/{project_id} : Get a project
POST https://www.zohoapis.com/books/v3/projects/{project_id}/active : Activate project
POST https://www.zohoapis.com/books/v3/projects/{project_id}/clone?organization_id={organization_id} : Clone project
GET https://www.zohoapis.com/books/v3/projects/{project_id}/comments : List comments
DELETE https://www.zohoapis.com/books/v3/projects/{project_id}/comments/{comment_id} : Delete comment
POST https://www.zohoapis.com/books/v3/projects/{project_id}/comments?organization_id={organization_id} : Post comment
POST https://www.zohoapis.com/books/v3/projects/{project_id}/inactive : Inactivate a project
GET https://www.zohoapis.com/books/v3/projects/{project_id}/tasks : List tasks
GET https://www.zohoapis.com/books/v3/projects/{project_id}/tasks/{task_id} : Get a task
PUT https://www.zohoapis.com/books/v3/projects/{project_id}/tasks/{task_id}?organization_id={organization_id} : Update a task
POST https://www.zohoapis.com/books/v3/projects/{project_id}/tasks?organization_id={organization_id} : Add a task
GET https://www.zohoapis.com/books/v3/projects/{project_id}/users : List Users
POST https://www.zohoapis.com/books/v3/projects/{project_id}/users/invite?organization_id={organization_id} : Invite User to Project
GET https://www.zohoapis.com/books/v3/projects/{project_id}/users/{user_id} : Get a User
DELETE https://www.zohoapis.com/books/v3/projects/{project_id}/users/{user_id}?organization_id={organization_id} : Delete user
POST https://www.zohoapis.com/books/v3/projects/{project_id}/users?organization_id={organization_id} : Assign users to a project
DELETE https://www.zohoapis.com/books/v3/projects/{project_id}?organization_id={organization_id} : Delete project
POST https://www.zohoapis.com/books/v3/projects?organization_id={organization_id} : Create a project

Purchase Orders

GET https://www.zohoapis.com/books/v3/purchaseorders : List purchase orders
DELETE https://www.zohoapis.com/books/v3/purchaseorders/?organization_id={organization_id} : Delete purchase order
GET https://www.zohoapis.com/books/v3/purchaseorders/templates : List purchase order templates
GET https://www.zohoapis.com/books/v3/purchaseorders/{purchaseOrderId} : Get a purchase order
POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/approve : Approve a purchase order
POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/attachment : Add attachment to a purchase order
GET https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/comments : List purchase order comments & history
POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/comments?organization_id={organization_id} : Add comment to purchase order
PUT https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/customfields : Update custom field in existing purchaseorders
GET https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/email : Get purchase order email content
POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/email?organization_id={organization_id} : Email a purchase order
POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/status/billed : Mark as billed
POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/status/cancelled : Cancel a purchase order
POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/status/open : Mark a purchase order as open
POST https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/submit : Submit a purchase order for approval
PUT https://www.zohoapis.com/books/v3/purchaseorders/{purchaseorder_id}/templates/{template_id}?organization_id={organization_id} : Update purchase order template
POST https://www.zohoapis.com/books/v3/purchaseorders?organization_id={organization_id} : Create a purchase order

Recurring Bills

GET https://www.zohoapis.com/books/v3/recurring_bills/{recurring_bill_id} : Get a recurring bill
DELETE https://www.zohoapis.com/books/v3/recurring_bills/{recurring_bill_id}?organization_id={organization_id} : Delete a recurring bill
GET https://www.zohoapis.com/books/v3/recurringbills : List recurring bills
GET https://www.zohoapis.com/books/v3/recurringbills/{recurring_bill_id}/comments : List recurring bill history
POST https://www.zohoapis.com/books/v3/recurringbills/{recurring_bill_id}/status/resume : Resume a recurring Bill
POST https://www.zohoapis.com/books/v3/recurringbills/{recurring_bill_id}/status/stop : Stop a recurring bill
PUT https://www.zohoapis.com/books/v3/recurringbills/{recurring_bill_id}?organization_id={organization_id} : Update a recurring bill
PUT https://www.zohoapis.com/books/v3/recurringbills?organization_id={organization_id} : Update a recurring bill using a custom field's unique value

Recurring Expenses

GET https://www.zohoapis.com/books/v3/recurringexpenses : List recurring expenses
GET https://www.zohoapis.com/books/v3/recurringexpenses/{recurring_expense_id}/comments : List recurring expense history
POST https://www.zohoapis.com/books/v3/recurringexpenses/{recurring_expense_id}/status/resume : Resume a recurring Expense
POST https://www.zohoapis.com/books/v3/recurringexpenses/{recurring_expense_id}/status/stop : Stop a recurring expense
PUT https://www.zohoapis.com/books/v3/recurringexpenses/{recurring_expense_id}?organization_id={organization_id} : Update a recurring expense
GET https://www.zohoapis.com/books/v3/recurringexpenses/{recurringexpense_id}/expenses?organization_id={organization_id} : List child expenses created
GET https://www.zohoapis.com/books/v3/recurringexpenses/{recurringexpense_id}?organization_id={organization_id} : Get a recurring expense
POST https://www.zohoapis.com/books/v3/recurringexpenses?organization_id={organization_id} : Create a recurring expense

Recurring Invoices

GET https://www.zohoapis.com/books/v3/recurringinvoices : List all Recurring Invoice
DELETE https://www.zohoapis.com/books/v3/recurringinvoices/{invoice_id}?organization_id={organization_id} : Delete a Recurring Invoice
GET https://www.zohoapis.com/books/v3/recurringinvoices/{recurring_invoice_id} : Get a Recurring Invoice
GET https://www.zohoapis.com/books/v3/recurringinvoices/{recurring_invoice_id}/comments : List Recurring Invoice History
POST https://www.zohoapis.com/books/v3/recurringinvoices/{recurring_invoice_id}/status/resume : Resume a Recurring Invoice
POST https://www.zohoapis.com/books/v3/recurringinvoices/{recurring_invoice_id}/status/stop : Stop a Recurring Invoice
PUT https://www.zohoapis.com/books/v3/recurringinvoices/{recurring_invoice_id}/templates/{template_id} : Update Recurring Invoice Template
PUT https://www.zohoapis.com/books/v3/recurringinvoices/{recurringinvoice_id}?organization_id={organization_id} : Update Recurring Invoice
POST https://www.zohoapis.com/books/v3/recurringinvoices?organization_id={organization_id} : Create a Recurring Invoice

Retainer Invoices

GET https://www.zohoapis.com/books/v3/retainerinvoices : List a retainer invoices
POST https://www.zohoapis.com/books/v3/retainerinvoices/approve?organization_id={organization_id} : Approve a retainer invoice.
POST https://www.zohoapis.com/books/v3/retainerinvoices/submit : Submit a retainer invoice for approval
GET https://www.zohoapis.com/books/v3/retainerinvoices/templates : List retainer invoice templates
GET https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}/attachment : Get a retainer invoice attachment
POST https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}/attachment?organization_id={organization_id} : Add attachment to a retainer invoice
GET https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}/email : Get retainer invoice email content
POST https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}/status/sent : Mark a retainer invoice as sent
POST https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}/status/void : Void a retainer invoice
PUT https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}/templates/{template_id}?organization_id={organization_id} : Update retainer invoice template
DELETE https://www.zohoapis.com/books/v3/retainerinvoices/{invoice_id}?organization_id={organization_id} : Delete a retainer invoice
GET https://www.zohoapis.com/books/v3/retainerinvoices/{retainerinvoice_id} : Get a retainer invoice
GET https://www.zohoapis.com/books/v3/retainerinvoices/{retainerinvoice_id}/comments : List retainer invoice comments & history
POST https://www.zohoapis.com/books/v3/retainerinvoices/{retainerinvoice_id}/comments?organization_id={organization_id} : Add comment to retainer invoice
POST https://www.zohoapis.com/books/v3/retainerinvoices/{retainerinvoice_id}/email?organization_id={organization_id} : Email a retainer invoice
PUT https://www.zohoapis.com/books/v3/retainerinvoices/{retainerinvoice_id}?organization_id={organization_id} : Update a Retainer Invoice
POST https://www.zohoapis.com/books/v3/retainerinvoices?organization_id={organization_id} : Create a retainerinvoice

Sales Orders

GET https://www.zohoapis.com/books/v3/salesorders : List sales orders
GET https://www.zohoapis.com/books/v3/salesorders/pdf : Bulk export sales orders
GET https://www.zohoapis.com/books/v3/salesorders/print : Bulk print sales orders
GET https://www.zohoapis.com/books/v3/salesorders/templates : List sales order templates
GET https://www.zohoapis.com/books/v3/salesorders/{salesorder_id} : Get a sales order
POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/approve : Approve a sales order.
PUT https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/attachment : Update attachment preference
POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/attachment?organization_id={organization_id} : Add attachment to a sales order
GET https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/comments : List sales order comments & history
PUT https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/comments/{comment_id}?organization_id={organization_id} : Update comment
POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/comments?organization_id={organization_id} : Add comment to sales order
PUT https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/customfields : Update custom field in existing salesorders
GET https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/email : Get sales order email content
POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/email?organization_id={organization_id} : Email a sales order
POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/status/open : Mark a sales order as open
POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/status/void?organization_id={organization_id} : Mark a sales order as void
POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/submit : Submit a sales order for approval
POST https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/substatus/{substatus}?organization_id={organization_id} : Update a sales order sub status
PUT https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}/templates/{template_id}?organization_id={organization_id} : Update sales order template
DELETE https://www.zohoapis.com/books/v3/salesorders/{salesorder_id}?organization_id={organization_id} : Delete a sales order
PUT https://www.zohoapis.com/books/v3/salesorders?organization_id={organization_id} : Update a sales order using a custom field's unique value

Settings

Currencies

GET https://www.zohoapis.com/books/v3/settings/currencies : List Currencies
GET https://www.zohoapis.com/books/v3/settings/currencies/{currencie_id} : Get a Currency
GET https://www.zohoapis.com/books/v3/settings/currencies/{currencie_id}/exchangerates : List exchange rates
PUT https://www.zohoapis.com/books/v3/settings/currencies/{currencie_id}/exchangerates/{exchangerate_id}?organization_id={organization_id} : Update an exchange rate
POST https://www.zohoapis.com/books/v3/settings/currencies/{currencie_id}/exchangerates?organization_id={organization_id} : Create an exchange rate
PUT https://www.zohoapis.com/books/v3/settings/currencies/{currencie_id}?organization_id={organization_id} : Update a Currency
DELETE https://www.zohoapis.com/books/v3/settings/currencies/{currency_id}/exchangerates/{exchange_rate_id}?organization_id={organization_id} : Delete an exchange rate
DELETE https://www.zohoapis.com/books/v3/settings/currencies/{currency_id}?organization_id={organization_id} : Delete a currency
POST https://www.zohoapis.com/books/v3/settings/currencies?organization_id={organization_id} : Create a Currency

Opening Balances

DELETE https://www.zohoapis.com/books/v3/settings/openingbalances : Delete opening balance
PUT https://www.zohoapis.com/books/v3/settings/openingbalances?organization_id={organization_id} : Update opening balance

Tax Authorities

GET https://www.zohoapis.com/books/v3/settings/taxauthorities : List tax authorities [US Edition only]
GET https://www.zohoapis.com/books/v3/settings/taxauthorities/{tax_authority_id} : Get a tax authority [US and CA Edition only]
PUT https://www.zohoapis.com/books/v3/settings/taxauthorities/{taxauthoritie_id}?organization_id={organization_id} : Update a tax authority [US and CA Edition only]
POST https://www.zohoapis.com/books/v3/settings/taxauthorities?organization_id={organization_id} : Create a tax authority [US and CA Edition only]

Taxes

GET https://www.zohoapis.com/books/v3/settings/taxes : List taxes
DELETE https://www.zohoapis.com/books/v3/settings/taxes/{tax_id}?organization_id={organization_id} : Delete a tax
GET https://www.zohoapis.com/books/v3/settings/taxes/{taxe_id} : Get a tax
PUT https://www.zohoapis.com/books/v3/settings/taxes/{taxe_id}?organization_id={organization_id} : Update a tax
POST https://www.zohoapis.com/books/v3/settings/taxes?organization_id={organization_id} : Create a tax

Tax Exemptions

GET https://www.zohoapis.com/books/v3/settings/taxexemptions : List tax exemptions [US Edition only]
DELETE https://www.zohoapis.com/books/v3/settings/taxexemptions/{tax_exemption_id}?organization_id={organization_id} : Delete a tax exemption [US Edition only]
GET https://www.zohoapis.com/books/v3/settings/taxexemptions/{taxexemption_id} : Get a tax exemption [US Edition only]
PUT https://www.zohoapis.com/books/v3/settings/taxexemptions/{taxexemption_id}?organization_id={organization_id} : Update a tax exemption [US Edition only]
POST https://www.zohoapis.com/books/v3/settings/taxexemptions?organization_id={organization_id} : Create a tax exemption [US Edition only]

Tax Groups

GET https://www.zohoapis.com/books/v3/settings/taxgroups/{taxgroup_id}?organization_id={organization_id} : Get a tax group
POST https://www.zohoapis.com/books/v3/settings/taxgroups?organization_id={organization_id} : Create a tax group

GET https://www.zohoapis.com/books/v3/share/paymentlink : Generate payment link

Users

GET https://www.zohoapis.com/books/v3/users/me : Get current user
POST https://www.zohoapis.com/books/v3/users/{user_id}/active : Mark user as active
POST https://www.zohoapis.com/books/v3/users/{user_id}/inactive : Mark user as inactive
POST https://www.zohoapis.com/books/v3/users/{user_id}/invite : Invite a user
PUT https://www.zohoapis.com/books/v3/users/{user_id}?organization_id={organization_id} : Update a user
POST https://www.zohoapis.com/books/v3/users?organization_id={organization_id} : Create a user

Vendor Credits

GET https://www.zohoapis.com/books/v3/vendorcredits : List vendor credits
GET https://www.zohoapis.com/books/v3/vendorcredits/refunds : List vendor credit refunds
DELETE https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_bill_id}/bills/?organization_id={organization_id} : Delete bills credited
GET https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id} : Get vendor credit
GET https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/comments : List vendor credit comments & history
DELETE https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/comments/{comment_id} : Delete a comment
GET https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/refunds : List refunds of a vendor credit
DELETE https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/refunds/{refund_id} : Delete vendor credit refund
GET https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/refunds/{vendor_credit_refund_id} : Get vendor credit refund
POST https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/status/open : Convert Vendor Credit Status to Open
POST https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}/status/void : Void vendor credit
PUT https://www.zohoapis.com/books/v3/vendorcredits/{vendor_credit_id}?organization_id={organization_id} : Update vendor credit
POST https://www.zohoapis.com/books/v3/vendorcredits/{vendorcredit_id}/approve?organization_id={organization_id} : Approve a Vendor credit
POST https://www.zohoapis.com/books/v3/vendorcredits/{vendorcredit_id}/bills?organization_id={organization_id} : Apply credits to a bill
POST https://www.zohoapis.com/books/v3/vendorcredits/{vendorcredit_id}/comments?organization_id={organization_id} : Add a comment to an existing vendor credit
PUT https://www.zohoapis.com/books/v3/vendorcredits/{vendorcredit_id}/refunds/{refund_id}?organization_id={organization_id} : Update vendor credit refund
POST https://www.zohoapis.com/books/v3/vendorcredits/{vendorcredit_id}/refunds?organization_id={organization_id} : Refund a vendor credit
POST https://www.zohoapis.com/books/v3/vendorcredits/{vendorcredit_id}/submit?organization_id={organization_id} : Submit a Vendor credit for approval
POST https://www.zohoapis.com/books/v3/vendorcredits?organization_id={organization_id} : Create a vendor credit

Vendor Payments

GET https://www.zohoapis.com/books/v3/vendorpayments : List vendor payments
PUT https://www.zohoapis.com/books/v3/vendorpayments/{paymentId} : Update a vendor payment
GET https://www.zohoapis.com/books/v3/vendorpayments/{payment_id}?organization_id={organization_id} : Get a vendor payment
DELETE https://www.zohoapis.com/books/v3/vendorpayments/{vendor_payment_id}?organization_id={organization_id} : Delete a vendor payment
GET https://www.zohoapis.com/books/v3/vendorpayments/{vendorpayment_id}/refunds : List refunds of a vendor payment
GET https://www.zohoapis.com/books/v3/vendorpayments/{vendorpayment_id}/refunds/{vendorpayment_refund_id} : Details of a refund
POST https://www.zohoapis.com/books/v3/vendorpayments/{vendorpayment_id}/refunds?organization_id={organization_id} : Refund an excess vendor payment
POST https://www.zohoapis.com/books/v3/vendorpayments?organization_id={organization_id} : Create a vendor payment

Zoho Books API FAQs

How do I authenticate with the Zoho Books API?

Answer: Zoho Books uses OAuth 2.0 for authentication. To access the API, you need to:some text
1. Register your application in the Zoho Developer Console.
2. Obtain the Client ID and Client Secret.
3. Generate an access token and a refresh token by following the OAuth 2.0 flow.
4. Use the access token in the Authorization header of your API requests.
Source: OAuth | Zoho Books | API Documentation

What are the rate limits for the Zoho Books API?

Answer: Zoho Books enforces rate limits based on your subscription plan:some text
- Free Plan: 1,000 API requests per day.
- Standard Plan: 2,000 API requests per day.
- Professional Plan: 5,000 API requests per day.
- Premium Plan: 10,000 API requests per day.
- Elite Plan: 10,000 API requests per day.
- Ultimate Plan: 10,000 API requests per day.
- Additionally, there is a limit of 100 requests per minute per organization.
Source: Introduction | Zoho Books | API Documentation

How can I retrieve a list of invoices using the Zoho Books API?

Answer: To retrieve a list of invoices, make a GET request to the /invoices endpoint:
bash
GET https://www.zohoapis.com/books/v3/invoices?organization_id=YOUR_ORG_ID

Replace YOUR_ORG_ID with your actual organization ID. Ensure you include the Authorization header with your access token.
Source: Invoices | Zoho Books | API Documentation

Does the Zoho Books API support webhooks for real-time updates?

Answer: As of the latest available information, Zoho Books does not natively support webhooks. However, you can use the API to poll for changes or integrate with third-party services that provide webhook functionality to achieve similar outcomes.

Can I create custom fields for items using the Zoho Books API?

Answer: Yes, you can create custom fields for items. When creating or updating an item, include the custom_fields array in your request payload, specifying the customfield_id and its corresponding value.
Source: Items | Zoho Books | API Documentation

Get Started with Zoho Books API Integration

For quick and seamless integration with Zohobooks API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Zohobooks API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Zohobooks API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

Xero API Directory

Xero is a leading cloud-based accounting software platform tailored for small and medium-sized businesses. It offers an extensive suite of financial management tools, including invoicing, bank reconciliation, expense tracking, and financial reporting. These features simplify the financial management process, allowing businesses to efficiently handle their finances. Additionally, Xero provides payroll management tools to streamline employee payments, tax calculations, and ensure compliance with local payroll regulations. Its inventory management capabilities enable businesses to track stock levels and manage product sales effectively.

One of Xero's standout features is its integration capabilities, particularly through the Xero API. This allows seamless connectivity with a wide range of third-party applications, such as payment processors, CRM systems, and e-commerce platforms, enhancing the software's functionality. The user-friendly interface and real-time data access make it easy for users to manage their business finances from anywhere. Xero's versatility and comprehensive features make it an invaluable tool for businesses looking to streamline their financial operations and gain insights into their financial health.

Key highlights of Xero APIs

Authentication: Utilizes OAuth 2.0 for secure authentication, ensuring that only authorized applications can access user data. Xero Developer

Data Formats: Communicates using JSON, making it compatible with a wide range of programming languages and platforms. Xero Developer

Comprehensive Documentation: Provides detailed guides and references to assist developers in effectively utilizing the API. Xero Developer

SDKs and Libraries: Offers official SDKs for Java and Python, along with community-supported libraries, to streamline the development process. GitHub

‍

Xero API Endpoints

Payments

POST /Payments/{PaymentID} : Delete Payment
PUT /payments : Apply Payments to Invoices, Credit Notes, Prepayments, or Overpayments
GET https://api.xero.com/api.xro/2.0/Payments : Retrieve Payments for Invoices and Credit Notes
PUT https://api.xero.com/api.xro/2.0/Payments/{Guid}/History : Add Notes to a Batch Payment

Contacts

PUT https://api.example.com/contacts : Create Contact Records
POST https://api.xero.com/api.xro/2.0/Contacts : Create or Update Contacts
POST https://api.xero.com/api.xro/2.0/Contacts/{ContactID}/Attachments/{FileName} : Uploading an Attachment to a Contact in Xero
GET https://api.xero.com/api.xro/2.0/Contacts/{Guid}/History : Retrieving Contact History
GET https://api.xero.com/api.xro/2.0/contacts : GET Contacts

Accounts

GET https://api.xero.com/api.xro/2.0/Accounts : GET Accounts
POST https://api.xero.com/api.xro/2.0/Accounts/{AccountID} : Archive Accounts
PUT https://api.xero.com/api.xro/2.0/Accounts/{account_id}/Attachments/{file_name} : Uploading an Attachment to an Account in Xero

Bank Transactions

POST https://api.xero.com/api.xro/2.0/BankTransactions : Create or Update Bank Transactions
POST https://api.xero.com/api.xro/2.0/BankTransactions/{BankTransactionID} : Deleting Spend and Receive Money Transactions
GET https://api.xero.com/api.xro/2.0/BankTransactions/{Guid}/History : Retrieving History of Bank Transactions
POST https://api.xero.com/api.xro/2.0/BankTransactions/{bankTransactionID}/Attachments/{fileName} : Uploading an Attachment to a Bank Transaction

Bank Transfers

GET https://api.xero.com/api.xro/2.0/BankTransfers : GET BankTransfers
POST https://api.xero.com/api.xro/2.0/BankTransfers/{bank_transfer_id}/Attachments/{file_name} : Uploading an Attachment to a Bank Transfer

Batch Payments

POST https://api.xero.com/api.xro/2.0/BatchPayments : Update Batch Payment Status to DELETED

Branding Themes

GET https://api.xero.com/api.xro/2.0/BrandingThemes : Get Branding Themes
POST https://api.xero.com/api.xro/2.0/BrandingThemes/{BrandingThemeID}/PaymentServices : Apply Payment Service to Branding Theme

Contact Groups

POST https://api.xero.com/api.xro/2.0/ContactGroups : Create or Update Contact Groups
PUT https://api.xero.com/api.xro/2.0/ContactGroups/{ContactGroupID}/Contacts : PUT ContactGroups
DELETE https://api.xero.com/api.xro/2.0/ContactGroups/{ContactGroupID}/Contacts/{ContactID} : DELETE ContactGroups

Credit Notes

GET https://api.xero.com/api.xro/2.0/CreditNotes : GET Credit Notes
PUT https://api.xero.com/api.xro/2.0/CreditNotes/{CreditNoteID}/Allocations : Creating and Allocating CreditNotes
DELETE https://api.xero.com/api.xro/2.0/CreditNotes/{CreditNoteID}/Allocations/{AllocationID} : Delete CreditNotes Allocations
POST https://api.xero.com/api.xro/2.0/CreditNotes/{CreditNoteID}/Attachments/{FileName} : Uploading an Attachment to a Credit Note
PUT https://api.xero.com/api.xro/2.0/CreditNotes/{Guid}/History : Add Notes to a Credit Note

Currencies

GET https://api.xero.com/api.xro/2.0/Currencies : GET Currencies

Employees

PUT https://api.example.com/employees/{employeeId} : PUT Employees API
POST https://api.xero.com/api.xro/2.0/Employees : Create or Update Employee Records

Expense Claims

POST https://api.xero.com/api.xro/2.0/ExpenseClaims : Submit or Update Expense Claims
GET https://api.xero.com/api.xro/2.0/ExpenseClaims/{Guid}/History : Retrieving Expense Claim History

Invoice Reminders

GET https://api.xero.com/api.xro/2.0/InvoiceReminders/Settings : Check Invoice Reminders Settings

Invoices

POST https://api.xero.com/api.xro/2.0/Invoices : Create or Update Invoices
GET https://api.xero.com/api.xro/2.0/Invoices/{Guid}/History : Retrieve Invoice History
POST https://api.xero.com/api.xro/2.0/Invoices/{InvoiceID}/Attachments/{FileName} : Uploading an Attachment to an Invoice
POST https://api.xero.com/api.xro/2.0/Invoices/{InvoiceID}/Email : Email an Invoice via Xero API
GET https://api.xero.com/api.xro/2.0/Invoices/{InvoiceID}/OnlineInvoice : Retrieve Online Invoice URL

Items

GET https://api.xero.com/api.xro/2.0/Items : GET Items
GET https://api.xero.com/api.xro/2.0/Items/{Guid}/History : Retrieving Item History
DELETE https://api.xero.com/api.xro/2.0/Items/{ItemID} : Delete Items

Journals

GET https://api.xero.com/api.xro/2.0/Journals : GET Journals

Linked Transactions

POST https://api.xero.com/api.xro/2.0/LinkedTransactions : Create or Update Linked Transactions
DELETE https://api.xero.com/api.xro/2.0/LinkedTransactions/{LinkedTransactionID} : Delete Linked Transaction

Manual Journals

PUT https://api.example.com/manualjournals : Create New Manual Journals
POST https://api.xero.com/api.xro/2.0/ManualJournals : Create or Update Manual Journal
POST https://api.xero.com/api.xro/2.0/ManualJournals/{manualJournalID}/Attachments/{fileName} : Uploading an Attachment to a Manual Journal

Organisation

GET https://api.xero.com/api.xro/2.0/Organisation : Get Organisation Details
GET https://api.xero.com/api.xro/2.0/Organisation/Actions : GET Organisation Actions
GET https://api.xero.com/api.xro/2.0/Organisation/{OrganisationID}/CISSettings : Retrieve CIS Settings for an Organisation

Overpayments

GET https://api.xero.com/api.xro/2.0/Overpayments : GET Overpayments
PUT https://api.xero.com/api.xro/2.0/Overpayments/{Guid}/History : Add Notes to an Overpayment
PUT https://api.xero.com/api.xro/2.0/Overpayments/{OverpaymentID}/Allocations : Allocate Overpayment to Outstanding Invoices
DELETE https://api.xero.com/api.xro/2.0/Overpayments/{OverpaymentID}/Allocations/{AllocationID} : Deleting Overpayments Allocations

Payment Services

GET https://api.xero.com/api.xro/2.0/PaymentServices : Get Payment Services

Prepayments

GET https://api.xero.com/api.xro/2.0/Prepayments : Retrieve Prepayments
GET https://api.xero.com/api.xro/2.0/Prepayments/{Guid}/History : Retrieving Prepayment History
PUT https://api.xero.com/api.xro/2.0/Prepayments/{PrepaymentID}/Allocations : Allocate Prepayment to Outstanding Invoices
DELETE https://api.xero.com/api.xro/2.0/Prepayments/{PrepaymentID}/Allocations/{AllocationID} : Deleting Prepayments Allocations

Purchase Orders

GET https://api.xero.com/api.xro/2.0/PurchaseOrders : Retrieve Purchase Orders
GET https://api.xero.com/api.xro/2.0/PurchaseOrders/{Guid}/History : Retrieve Purchase Order History

Quotes

PUT https://api.example.com/quotes/{quoteId} : PUT Quotes API
GET https://api.xero.com/api.xro/2.0/Quotes : GET Quotes

Receipts

PUT https://api.xero.com/api.xro/2.0/Receipts : PUT Receipts
PUT https://api.xero.com/api.xro/2.0/Receipts/{Guid}/History : Add Notes to a Receipt
POST https://api.xero.com/api.xro/2.0/Receipts/{receipt_id}/Attachments/{file_name} : Uploading a Receipt Image

Repeating Invoices

POST https://api.xero.com/api.xro/2.0/RepeatingInvoices : Create or Delete Repeating Invoice Templates
GET https://api.xero.com/api.xro/2.0/RepeatingInvoices/{Guid}/History : Retrieving Repeating Invoice History

Reports

GET https://api.xero.com/api.xro/2.0/Reports : Get GST Report
GET https://api.xero.com/api.xro/2.0/Reports/AgedPayablesByContact : Aged Payables By Contact
GET https://api.xero.com/api.xro/2.0/Reports/AgedReceivablesByContact : Aged Receivables By Contact
GET https://api.xero.com/api.xro/2.0/Reports/BalanceSheet : Balance Sheet Report API
GET https://api.xero.com/api.xro/2.0/Reports/BankSummary : Bank Summary Report
GET https://api.xero.com/api.xro/2.0/Reports/BudgetSummary : Budget Summary
GET https://api.xero.com/api.xro/2.0/Reports/ExecutiveSummary : Get Executive Summary Report
GET https://api.xero.com/api.xro/2.0/Reports/ProfitAndLoss : Profit and Loss Report
GET https://api.xero.com/api.xro/2.0/Reports/TenNinetyNine : 1099 Report Retrieval
GET https://api.xero.com/api.xro/2.0/Reports/TrialBalance : Get Trial Balance Report

Tax Rates

POST https://api.xero.com/api.xro/2.0/TaxRates : Create or Update Tax Rate

Tracking Categories

PUT https://api.xero.com/api.xro/2.0/TrackingCategories : Create Tracking Categories and Options
POST https://api.xero.com/api.xro/2.0/TrackingCategories/{TrackingCategoryID} : Update Tracking Categories and Options

Users

GET https://api.xero.com/api.xro/2.0/Users : GET Users

Budgets

GET https://api.xero.com/api.xro/2.0/budgets : GET Budgets

Attachments

GET https://api.xero.com/api.xro/2.0/{Endpoint}/{Guid}/Attachments/ : GET Attachments
POST https://api.xero.com/api.xro/2.0/{Endpoint}/{Guid}/Attachments/{Filename} : Upload Attachments to Xero

Document History

GET https://api.xero.com/api.xro/2.0/{Endpoint}/{Guid}/history : Get Document History

Sample API

GET https://api.example.com/v1/resource : Sample API Documentation
POST https://api.example.com/v1/sample : Sample API

Xero API FAQs

How do I get started with the Xero API?
- Answer: To begin using the Xero API, follow these steps:some text
  - Sign up for a free Xero account.
  - Enable the Xero demo company.
  - Add your OAuth 2.0 application by logging into Xero and navigating to the developer portal.
- Source: Getting Started Guide — Xero Developer
What authentication method does the Xero API use?
- Answer: The Xero API utilizes OAuth 2.0 for authentication. You'll need to create an OAuth 2.0 app in the Xero developer portal to obtain the necessary credentials for API access.
- Source: Frequently Asked Questions — Xero Developer
Are there rate limits for the Xero API?
- Answer: Yes, Xero enforces rate limits to ensure fair usage:some text
  - Minute Limit: 60 calls per minute.
  - Daily Limit: 5,000 calls per day.
  - Concurrent Requests: A maximum of 5 concurrent requests.
- Source: Frequently Asked Questions — Xero Developer
Can I retrieve invoices using the Xero API?
- Answer: Yes, you can retrieve invoices by making a GET request to the /Invoices endpoint of the Accounting API. You can filter and sort invoices using various parameters to suit your needs.
- Source: Accounting API Overview — Xero Developer
Does the Xero API support webhooks?
- Answer: Yes, Xero supports webhooks, allowing your application to receive real-time notifications about specific events, such as changes to invoices or contacts.‍
- Source: Frequently Asked Questions — Xero Developer

Get Started with Xero API Integration

Create a Xero Account: If you don't have one, sign up for a Xero account.
Register Your Application: Access the Xero Developer Center to create a new application, which will provide you with a Client ID and Client Secret necessary for authentication. Xero Developer
Authenticate Using OAuth 2.0: Implement the OAuth 2.0 flow to obtain an access token, allowing your application to interact with the Xero API on behalf of users. Xero Developer
Utilize SDKs and Libraries: Leverage available SDKs and libraries to simplify API integration within your application. GitHub GitHub
Explore API Endpoints: Familiarize yourself with various API endpoints to perform operations such as creating invoices, managing contacts, and retrieving financial reports. Xero Developer

Additional Resources:

API Explorer: Xero offers an API Explorer to facilitate testing and understanding of API endpoints. Xero Developer
Developer Community: Engage with the Xero developer community for support, insights, and updates related to the API. Xero Developer

About Knit

For quick and seamless integration with Xero API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Xero API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Xero API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

7Shifts API Directory

7Shifts is a robust employee scheduling software tailored specifically for the restaurant industry, offering a suite of tools that streamline workforce management. By focusing on the unique needs of restaurant operations, 7Shifts provides features such as scheduling, time tracking, tip management, payroll integration, and team communication. These functionalities are designed to enhance operational efficiency, reduce labor costs, and improve staff productivity, making it an essential tool for restaurant managers looking to optimize their workforce management processes.

This guide is part of our growing collection on HRIS integrations. We’re continuously exploring new apps and updating our HRIS Guides Directory with fresh insights.

One of the stand out features of 7Shifts is its ability to integrate seamlessly with various platforms through the 7Shifts API. This integration capability allows restaurants to connect their existing systems with 7Shifts, ensuring a smooth flow of data and enhancing overall operational efficiency. The 7Shifts API enables businesses to customize their scheduling and workforce management processes, providing a flexible solution that adapts to the specific needs of each restaurant. As such, understanding the 7Shifts API integration process is crucial for maximizing the software's potential and achieving optimal results in restaurant management.

Key highlights of 7Shifts APIs

Easy Data Access:
- Organized around predictable, resource-oriented URLs for easier data management.
Automation:
- Supports automation through integration with other systems.
Custom Integration:
- Integrates with key POS, time clocking, and payroll software for enhanced management processes.
Real-Time Sync:
- Supports webhooks for real-time data synchronization and event-driven actions.
Strong Security:
- Uses HTTP response codes for secure communication.
Scalable:
- Handles multiple requests with rate limiting at 10 requests per second per access token.
Developer-Friendly:
- Follows RESTful principles with predictable URLs.
Error Handling and Logging:
- Utilizes HTTP response codes for effective error handling.
Rate Limiting:
- Enforces rate limits to ensure fair usage.
Webhook Support:
- Enables real-time data synchronization and event-driven actions.

7Shifts API Endpoints

Authentication

POST https://api.7shifts.com/oauth2/token : Acquire OAuth Token

Company

GET https://api.7shifts.com/v2/companies/{id} : Get Company Details
POST https://api.7shifts.com/v2/company/{company_id}/create_many_users : Create Multiple Users in a Company
GET https://api.7shifts.com/v2/company/{company_id}/departments : Get Company Departments
PUT https://api.7shifts.com/v2/company/{company_id}/departments/{department_id} : Update Department Details
GET https://api.7shifts.com/v2/company/{company_id}/events : Get Company Events
DELETE https://api.7shifts.com/v2/company/{company_id}/events/{event_id} : Delete Event from Company
GET https://api.7shifts.com/v2/company/{company_id}/external_user_mappings : Get External User Mappings for a Company
PUT https://api.7shifts.com/v2/company/{company_id}/external_user_mappings/{identifier} : Update External User Mappings
POST https://api.7shifts.com/v2/company/{company_id}/external_user_mappings_bulk : Bulk External User Mappings for a Company
GET https://api.7shifts.com/v2/company/{company_id}/inactive_reasons : Get Inactive Reasons for a Company
GET https://api.7shifts.com/v2/company/{company_id}/labor_settings : Get Company Labor Settings
GET https://api.7shifts.com/v2/company/{company_id}/roles : Get Company Roles
GET https://api.7shifts.com/v2/company/{company_id}/roles/{role_id} : Get Role Details for a Company
GET https://api.7shifts.com/v2/company/{company_id}/shift_feedback : Get Shift Feedback for a Company
GET https://api.7shifts.com/v2/company/{company_id}/task_management_settings : Get Task Management Settings for a Company
POST https://api.7shifts.com/v2/company/{company_id}/task_tags : Create Task Tags for a Company
GET https://api.7shifts.com/v2/company/{company_id}/test_webhook : Test Webhook for a Company
GET https://api.7shifts.com/v2/company/{company_id}/webhooks : Get Company Webhooks
DELETE https://api.7shifts.com/v2/company/{company_id}/webhooks/{webhook_id} : Delete Webhook for a Company
POST https://api.7shifts.com/v2/partner_company_creation : Create Trial Company

Locations

GET https://api.7shifts.com/api/v2/company/{company_id}/location/{location_id}/daily_stats : Get Daily Statistics for a Company Location
POST https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/forecast_override : Create Forecast Override for a Location
GET https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/sales_category_mappings : Get Sales Category Mappings for a Location
DELETE https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/sales_category_mappings/{external_id} : Delete Sales Category Mapping
POST https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/sales_category_mappings_bulk : Bulk Sales Category Mappings for a Location
GET https://api.7shifts.com/v2/company/{company_id}/locations : Get Company Locations
DELETE https://api.7shifts.com/v2/company/{company_id}/locations/{location_id} : Delete Location from Company
GET https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/engage_overview : Get Engage Overview for a Location
POST https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/forecast_override_interval : Override Project Sales Interval
POST https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/forecast_overrides_intervals : Override Project Sales Intervals
GET https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/tip_pool_detailed_report : Get Tip Pool Detailed Report
GET https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/tip_pool_summary_report : Get Tip Pool Summary Report

Availabilities

POST https://api.7shifts.com/v2/company/{company_id}/availabilities : Create Company Availability
PUT https://api.7shifts.com/v2/company/{company_id}/availabilities/{availability_id} : Update Availability for a Company
PUT https://api.7shifts.com/v2/company/{company_id}/availabilities/{availability_id}/status : Update Availability Status
GET https://api.7shifts.com/v2/company/{company_id}/availability_reasons : Get Availability Reasons for a Company
PUT https://api.7shifts.com/v2/company/{company_id}/availability_reasons/{availability_reason_id} : Update Availability Reason for a Company

Log Book

GET https://api.7shifts.com/v2/company/{company_id}/log_book_categories : Get Log Book Categories for a Company
PATCH https://api.7shifts.com/v2/company/{company_id}/log_book_categories/{id} : Update Log Book Category
POST https://api.7shifts.com/v2/company/{company_id}/log_book_comments : Create Log Book Comment
GET https://api.7shifts.com/v2/company/{company_id}/log_book_comments/{id} : Get Log Book Comment Details
GET https://api.7shifts.com/v2/company/{company_id}/log_book_posts : Get Log Book Posts for a Company
DELETE https://api.7shifts.com/v2/company/{company_id}/log_book_posts/{id} : Delete Log Book Post

Receipts

POST https://api.7shifts.com/v2/company/{company_id}/receipts : Create Company Receipt
PUT https://api.7shifts.com/v2/company/{company_id}/receipts/{receipt_id} : Update Receipt Details
GET https://api.7shifts.com/v2/company/{company_id}/receipts_summary : Get Receipts Summary for a Company

Shifts

POST https://api.7shifts.com/v2/company/{company_id}/shifts : Create a Shift for a Company
GET https://api.7shifts.com/v2/company/{company_id}/shifts/{shift_id} : Get Shift Details
GET https://api.7shifts.com/v2/company/{company_id}/shifts_scheduled/{id} : Get Scheduled Shift Details

Task Lists

GET https://api.7shifts.com/v2/company/{company_id}/task_list_daily_summary : Get Task List Daily Summary
POST https://api.7shifts.com/v2/company/{company_id}/task_list_templates : Create Task List Template
PUT https://api.7shifts.com/v2/company/{company_id}/task_list_templates/{uuid} : Update Task List Template
GET https://api.7shifts.com/v2/company/{company_id}/task_lists : Get Task Lists for a Company
GET https://api.7shifts.com/v2/company/{company_id}/task_lists/{list_id} : Get Task List Details
POST https://api.7shifts.com/v2/company/{company_id}/task_lists/{list_id}/tasks/{task_id}/clear : Clear a Task in a Task List for a Company
POST https://api.7shifts.com/v2/company/{company_id}/task_lists/{list_id}/tasks/{task_id}/complete : Complete a Task in a Task List for a Company

Time Punches

POST https://api.7shifts.com/v2/company/{company_id}/time_punches : Create Time Punch for a Company
GET https://api.7shifts.com/v2/company/{company_id}/time_punches/{time_punch_id} : Get Time Punch Details

Tip Pool

PUT https://api.7shifts.com/v2/company/{company_id}/tip_pool/{tip_pool_settings_uuid}/manual_entry : Update Manual Entry for Tip Pool
GET https://api.7shifts.com/v2/company/{company_id}/tip_pool_settings : Get Tip Pool Settings for a Company

Users

POST https://api.7shifts.com/v2/company/{company_id}/users : Create a New User in a Company
DELETE https://api.7shifts.com/v2/company/{company_id}/users/{identifier} : Delete User from Company
GET https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/assignments : Get User Assignments in a Company
POST https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/department_assignments : Create Department Assignment for User
DELETE https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/department_assignments/{department_id} : Delete User Department Assignment
GET https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/location_assignments : Get User Location Assignments
DELETE https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/location_assignments/{location_id} : Delete User Location Assignment
POST https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/role_assignments : Assign Role to User in Company
DELETE https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/role_assignments/{role_id} : Delete Role Assignment for a User in a Company
POST https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/wages : Create User Wage

Reports

GET https://api.7shifts.com/v2/reports/daily_sales_and_labor : Get Daily Sales and Labor Report
GET https://api.7shifts.com/v2/reports/hours_and_wages : Get Hours and Wages Report

Time Off

GET https://api.7shifts.com/v2/time_off : Get Time Off Details
GET https://api.7shifts.com/v2/time_off/total_hours : Get Total Time Off Hours
PATCH https://api.7shifts.com/v2/time_off/{time_off_id} : Update Time Off Request
POST https://api.7shifts.com/v2/time_off/{time_off_id}/approve : Approve Time Off Request
POST https://api.7shifts.com/v2/time_off/{time_off_id}/decline : Decline Time Off Request
POST https://api.7shifts.com/v2/time_off_settings/{company_id} : Set Time Off Settings for a Company

User Identity

GET https://api.7shifts.com/v2/whoami : Get User Identity and Details

7Shifts API FAQs

1. How do I authenticate my API requests to 7Shifts?

7Shifts uses OAuth 2.0 for authentication. You'll need to obtain a client ID and client secret from 7Shifts to generate access tokens.
Source: 7Shifts API Documentation: https://developers.7shifts.com/reference/authentication

2. What are the rate limits for the 7Shifts API?

7Shifts has rate limits in place to prevent abuse. Refer to the official documentation for the specific rate limits and potential throttling mechanisms.
Source: 7Shifts API Documentation: https://developers.7shifts.com/reference/introduction

3. How can I create a new employee in 7Shifts using the API?

You can use the POST /users endpoint to create new employees. Refer to the API documentation for the required parameters and request body format.
Source: 7Shifts API Documentation: https://developers.7shifts.com/reference/users

4. Can I use webhooks with the 7Shifts API to receive real-time notifications?

Yes, 7Shifts supports webhooks for real-time notifications. You can configure webhooks to receive updates on various events, such as new shifts, time-off requests, and more.
Source: 7Shifts API Documentation: https://developers.7shifts.com/reference/webhooks

5. What are the best practices for error handling in 7Shifts API integrations?

Always check the HTTP status code of API responses to identify errors. 7Shifts API returns detailed error messages in the response body. Handle different error codes appropriately to ensure your integration is robust.
Source: 7Shifts API Documentation: https://developers.7shifts.com/‍

Get Started with 7Shifts API Integration

For quick and seamless integration with 7Shifts API, Knit API offers a convenient solution. It’s AI powered unified integration platform allows you to build any 7Shifts API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, HRIS, Payroll and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to 7Shifts API.

To sign up for free, click here. To check the pricing, see our pricing page.

Greythr API Directory

Greythr software is a comprehensive human resources management solution tailored to optimize and streamline HR processes for organizations of varying sizes. It offers a suite of functionalities that cover essential HR domains, including Employee Information Management, Payroll, Leave Management, and Attendance Management. By automating these processes, Greythr enables HR departments to enhance efficiency, reduce manual errors, and ensure compliance with payroll regulations, making it an indispensable tool for modern businesses.

One of the standout features of Greythr is its ability to facilitate seamless onboarding and offboarding workflows, alongside providing an HR Help Desk, Letters, Tasks & Checklists, and Payroll Compliance tools. These features collectively empower organizations to manage their workforce effectively, from hiring to retirement. Furthermore, the Greythr API integration process allows businesses to extend the software's capabilities, ensuring that it can be customized to meet specific organizational needs. This flexibility makes Greythr a versatile choice for companies looking to enhance their HR operations.

Key highlights of GreytHR APIs

Authentication: greytHR employs OAuth 2.0 for secure API authentication, ensuring that only authorized entities can access sensitive HR data. Each API request requires an access token obtained using client credentials. Postman

Data Formats: The APIs communicate using JSON, ensuring compatibility with a wide range of programming languages and platforms. Postman

Comprehensive Documentation: greytHR provides detailed API documentation, including guides and references, to assist developers in effectively utilizing the APIs. GreyHR API Documentation

Integration Capabilities: The platform supports integrations with various external systems, such as Tally for accounting, enhancing workplace efficiency and data consistency. GreytHR Admin Help

‍

GreytHR API Endpoints

Attendance

GET https://api.greythr.com/attendance/v2/employee/insights : Get Attendance Summary for All Employees
GET https://api.greythr.com/attendance/v2/employee/muster : Get Attendance Muster Details for All Employees
GET https://api.greythr.com/attendance/v2/employee/{employee-id}/insights : Get Employee Attendance Summary
GET https://api.greythr.com/attendance/v2/employee/{employee-id}/muster : Get Employee Attendance Muster
GET https://api.greythr.com/attendance/v2/employee/{employee-id}/swipes : Get Employee Attendance Muster Raw Swipes

Employee Documents

POST https://api.greythr.com/employee/v2/emp-docs/category : Add Employee Document Category
GET https://api.greythr.com/employee/v2/emp-docs/{employeeId}/{categoryId} : Get Employee Documents
GET https://api.greythr.com/employee/v2/emp-docs/{employeeId}/{documentId}/{fileId} : Download Employee Documents
POST https://api.greythr.com/employee/v2/employee-docs/{employeeId}/{category} : Add Employee Document

Employee Information

GET https://api.greythr.com/employee/v2/employees : Get All Employees
GET https://api.greythr.com/employee/v2/employees/addresses/{address-type} : Get All Employee Address Details
GET https://api.greythr.com/employee/v2/employees/assets : Get All Employee Asset Details
GET https://api.greythr.com/employee/v2/employees/bank : Get All Employee Bank Details
GET https://api.greythr.com/employee/v2/employees/categories : Get All Employee Positions Details
GET https://api.greythr.com/employee/v2/employees/families/{relationtype-id} : Get Employees Family Details
GET https://api.greythr.com/employee/v2/employees/identities/{identity-code} : Get All Employee Identity Details
GET https://api.greythr.com/employee/v2/employees/lookup?q={Employee+No.%2FEmail%2FGuid%2FAccess+card%2F+Personal+email} : Employee Lookup
GET https://api.greythr.com/employee/v2/employees/org-tree : Get Orgtree Reporting Structure
GET https://api.greythr.com/employee/v2/employees/personal : Get All Employee Personal Details
GET https://api.greythr.com/employee/v2/employees/pf : Get All Employee PF & ESI Details
GET https://api.greythr.com/employee/v2/employees/profile : Get All Employee Profile Details
GET https://api.greythr.com/employee/v2/employees/qualifications : Get All Employee Qualifications Details
GET https://api.greythr.com/employee/v2/employees/separation : Get All Employee Separation Details
GET https://api.greythr.com/employee/v2/employees/statutory/india : Get All Employee Statutory Details
GET https://api.greythr.com/employee/v2/employees/work : Get All Employee Work Details
PUT https://api.greythr.com/employee/v2/employees/{employee-id} : Update Employee Information
PUT https://api.greythr.com/employee/v2/employees/{employee-id}/addresses/{address-type} : Update Employee Address Details
GET https://api.greythr.com/employee/v2/employees/{employee-id}/assets : Get Employee Asset Details
PUT https://api.greythr.com/employee/v2/employees/{employee-id}/assets/{asset-id} : Update Employee Assets
POST https://api.greythr.com/employee/v2/employees/{employee-id}/bank : Add Employee Bank Details
GET https://api.greythr.com/employee/v2/employees/{employee-id}/categories : Get Employee Positions Details
GET https://api.greythr.com/employee/v2/employees/{employee-id}/families : Get Employee Family Details
DELETE https://api.greythr.com/employee/v2/employees/{employee-id}/families/{relation-id} : Delete Family Member Details
POST https://api.greythr.com/employee/v2/employees/{employee-id}/family-benefit : Add Employee Family Benefits
GET https://api.greythr.com/employee/v2/employees/{employee-id}/identities : Get Employee's All Identity Details
DELETE https://api.greythr.com/employee/v2/employees/{employee-id}/identities/{identity-code} : Delete Employee Identity
GET https://api.greythr.com/employee/v2/employees/{employee-id}/org-tree : Get Employee Manager Details
GET https://api.greythr.com/employee/v2/employees/{employee-id}/personal : Get Employee Personal Details
GET https://api.greythr.com/employee/v2/employees/{employee-id}/pf : Get Employee PF & ESI Details
PUT https://api.greythr.com/employee/v2/employees/{employee-id}/profile : Update Employee Profile Details
GET https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications : Get Employee Qualifications Details
DELETE https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications/{qualification-id} : Delete Employee Qualifications Details
PUT https://api.greythr.com/employee/v2/employees/{employee-id}/separation : Update Employee Separation Details
PUT https://api.greythr.com/employee/v2/employees/{employee-id}/statutory/india : Update Employee Statutory Details
GET https://api.greythr.com/employee/v2/employees/{employee-id}/work : Get Employee Work Details

HR

POST https://api.greythr.com/hr/v2/lov : Post List of Values for Categories
GET https://api.greythr.com/hr/v2/lov/banks/{bankId}/branches : Get Bank Branch Details
POST https://api.greythr.com/hr/v2/lov/org/entities : Add greytHR Org Entities

Leave

POST https://api.greythr.com/leave/v2/employee/transactions : Leave Transaction Update
GET https://api.greythr.com/leave/v2/employee/years/{{Year}}/balance : Get Leave Balance Details for All Employees
GET https://api.greythr.com/leave/v2/employee/{employee-id}/transactions?start={{StartDate}}&end={{EndDate}} : Get Employee Leave Transactions
GET https://api.greythr.com/leave/v2/employee/{employee-id}/years/{Year}/balance : Get Employee Leave Balance for a Year

Payroll

GET https://api.greythr.com/payroll/v2/employees/handentry : Get All Employee Hand Entry Salary Items
GET https://api.greythr.com/payroll/v2/employees/resettlement/{payrollMonth} : Get Employees Resettlement for a Month
GET https://api.greythr.com/payroll/v2/employees/salary/statement/{{yyyy-mm-01}} : Get Salary Statement for a Month
GET https://api.greythr.com/payroll/v2/employees/salary/statement/{{yyyy-mm-01}}/{employee-id} : Get Salary Statement for an Employee for a Month
GET https://api.greythr.com/payroll/v2/employees/{employee-id} : Get Employee Hand Entry Salary Items
POST https://api.greythr.com/payroll/v2/form16/download : Form16 Download API
GET https://api.greythr.com/payroll/v2/pay-period/list : Get Pay Period API For The Financial Year
GET https://api.greythr.com/payroll/v2/pay-period?inputDate=2024-02-11 : Get Pay Period For Particular Date
GET https://api.greythr.com/payroll/v2/payslip/download?encoded=true : Generate Payslip For Employee
GET https://api.greythr.com/payroll/v2/salary/repository : Get Salary Repository Items
GET https://api.greythr.com/payroll/v2/salary/revision/difference/employees/{employee-id} : Get Salary Revision Difference
POST https://api.greythr.com/payroll/v2/salary/revision/employees/{employee-id} : Add Salary Revision
GET https://api.greythr.com/payroll/v2/salary/revision/employees/{employee-id}/{status} : Get Salary Revision History
POST https://api.greytip.com/payroll/v2/loan : Create Loan for Employee
DELETE https://apigee-test.greythr.com/payroll/v2/attendance/snapshot/employees/{employee-id} : Delete Attendance Snapshot

User

GET https://api.greythr.com/user/v2/users : Get Users List
POST https://api.greythr.com/user/v2/users/{userid}/auth : User SSO Authentication

Miscellaneous

POST https://api.greytip.com/pengo/v1/admin/payslip/download?encoded=false : Payslip Download
GET https://apigee-test.greythr.com/employee/v2/employees/employeeId/card-details/cardId : Get Employee Card Details
POST https://apigee-test.greythr.com/employee/v2/employees/{employeeId}/card-details : Add Employee Card Details
DELETE https://apigee-test.greythr.com/employee/v2/employees/{employeeId}/card-details/{cardId} : Delete Employee Card Details

GreytHR API FAQ

How can I access the greytHR API?
- Answer: To access the greytHR API, you need to create an API user within the greytHR Admin portal. Navigate to Settings > My Account > API Users, then click on Create API User. Fill in the required details and assign appropriate roles to define the API user's permissions. GreyHR Freshdesk
What authentication method does the greytHR API use?
- Answer: The greytHR API utilizes OAuth 2.0 for authentication. After creating an API user, you can obtain an access token by sending a POST request to the /uas/v1/oauth2/client-token endpoint, using the client ID and client credentials obtained during the registration process. This access token must be included in the Authorization header of subsequent API requests. Postman
Are there rate limits for the greytHR API?
- Answer: The official documentation does not specify explicit rate limits for the greytHR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
Can I retrieve employee data using the greytHR API?
- Answer: Yes, the greytHR API provides endpoints to retrieve employee data. For example, you can use the GET /employee/v2/employees endpoint to fetch a list of all employees, with options to filter based on parameters like state, status, and categories. Postman
Does the greytHR API support webhooks for real-time data updates?
- Answer: As of the latest available information, the greytHR API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.

‍

Get Started with GreytHR API Integration

Create an API User: Administrators can create API users through the greytHR Admin portal by navigating to Settings > My Account > API Users and clicking "Create API User." GreyHR Freshdesk
Enable API Roles: After creating an API user, enable the necessary roles by selecting "API User Provisioning" and granting the required access permissions. GreyHR Freshdesk
Generate API Credentials: Once roles are assigned, generate API credentials (Client ID and Client Secret) for the API user to facilitate authentication. GreyHR Freshdesk
Authenticate Using OAuth 2.0: Utilize the Client ID and Client Secret to obtain an access token via the OAuth 2.0 protocol, which will be used to authenticate API requests. Postman
Explore API Endpoints: Familiarize yourself with various API endpoints to perform operations such as retrieving employee details, managing leave records, and processing attendance data. GreyHR API Documentation

Additional Resources:

Postman Collection: greytHR offers a Postman collection to facilitate testing and understanding of API endpoints. Postman
Developer Community: Engage with the greytHR developer community for support, insights, and updates related to the APIs.

‍

About Knit

Knit API offers a convenient solution for quick and seamless integration with GreytHR API. Our AI-powered integration platform allows you to build any GreytHR API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to GreytHR API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

Sage Intacct API Directory

Sage Intacct is a cloud-based accounting system designed to help businesses manage their finances more efficiently. It automates essential tasks, provides real-time financial insights, and scales with business growth.

‍

In addition to its core features, Sage Intacct offers powerful APIs that allow seamless integration with other tools and customizable workflows. These APIs enable businesses to automate invoicing, reporting, and payment processing, further enhancing operational efficiency.

‍

Key highlights of Sage Intacct APIs are as follows:

Seamless Integration: You can easily connect Sage Intacct with other business tools like CRM, payroll, or ERP systems for smooth data exchange.
Automation: These APIs help you automate financial tasks such as invoicing, payment processing, and reporting, reducing manual effort and errors.
Custom Workflows: They help you create tailored workflows to fit your business needs, enhancing operational efficiency and flexibility.
Real-Time Data Access: They can be used to access and update financial data in real-time, ensuring accurate and up-to-date information across systems.
Scalability: These APIs support growing businesses, allowing for the expansion of financial operations without disruptions.
Extensive Documentation: Sage Intacct provides detailed API documentation that makes it easier for developers to integrate and build custom solutions.

In this article, we’ll explore how Sage Intacct’s APIs can streamline your financial operations, enhance flexibility, and highlight the most commonly used endpoints.

‍

Sage Intacct API Endpoints

‍

Sage Intacct primarily uses a SOAP API for its integrations. The API follows the SOAP protocol and relies on XML for request and response formats, which provides structured and standardized communication. While this means it’s a bit more complex to implement compared to REST APIs, it’s highly secure and reliable, making it well-suited for handling sensitive financial data.

‍

Here are the commonly used Sage Intacct API endpoints, categorized by function:

‍

General Ledger

Accounts: GLACCOUNT
Journal Entries: GLBATCH
Statistical Journal Entries: STATGLBATCH

Accounts Receivable

Customers: CUSTOMER
Customer Invoices: ARINVOICE
Customer Payments: ARPYMT
Credit Memos: ARADJ

Accounts Payable

Vendors: VENDOR
Vendor Bills: APBILL
Vendor Payments: APPYMT
Debit Memos: APADJ

Cash Management

Payments: CMTRANSACTION
Deposits: CMDEPOSIT
Charge Card Transactions: CHARGECARD

Project Management

Projects: PROJECT
Tasks: TASK
Project Time Entries: TIMESHEET
Project Expenses: EXPENSES

Employee Expenses

Expense Reports: EXPENSEREPORT
Expense Types: EXPENSETYPE

Order Entry (for Sales and Inventory)

Sales Orders: SALESORDER
Inventory Items: INVENTORYITEM
Inventory Transactions: ICTRANSACTION

Reporting

Reports: getFinancialReport, getReport

Purchasing

Purchase Orders: PURCHASEORDER
Receiving Transactions: RECEIVE

Contracts and Subscriptions

Contracts: CONTRACT
Contract Line Items: CONTRACTLINE
Revenue Recognition Schedules: REVENUESCHEDULE

Inventory and Warehousing

Warehouse Locations: LOCATION
Inventory Control: ICITEM
Inventory Adjustments: ICADJUSTMENT
Inventory Transfers: ICTRANSFER

Purchasing and Vendor Management

Vendor Types: VENDTYPE
Purchase Requisitions: PURCHASEREQUISITION
Vendor Expense Requests: APADJ

Fixed Assets

Fixed Assets: ASSET
Asset Depreciation: DEPRECIATION
Asset Disposals: ASSETDISPOSAL
Asset Transfers: ASSETTRANSFER

Banking and Cash Management

Bank Accounts: BANKACCOUNT
Bank Reconciliation: RECONCILIATION
Bank Deposits: BANKDEPOSIT

Human Resources

Employees: EMPLOYEE
Employee Time: TIMESHEETENTRY
Payroll Details: (Integration with payroll systems required)

Tax Management

Tax Details: TAXDETAIL
Tax Jurisdictions: TAXJURISDICTION
Tax Groups: TAXGROUP

Miscellaneous and System-Level

Attachments: ATTACHMENTS (for managing document attachments across modules)
Custom Objects: getCustomObject (for custom modules or objects set up within Sage Intacct)
User Permissions and Roles: USERPERMISSIONS, USERROLE

These additional endpoints provide extensive support for more complex financial, HR, tax, and asset management tasks, allowing businesses to integrate Sage Intacct across diverse operations.

‍

Here’s a detailed reference to all the Sage Intacct API Endpoints.

‍

Sage Intacct API FAQs

‍

Here are the frequently asked questions about Sage Intacct APIs to help you get started:

‍

How do I verify/troubleshoot my API calls? Answer
Can I update a statistical journal entry via the API? Answer
Are there any volume limits around the Intacct API? Answer
Does Sage Intacct support Pagination? Answer
What return format should I use for best results when using readByQuery and readMore? Answer

Find more FAQs here.

‍

Get started with Sage Intacct API

‍

Sage Intacct API access is available for integration after a thorough internal review to ensure alignment with your business needs. However, if you’re looking to quickly connect with multiple HR, Accounting, CRM, and more integrations consider using Knit—a single API solution that integrates with all major HR platforms, simplifying your setup process.

‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Greenhouse API Directory

Greenhouse software is a leading applicant tracking system (ATS) and recruiting platform designed to enhance the recruitment process for organizations of all sizes. By offering a comprehensive suite of tools, Greenhouse streamlines the entire hiring workflow, from sourcing candidates to managing applications and coordinating interviews. This robust software empowers human resources and recruitment teams to collaborate effectively, ensuring a seamless and efficient hiring process. With its focus on data-driven decision-making, Greenhouse provides valuable insights through recruiting metrics, enabling organizations to optimize their recruitment strategies and improve overall hiring outcomes.

A key feature of Greenhouse is its ability to integrate seamlessly with other platforms through the Greenhouse API. This integration capability allows businesses to customize and extend the functionality of the software, ensuring it meets their unique recruitment needs. By leveraging the Greenhouse API, organizations can automate various aspects of the recruitment process, enhance data sharing across systems, and create a more cohesive and efficient hiring ecosystem. As a result, Greenhouse not only simplifies recruitment but also fosters a more strategic approach to talent acquisition.

Key Highlights of Greenhouse APIs

1. Easy Data Access:
- Facilitates seamless data flow into and out of the platform.
2. Custom Integration:
- Allows for tailored integrations to fit specific hiring workflows.
3. Real-Time Sync:
- Typically supports real-time data synchronization.
4. Strong Security:
- Implements security measures to protect data and ensure secure access.
5. Scalable:
- Designed to handle varying loads, suitable for different users and organizations.
6. Developer-Friendly:
- Accessible to developers with documentation and support.
7. Global Support:
- Accommodates international users and functions across regions.
8. Error Handling and Logging:
- Includes features for robust error handling.
9. Rate Limiting:
- Prevents abuse and ensures fair usage.
10. Version Control:
- Manages changes and updates without disrupting existing integrations.
11. Data Transformation:
- Allows manipulation of data formats as needed.
12. Webhook Support:
- Enables real-time notifications and updates.
13. Detailed Analytics and Reporting:
- Provides insights into hiring processes and data usage.
14. Sandbox Environment:
- Allows testing of integrations and features without affecting live data.

Greenhouse API Endpoints

General

POST https://api.example.com/greenhouse/test : Test Greenhouse API
POST https://api.example.com/v1/sample : Sample API

Applications

POST https://api.greenhouse.io/v1/applications/{application_id}/advance : Advance Application
GET https://harvest.greenhouse.io/v1/applications/{application_id}/offers : List Offers Associated with an Application
GET https://harvest.greenhouse.io/v1/applications/{application_id}/offers/current_offer : Fetch Current Offer for Application
GET https://harvest.greenhouse.io/v1/applications/{id} : Retrieve Application by ID
PATCH https://harvest.greenhouse.io/v1/applications/{id}/convert_prospect : Convert Prospect Application to Candidate
GET https://harvest.greenhouse.io/v1/applications/{id}/demographics/answers : List Demographic Answers for an Application
GET https://harvest.greenhouse.io/v1/applications/{id}/eeoc : Retrieve Application EEOC Data
POST https://harvest.greenhouse.io/v1/applications/{id}/hire : Hire Application
POST https://harvest.greenhouse.io/v1/applications/{id}/move : Move Application Between Stages
PATCH https://harvest.greenhouse.io/v1/applications/{id}/offers/current_offer : Update Current Offer on Application
POST https://harvest.greenhouse.io/v1/applications/{id}/reject : Reject Application
GET https://harvest.greenhouse.io/v1/applications/{id}/scheduled_interviews : Get Scheduled Interviews for an Application
GET https://harvest.greenhouse.io/v1/applications/{id}/scorecards : List All Submitted Scorecards for an Application
POST https://harvest.greenhouse.io/v1/applications/{id}/transfer_to_job : Transfer Application to Different Job Stage
POST https://harvest.greenhouse.io/v1/applications/{id}/unreject : Unreject Application

Approval Flows

GET https://harvest.greenhouse.io/v1/approval_flows/{id} : Retrieve Approval Flow
POST https://harvest.greenhouse.io/v1/approval_flows/{id}/request_approvals : Request Approval Flow Start

Approver Groups

PUT https://harvest.greenhouse.io/v1/approver_groups/{approver_group_id}/replace_approvers : Replace Approvers in Approver Group

Candidates

POST https://harvest.greenhouse.io/v1/candidates : Create a New Candidate
PUT https://harvest.greenhouse.io/v1/candidates/merge : Merge Two Candidates
DELETE https://harvest.greenhouse.io/v1/candidates/{candidate_id}/educations/{education_id} : Delete Education Record by Candidate and Education ID
DELETE https://harvest.greenhouse.io/v1/candidates/{candidate_id}/employments/{employment_id} : Delete Employment Record
PUT https://harvest.greenhouse.io/v1/candidates/{candidate_id}/tags/{tag_id} : Apply a Tag to a Candidate
DELETE https://harvest.greenhouse.io/v1/candidates/{id} : Delete Candidate by ID
POST https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed/emails : Create Candidate Email Note
POST https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed/notes : Create Candidate Note
PUT https://harvest.greenhouse.io/v1/candidates/{id}/anonymize?fields={field_names} : Anonymize Candidate Data
POST https://harvest.greenhouse.io/v1/candidates/{id}/attachments : Post Attachment to Candidate Profile
POST https://harvest.greenhouse.io/v1/candidates/{id}/educations : Create a New Education Record for a Candidate
POST https://harvest.greenhouse.io/v1/candidates/{id}/employments : Create a New Employment Record
GET https://harvest.greenhouse.io/v1/candidates/{id}/tags : Retrieve Candidate Tags

Close Reasons

GET https://harvest.greenhouse.io/v1/close_reasons : List Organization's Close Reasons

Custom Fields

GET https://harvest.greenhouse.io/v1/custom_field/{id} : Get Custom Field by ID
DELETE https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options : Destroy Custom Field Options
POST https://harvest.greenhouse.io/v1/custom_fields : Create Custom Fields in Greenhouse
GET https://harvest.greenhouse.io/v1/custom_fields/{field_type} : Get Custom Fields
DELETE https://harvest.greenhouse.io/v1/custom_fields/{id} : Delete Custom Field

Degrees

GET https://harvest.greenhouse.io/v1/degrees : Retrieve All Degree and Education Levels

Demographics

GET https://harvest.greenhouse.io/v1/demographics/answer_options : List Organization's Demographic Answer Options
GET https://harvest.greenhouse.io/v1/demographics/answer_options/{id} : Retrieve Demographic Answer Option by ID
GET https://harvest.greenhouse.io/v1/demographics/answers : List Organization's Demographic Answers
GET https://harvest.greenhouse.io/v1/demographics/answers/{id} : Retrieve Demographic Answer by ID
GET https://harvest.greenhouse.io/v1/demographics/question_sets : List Organization's Demographic Question Sets
GET https://harvest.greenhouse.io/v1/demographics/question_sets/{id} : Retrieve Demographic Question Set by ID
GET https://harvest.greenhouse.io/v1/demographics/question_sets/{id}/questions : List Demographic Questions for a Question Set
GET https://harvest.greenhouse.io/v1/demographics/questions : List Organization's Demographic Questions
GET https://harvest.greenhouse.io/v1/demographics/questions/{id} : Retrieve Demographic Question by ID
GET https://harvest.greenhouse.io/v1/demographics/questions/{id}/answer_options : List Demographic Answer Options

Departments

GET https://harvest.greenhouse.io/v1/departments : List Organization's Departments
PATCH https://harvest.greenhouse.io/v1/departments/{id} : Edit Department's Basic Information

Disciplines

GET https://harvest.greenhouse.io/v1/disciplines : List Organization's Disciplines

EEOC

GET https://harvest.greenhouse.io/v1/eeoc : List Organization's EEOC Data

Email Templates

GET https://harvest.greenhouse.io/v1/email_templates : List Organization's Email Templates
GET https://harvest.greenhouse.io/v1/email_templates/{id} : Retrieve Email Template by ID

Job Posts

GET https://harvest.greenhouse.io/v1/job_posts : List Organization's Job Posts
GET https://harvest.greenhouse.io/v1/job_posts/{id} : Get Single Job Post
GET https://harvest.greenhouse.io/v1/job_posts/{id}/custom_locations : List Custom Location Options for Job Post

Job Stages

GET https://harvest.greenhouse.io/v1/job_stages : List Organization's Job Stages
GET https://harvest.greenhouse.io/v1/job_stages/{id} : Retrieve Job Stage by ID

Jobs

GET https://harvest.greenhouse.io/v1/jobs : List Organization's Jobs
PATCH https://harvest.greenhouse.io/v1/jobs/{id} : Update Job Details
GET https://harvest.greenhouse.io/v1/jobs/{id}/approval_flows : List all of a job’s approval flows
GET https://harvest.greenhouse.io/v1/jobs/{id}/hiring_team : Get Hiring Team for a Job
GET https://harvest.greenhouse.io/v1/jobs/{id}/job_post : Retrieve Job Post by Job ID
GET https://harvest.greenhouse.io/v1/jobs/{id}/job_posts : List Job Posts for a Given Job ID
GET https://harvest.greenhouse.io/v1/jobs/{id}/stages : Retrieve Job Stages by Job ID
PUT https://harvest.greenhouse.io/v1/jobs/{job_id}/approval_flows : Create or Replace Approval Flow for a Job or Offer
POST https://harvest.greenhouse.io/v1/jobs/{job_id}/openings : Create Job Openings in Greenhouse
PATCH https://harvest.greenhouse.io/v1/jobs/{job_id}/openings/{id} : Update Job Opening Details

Offers

GET https://harvest.greenhouse.io/v1/offers : Get All Offers Made by an Organization
GET https://harvest.greenhouse.io/v1/offers/{id} : Retrieve Offer by ID

Offices

POST https://harvest.greenhouse.io/v1/offices : Create a New Office
PATCH https://harvest.greenhouse.io/v1/offices/{id} : Edit Office Basic Information

Prospect Pools

GET https://harvest.greenhouse.io/v1/prospect_pools : List Organization's Prospect Pools
GET https://harvest.greenhouse.io/v1/prospect_pools/{id} : Retrieve Prospect Pool

Prospects

POST https://harvest.greenhouse.io/v1/prospects : Create a New Prospect in Greenhouse

Rejection Reasons

GET https://harvest.greenhouse.io/v1/rejection_reasons : List Organization's Rejection Reasons

Scheduled Interviews

GET https://harvest.greenhouse.io/v1/scheduled_interviews : List Scheduled Interviews for an Organization
DELETE https://harvest.greenhouse.io/v1/scheduled_interviews/{id} : Delete a Scheduled Interview by ID
POST https://harvest.greenhouse.io/v2/scheduled_interviews : Create a New Scheduled Interview
PATCH https://harvest.greenhouse.io/v2/scheduled_interviews/{id} : Update a Scheduled Interview

Schools

GET https://harvest.greenhouse.io/v1/schools : List Organization's Schools

Scorecards

GET https://harvest.greenhouse.io/v1/scorecards : List Organization's Scorecards
GET https://harvest.greenhouse.io/v1/scorecards/{id} : Retrieve Scorecard

Sources

GET https://harvest.greenhouse.io/v1/sources : List Organization's Sources Grouped by Strategy

Tracking Links

GET https://harvest.greenhouse.io/v1/tracking_links/{token} : Retrieve Tracking Link Data

User Roles

GET https://harvest.greenhouse.io/v1/user_roles : List Organization's Roles for User Assignment

Users

POST https://harvest.greenhouse.io/v1/users : Create a New User with Basic Permissions
PATCH https://harvest.greenhouse.io/v1/users/permission_level : Change User Permission Level to Basic
GET https://harvest.greenhouse.io/v1/users/{id} : Retrieve User Details
POST https://harvest.greenhouse.io/v1/users/{id}/email_addresses : Create Unverified Email Address for User
DELETE https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs : Delete User's Future Job Permission
POST https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs : Create Job Permission for User
GET https://harvest.greenhouse.io/v1/users/{user_id}/pending_approvals : Get Pending Approvals for User
PATCH https://harvest.greenhouse.io/v2/users/ : Edit User's Basic Information
PATCH https://harvest.greenhouse.io/v2/users/disable : Disable a User
PATCH https://harvest.greenhouse.io/v2/users/enable : Enable a User in Greenhouse

Job Posts (v2)

PATCH https://harvest.greenhouse.io/v2/job_posts/{id} : Update Job Post Properties
PATCH https://harvest.greenhouse.io/v2/job_posts/{id}/status : Update Job Post Status

Jobs (v2)

DELETE https://harvest.greenhouse.io/v2/jobs/{job_id}/openings : Delete Job Openings

‍

Greenhouse API FAQs

How do I generate an API key in Greenhouse?

Answer: To generate an API key in Greenhouse:some text
1. Click the Configure icon on your navigation bar.
2. Navigate to Dev Center > API Credential Management.
3. Click Create New API Key.
4. Select the API type (e.g., Harvest) and provide a description.
5. Click Create and copy the generated API key to a secure location.
Source: Create a Harvest API key for an integration – Greenhouse Support

What authentication method does the Greenhouse API use?

Answer: The Greenhouse API uses HTTP Basic Authentication. The API key serves as the username, and the password should be left blank. Include the 'Authorization' header in your HTTP requests, formatted as 'Basic {Base64EncodedAPIKey:}'.
Source: Harvest API | Greenhouse - Greenhouse Software

Are there rate limits for the Greenhouse API?

Answer: Yes, Greenhouse enforces rate limits to ensure fair usage:some text
- Harvest API: 50 requests per 10 seconds.
- Exceeding the limit will return an HTTP 429 response.
Source: Harvest API | Greenhouse - Greenhouse Software

Can I retrieve candidate information using the Greenhouse API?

Answer: Yes, you can retrieve candidate information using the Harvest API. For example, to list all candidates, make a GET request to the /v1/candidates/ endpoint.
Source: Harvest API | Greenhouse - Greenhouse Software

Does the Greenhouse API support webhooks?

Answer: Yes, Greenhouse supports webhooks, allowing you to receive real-time notifications for specific events, such as candidate application submissions or status changes.
Source: Developer Resources | Greenhouse

‍

Get Started with Greenhouse API Integration

For quick and seamless integration with Greenhouse API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any Greenhouse API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to Greenhouse API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍

FingerCheck API Directory

FingerCheck is a comprehensive cloud-based software solution tailored to meet the needs of small to medium-sized businesses by simplifying and automating HR and payroll tasks. This innovative platform offers a suite of functionalities, including time tracking, payroll processing, and HR management, making it an indispensable tool for businesses looking to streamline their human resources and payroll operations. By leveraging FingerCheck, companies can efficiently manage employee data, ensure accurate payroll processing, and maintain compliance with labor regulations, all within a single, user-friendly interface.

One of the standout features of FingerCheck is its robust API integration capabilities. The FingerCheck API allows businesses to seamlessly integrate the software with their existing systems, enhancing operational efficiency and data accuracy. This integration process is designed to be straightforward, enabling businesses to customize their HR and payroll workflows to better suit their unique needs. As a result, the FingerCheck API not only facilitates smoother data exchange but also empowers businesses to optimize their HR and payroll processes, ultimately contributing to improved productivity and cost savings.

Key highlights of FingerCheck APIs

‍

The Fingercheck API provides developers with a comprehensive suite of tools to integrate and automate various human resources and payroll processes within their applications. Below are the key highlights of the Fingercheck API:

Core Functionalities:

Employee Management: Add, update, or remove employee records, facilitating seamless integration with your HR systems.
Payroll Processing: Automate salary calculations, tax deductions, and payments to streamline payroll operations.
Time and Attendance: Track employee work hours, manage schedules, and monitor attendance data efficiently.
Reports Generation: Retrieve various reports, including live status, schedules, absence requests, paid hours, payroll checks, and time card data.

Integration Use Cases:

Onboarding Automation: Streamline the onboarding process by integrating employee data into internal systems.
Payroll Synchronization: Ensure consistency between HR records and payroll systems by syncing employee and compensation data.
Custom Reporting: Generate tailored reports by extracting and analyzing HR data to meet specific business needs.

Supported Protocols:

RESTful API: The Fingercheck API follows REST principles, facilitating straightforward HTTP requests and responses.

Authentication Mechanisms:

API Key and Client Secret Key: Secure access is granted through a unique API key and a client secret key, which are required for authenticating API requests.

Rate Limiting Policies:

Usage Limits: While specific rate limits are not publicly detailed, it's advisable to implement efficient API call practices and handle potential rate limit responses gracefully.

For comprehensive information and to get started with the Fingercheck API, refer to their official API documentation.

FingerCheck API Endpoints

Pay On Demand

POST /AgreeToTermsEmployeeForPayOnDemand : Agree to Terms for Pay On Demand for Employee
POST /EnrollEmployeeForPayOnDemand : Enroll Employee For Pay On Demand
POST /api/employee/{employeeNumber}/payondemand/{approveDecline} : Approve or Decline an Employee Pay On-Demand Application
POST /v1/PayOnDemand/AddPayOnDemandTransactionRequest : Add Pay On Demand Transaction Request
GET /v1/PayOnDemand/GetEmployeePayOnDemandApplicationByEmployeeNumber/{employeeNumber} : Retrieve Employee Pay On-Demand Application by Employee Number
GET /v1/PayOnDemand/GetEmployeePayOnDemandTransactionByReferenceNumber/{referenceNumber} : Retrieve Pay On-Demand Transaction by Reference Number
GET /v1/PayOnDemand/GetEmployeePayOnDemandTransactionsByEmployeeNumber/{employeeNumber} : Retrieve Employee Pay On-Demand Transactions by Employee Number
POST /v1/PayOnDemand/UpdateEmployeePayOnDemandApplicationByEmployeeNumber/{employeeNumber} : Update Employee Pay On-Demand Application by Employee Number

Employee Management

DELETE /api/clock/deleteEmployee : Delete Employee From Clock
GET /api/employee/taxcodes : Auto Loads Employee Tax Codes
GET /api/employee/{employeeNumber} : Get Employee Details
DELETE /api/employees/{employeeNumber} : Delete Employee Data from the System
POST /api/employees/{employeeNumber}/sendToClocks : Send Employee to All Active Clocks
POST /api/sendEmployeeToClock : Send Employee to Clock
POST /api/sendInvite : Send Employee a Self Service Invite Email
POST /v1/Employees/AddEmployee : Add Employee Data to the System
POST /v1/Employees/AddEmployeeDeduction : Add Employee Deduction Information
POST /v1/Employees/AddEmployeeDirectDeposit : Add Employee Direct Deposit Information
POST /v1/Employees/AddEmployeePayRate : Add Employee Pay Rate Information
DELETE /v1/Employees/DeleteEmployeeDeductions : Delete Employee Deduction Information
DELETE /v1/Employees/DeleteEmployeeDirectDeposit : Delete Employee Direct Deposit Information
DELETE /v1/Employees/DeleteEmployeePayRate : Delete Employee Pay Rate
GET /v1/Employees/GetAllActiveEmployees : Retrieve All Active Employee Data
GET /v1/Employees/GetAllEmployees : Retrieve All Employee Data
GET /v1/Employees/GetClocksEnrolledByEmployeeNumber/{employeeNumber} : Get Clocks Enrolled By Employee Number
GET /v1/Employees/GetEmployeeByEmployeeNumber/{employeeNumber} : Get Employee by Employee Number
GET /v1/Employees/GetEmployeeClockInfoByEmployeeNumber/{employeeNumber} : Get Employee Clock Info By Employee Number
GET /v1/Employees/GetEmployeeDeductionsByEmployeeNumber/{employeeNumber} : Get Employee Deductions by Employee Number
GET /v1/Employees/GetEmployeeDirectDepositsByEmployeeNumber/{employeeNumber} : Retrieve Employee Direct Deposits by Employee Number
GET /v1/Employees/GetEmployeeLastPunchInfoByEmployeeNumber/{employeeNumber} : Get Employee Last Punch Info by Employee Number
GET /v1/Employees/GetEmployeePayRatesByEmployeeNumber/{employeeNumber} : Retrieve Employee Pay Rates by Employee Number
GET /v1/Employees/GetEmployeesByClockSerialNumber/{clockSerialNumber} : Retrieve Employee Data By Clock Serial Number
POST /v1/Employees/IssueFingercheckPayCard : Generate and Link Pay Card for Employee
POST /v1/Employees/SynchronizeEmployees : Synchronize Employee Data
POST /v1/Employees/UpdateEmployee : Update Employee Information
POST /v1/Employees/UpdateEmployeeClockInfo : Update Employee Clock Information
POST /v1/Employees/UpdateEmployeeDeduction : Update Employee Deduction Information
POST /v1/Employees/UpdateEmployeeDirectDeposit : Update Employee Direct Deposit Information
POST /v1/Employees/UpdateEmployeeForOnOnboarding : Onboard Employee to Payroll
POST /v1/Employees/UpdateEmployeePayRate : Update Employee Pay Rate

Applicant Tracking

POST /v1/ApplicantTracking/AddApplicantByApplicantJobID : Add Applicant by Job ID
GET /v1/ApplicantTracking/GetApplicantJobOpenings : Get Applicant Job Openings

Punch Management

POST /v1/Punch/AddPaidHour : Add Paid Hours to the System
POST /v1/Punch/AddPunch : Add Punch to the System
POST /v1/Punch/AddPunchs : Add Punches to the System
DELETE /v1/Punch/DeletePunch : Delete Punch from the System
POST /v1/Punch/EditPunch : Edit Punch in the System
GET /v1/Punch/GetClockPunchMetaDataListSampleObject : Retrieve Sample List Clock Meta Data Object
GET /v1/Punch/GetClockPunchMetaDataSampleObject : Retrieve a Sample Clock Meta Data Object
GET v1/Punch/GetPunchPhotoByPunchPhotoID : Get Punch Photo by Punch Photo ID

Reports

GET /v1/Reports/GetAllPayrollCheckDetailsForDateRange : Get All Payroll Check Details for a Specified Date Range
GET /v1/Reports/GetEmployeeActivePTOAccruals : Get Employee Active PTO Accruals
GET /v1/Reports/GetEmployeeActivePTOAccrualsByEmployeeNumber/{employeeNumber} : Get Employee Active PTO Accruals by Employee Number
GET /v1/Reports/GetEmployeePTOAccruals : Get Employee PTO Accruals
GET /v1/Reports/GetEmployeePTOAccrualsByEmployeeNumber/{employeeNumber} : Get Employee PTO Accruals by Employee Number
GET /v1/Reports/GetEmployeeRatesByStartDate : Get Employee Rates by Start Date
POST /v1/Reports/PostDownloadGeneralLedgerByCode : Download General Ledger Report by Code
GET https://developer.fingercheck.com/api/v1/Reports/GetAbsenceRequestsByDate : Get Absence Requests by Date Range
GET v1/Reports/GetAllAbsenceRequestsForDateRangeByEmployeeNumber : Get All Absence Requests for Date Range by Employee Number
GET v1/Reports/GetAllPaidHoursForDateRange : Get All Paid Hours for a Specified Date Range
GET v1/Reports/GetAllPaidHoursForDateRangeByEmployeeNumber : Get All Paid Hours for Date Range by Employee Number
GET v1/Reports/GetAllPayrollCheckDetailsForDateRangeByEmployeeNumber : Get All Payroll Check Details for Date Range by Employee Number
GET v1/Reports/GetAllPayrollChecksForDateRange : Get All Payroll Checks for a Specified Date Range
GET v1/Reports/GetAllPayrollChecksForDateRangeByEmployeeNumber : Get All Payroll Checks for Date Range by Employee Number
GET v1/Reports/GetAllTimeCardRawDataForDateRange : Get All Time Card Raw Data for Date Range
GET v1/Reports/GetAllTimeCardRawDataForDateRangeByEmployeeNumber : Get All Time Card Raw Data for Date Range by Employee Number
GET v1/Reports/GetAllTimeCardsForDateRange : Get All Time Cards for a Specified Date Range
GET v1/Reports/GetAllTimeCardsForDateRangeByEmployeeNumber : Get All Time Cards for Date Range by Employee Number
GET v1/Reports/GetEmployeeActiveRates : Get Employee Active Rates
GET v1/Reports/GetEmployeeActiveRatesByDatesByEmployeeNumber/{employeeNumber} : Get Employee Active Rates by Dates and Employee Number
GET v1/Reports/GetEmployeeRatesByStartDateByEmployeeNumber/{employeeNumber} : Get Employee Rates by Start Date and Employee Number
GET v1/Reports/GetExistingSchedulesByDate : Get Existing Schedules by Date Range
GET v1/Reports/GetLiveStatusByDate?date={date} : Get Live Status by Date
GET v1/Reports/GetSchedulesByDate : Get Schedules by Date Range

Schedule Management

DELETE /api/schedule/{timeClockScheduleID} : Delete an Employee Schedule
DELETE /v1/Schedule/DeleteTimeClockSchedules : Delete Employee Schedules
POST /v1/Schedule/SynchronizeEmployeeSchedule : Synchronize Employee Schedule Data

Synchronization

GET /v1/Sync/GetJobList : Retrieve a List of Jobs
GET /v1/Sync/GetLookupDataListSampleObject : Retrieve a Sample Lookup Meta Data Object
GET /v1/Sync/GetLookupDataSampleObject : Retrieve a Sample Lookup Entity Meta Data Object
POST /v1/Sync/SyncCostCenters?level={level} : Sync Cost Centers
POST /v1/Sync/SyncJobs : Sync Jobs to the System
GET v1/Sync/GetCostCenterList : Retrieve a List of Cost Centers by Level
POST v1/Sync/SyncAndUpdateCostCenters?level={level} : Sync and Update Cost Centers

Developer API

POST https://developer.fingercheck.com/api/v1/Employees/AddEmployee : Add Employee Data to the System
POST https://developer.fingercheck.com/api/v1/Employees/AddEmployeeDeduction : Add Employee Deduction Information
GET https://developer.fingercheck.com/api/v1/Employees/GetAllEmployees : Retrieve All Employee Data
GET https://developer.fingercheck.com/api/v1/Employees/GetEmployeeByEmployeeNumber/{employeeNumber} : Retrieve Employee Data by Employee Number
GET https://developer.fingercheck.com/api/v1/Employees/GetEmployeeDeductionsByEmployeeNumber/{employeeNumber} : Get Employee Deductions by Employee Number
GET https://developer.fingercheck.com/api/v1/Employees/GetEmployeeDirectDepositsByEmployeeNumber/{employeeNumber} : Retrieve Employee Direct Deposits by Employee Number
POST https://developer.fingercheck.com/api/v1/Employees/UpdateEmployee : Update Employee Information
POST https://developer.fingercheck.com/api/v1/Employees/UpdateEmployeeDeduction : Update Employee Deduction Information
POST https://developer.fingercheck.com/api/v1/Employees/UpdateEmployeeDirectDeposit : Update Employee Direct Deposit Information
POST https://developer.fingercheck.com/api/v1/Punch/AddPunch : Add Punch to the System

‍

FingerCheck API FAQs

How do I obtain API keys to access the FingerCheck API?

Answer: To access the FingerCheck API, you need two key headers
- APIKEY: A unique key issued to the programmer to access the API web service.
- ClientSecretKey: Generated on a per-company and per-user basis to define distinct access levels. To obtain these keys, sign in as an administrator to your FingerCheck account, click your profile avatar, select "Account & Preferences," and then click "Generate" in the API Key section.
  Fingercheck Developer

What authentication method does the FingerCheck API use?

Answer: The FingerCheck API uses a combination of an API key and a Client Secret Key for authentication. These keys must be included in the request headers of your API calls to authenticate and authorize access.
Fingercheck Developer

Are there rate limits for the FingerCheck API?

Answer: The official documentation does not specify explicit rate limits for the FingerCheck API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.

Can I retrieve employee data using the FingerCheck API?

Answer: Yes, the FingerCheck API provides endpoints to retrieve employee data. For example, you can use the GET v1/Reports/GetAllTimeCardsForDateRange endpoint to return all time cards for a specified date range.
Fingercheck Developer

Does the FingerCheck API support webhooks for real-time data updates?

Answer: As of the latest available information, the FingerCheck API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.

Get Started with FingerCheck API Integration

Knit API offers a convenient solution for quick and seamless integration with FingerCheck API. Our AI-powered integration platform allows you to build any FingerCheck API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to FingerCheck API.‍

To sign up for free, click here. To check the pricing, see our pricing page.

Apr 4, 2025

ADP API Endpoints and Directory

ADP API

ADP is an industry leader offering a comprehensive human capital management suite (HCM solutions), bringing together payroll, attendance, HR, time, insights, and other services under one roof. Overall, ADP offers a suite of APIs that developers can get access to via the ADP marketplace. The ADP marketplace contains two types of applications that developers can leverage based on their use case, i.e., Data Connector and End User Application. ADP APIs are designed using an event-based pattern for resource management. ADP provides RESTful APIs.

ADP API follows OpenID Connect and Open Authorization (OAuth) 2.0 flows for comprehensive security. For each of them, ADP provides access tokens, which are used for secure calls to protect ADP Web APIs. Essentially, an access token is a time-bound token, or credential, which can be used to access protected ADP Web APIs restricted to an access scope. Access tokens are provided to the application during the integration process as part of the OpenID Connect and OAuth 2.0 authentication and authorization flow.

Looking to dive deep into how ADP API works? Check our detailed ADP API Guide to learn more on ADP authentication, best practices and more.

ADP API Authentication

To access and interact with ADP's APIs and authenticate users via single sign-on (SSO), you'll need a Certificate Signing Request (CSR). Accessing ADP's web services requires both a private key and a corresponding Web Services (WS) Certificate. This certificate shares client information with ADP, while the private key verifies the client's authenticity.The WS Certificate can either be generated through an automated process (ideal for those building a marketplace application) or through a manual process (ideal for those building their own business application). To know more about each of these processes, click here.

ADP API Events and Endpoints

ADP API (ADP Workforce Now) uses the following endpoints to facilitate the flow of information and data across channels.

HR Events

Worker Name Changes

POST /events/hr/v1/worker.birth-name.change : This API updates a worker's birth name.
GET /events/hr/v1/worker.birth-name.change/meta : This API endpoint retrieves metadata for the 'worker.birth-name.change' event.
POST /events/hr/v1/worker.legal-name.change : This API allows a worker to change their legal name in a given context.
GET /events/hr/v1/worker.legal-name.change/meta : This API endpoint retrieves metadata for the worker legal name change event.
POST /events/hr/v1/worker.preferred-name.change : This API allows a worker to change their preferred name in a given context.
GET /events/hr/v1/worker.preferred-name.change/meta : This API endpoint retrieves metadata for the event of changing a worker's preferred name.

Worker Status Changes

POST /events/hr/v1/worker.marital-status.change : This API allows for changing a worker's marital status.
GET /events/hr/v1/worker.marital-status.change/meta : This API endpoint retrieves metadata for the event of a worker's marital status change.
POST /events/hr/v1/worker.military-classification.change : The Change Worker Military Classification API allows for updating a worker's military classification details.
GET /events/hr/v1/worker.military-classification.change/meta : This API endpoint retrieves the metadata for the worker military classification change event.
POST /events/hr/v1/worker.military-status.change : This API endpoint is used to change the military status of a worker.
GET /events/hr/v1/worker.military-status.change/meta : This API endpoint retrieves metadata for the worker military status change event.

Worker Address Changes

POST /events/hr/v1/worker.legal-address.add : This API allows a worker to add a legal address.
POST /events/hr/v1/worker.legal-address.change : The Worker Legal Address Change API allows for updating the legal address of a worker.
POST /events/hr/v1/worker.legal-address.remove : The Worker Legal Address Remove API allows for the removal of a worker's legal address.
POST /events/hr/v1/worker.personal-address.add : The Add Worker Personal Address API allows a worker to add their personal address information.
POST /events/hr/v1/worker.personal-address.change : The Worker Personal Address Change API allows for updating the personal address of a worker.
POST /events/hr/v1/worker.personal-address.remove : This API allows a worker to remove a personal address from their records.

Worker Communication Changes

POST /events/hr/v1/worker.business-communication.email.add : This API allows a worker to add a business email address.
POST /events/hr/v1/worker.business-communication.email.change : This API allows a worker to change their business email address.
POST /events/hr/v1/worker.business-communication.email.remove : This API allows a worker to remove their business email address.
POST /events/hr/v1/worker.business-communication.fax.add : This API allows a worker to add a business fax number.
POST /events/hr/v1/worker.business-communication.fax.change : This API allows a worker to change their business fax number.
POST /events/hr/v1/worker.business-communication.fax.remove : This API allows a worker to remove their business fax number.
POST /events/hr/v1/worker.business-communication.landline.add : The Add Worker Business Landline API allows a worker to add a business landline number to their profile.
POST /events/hr/v1/worker.business-communication.landline.change : This API allows a worker to change their business landline number.
POST /events/hr/v1/worker.business-communication.landline.remove : This API allows a worker to remove a business landline.
POST /events/hr/v1/worker.business-communication.mobile.add : This API allows a worker to add a business mobile telephone number.
POST /events/hr/v1/worker.business-communication.mobile.change : This API allows a worker to change their business mobile telephone number.
POST /events/hr/v1/worker.business-communication.mobile.remove : This API allows a worker to remove their business mobile telephone number.
POST /events/hr/v1/worker.business-communication.pager.add : This API allows a worker to add a business pager number.
POST /events/hr/v1/worker.business-communication.pager.change : This API allows a worker to change their business pager number.
POST /events/hr/v1/worker.business-communication.pager.remove : This API allows a worker to remove their business pager number.
POST /events/hr/v1/worker.personal-communication.email.add : This API allows a worker to add a personal email address.
POST /events/hr/v1/worker.personal-communication.email.change : This API allows a worker to change their personal email address.
POST /events/hr/v1/worker.personal-communication.email.remove : This API allows a worker to remove their personal email address.
POST /events/hr/v1/worker.personal-communication.fax.add : This API allows a worker to add a personal fax number.
POST /events/hr/v1/worker.personal-communication.fax.change : This API allows a worker to change their personal fax number.
POST /events/hr/v1/worker.personal-communication.fax.remove : This API allows a worker to remove their personal fax number.
POST /events/hr/v1/worker.personal-communication.landline.add : This API allows a worker to add a personal landline number.
POST /events/hr/v1/worker.personal-communication.landline.change : This API allows a worker to change their personal landline number.
POST /events/hr/v1/worker.personal-communication.landline.remove : This API allows a worker to remove their personal landline number.
POST /events/hr/v1/worker.personal-communication.mobile.add : This API allows a worker to add their personal mobile telephone number.
POST /events/hr/v1/worker.personal-communication.mobile.change : This API allows a worker to change their personal mobile telephone number.
POST /events/hr/v1/worker.personal-communication.mobile.remove : This API allows a worker to remove their personal mobile telephone number.
POST /events/hr/v1/worker.personal-communication.pager.add : This API allows a worker to add a personal pager number.
POST /events/hr/v1/worker.personal-communication.pager.change : This API allows a worker to change their personal pager number.
POST /events/hr/v1/worker.personal-communication.pager.remove : This API allows a worker to remove their personal pager number.
GET /events/hr/v1/worker.personal-communication.pager.remove/meta : This API retrieves the metadata for the event of removing a worker's personal communication pager.

Worker Photo Management

POST /events/hr/v1/worker.photo.remove : The Remove Worker Photo API is used to remove the photo metadata and file of a worker.
GET /events/hr/v1/worker.photo.remove/meta : This API endpoint retrieves metadata for the worker photo removal event.
POST /events/hr/v1/worker.photo.upload : The Upload Worker Photo API allows clients to upload a worker's corporate contact photo.
GET /events/hr/v1/worker.photo.upload/meta : The Get Worker Photo Upload Event Metadata API returns metadata related to the worker photo upload event.

Payroll Events

US Tax Profile Changes

POST /events/payroll/v1/us-tax-profile.federal-income-tax-instruction.change : This API allows users to change a US tax profile federal income tax instruction.
GET /events/payroll/v1/us-tax-profile.federal-income-tax-instruction.change/meta : This API endpoint retrieves metadata for changes in the US Federal Income Tax Instruction within a tax profile.
POST /events/payroll/v1/us-tax-profile.local-income-tax-instruction.add : This API allows the addition of a new US tax profile local income tax instruction.
GET /events/payroll/v1/us-tax-profile.local-income-tax-instruction.add/meta : This API endpoint retrieves metadata for the US Tax Profile Local Income Tax Instruction.
POST /events/payroll/v1/us-tax-profile.local-income-tax-instruction.change : This API allows changing a US tax profile's local income tax instruction.
GET /events/payroll/v1/us-tax-profile.local-income-tax-instruction.change/meta : This API endpoint retrieves metadata for the US Tax Profile Local Income Tax Instruction Change.
POST /events/payroll/v1/us-tax-profile.local-income-tax-instruction.remove : This API is used to remove an existing US tax profile local income tax instruction.
GET /events/payroll/v1/us-tax-profile.local-income-tax-instruction.remove/meta : This API endpoint returns metadata for the US Tax Profile Local Income Tax Instruction removal event.

Worker General Deduction Instructions

POST /events/payroll/v2/worker-general-deduction-instruction.change : The Change Worker General Deduction Instruction API allows users to modify the general deduction instructions for a worker in the payroll system.
GET /events/payroll/v2/worker-general-deduction-instruction.change/meta : This API endpoint retrieves metadata for the Worker General Deduction Instruction Change event.
POST /events/payroll/v2/worker-general-deduction-instruction.start : The Start Worker General Deduction Instruction API is used to initiate a general deduction instruction for a worker in the payroll system.
GET /events/payroll/v2/worker-general-deduction-instruction.start/meta : This API endpoint retrieves event metadata for the Worker General Deduction Instruction Start event.
POST /events/payroll/v2/worker-general-deduction-instruction.stop : The Stop Worker General Deduction Instruction API allows users to stop a general deduction instruction for a worker.
GET /events/payroll/v2/worker-general-deduction-instruction.stop/meta : This API endpoint retrieves metadata for the Worker General Deduction Instruction Stop event.

HCM Validation Tables

POST /hcm/v1/validation-tables/associate-work-locations : This API endpoint allows the addition of a new code to a validation table for associating work locations.
POST /hcm/v1/validation-tables/business-units : This API allows the addition of a new code to the Business Units validation table.
GET /hcm/v1/validation-tables/cost-centers : This API retrieves a list of cost centers from the validation table.
POST /hcm/v1/validation-tables/departments : This API allows the addition of a new department code and its details to a validation table.
POST /hcm/v1/validation-tables/jobs : This API allows the addition of new job title codes and their details to a validation table.
GET /hcm/v1/validation-tables/jobs/meta : This API retrieves meta information for jobs validation tables.
GET /hcm/v1/validation-tables/jobs/{item-id} : This API retrieves the details of a specific record in the validation table for jobs.
GET /hcm/v1/validation-tables/meta : This API endpoint retrieves meta information for validation tables.
GET /hcm/v1/validation-tables/person-custom-fields : This API retrieves a list of items in the Person Custom Fields validation table.
GET /hcm/v1/validation-tables/person-custom-fields/{item-id} : This API retrieves the details of a specific record in the Custom Fields - Person Custom Fields.
GET /hcm/v1/validation-tables/worker-custom-fields : The Get Worker Custom Fields API retrieves a list of items in the Worker Custom Fields validation table.
GET /hcm/v1/validation-tables/worker-custom-fields/{item-id} : This API retrieves the details of a specific record in the Custom Fields validation table.

HCM Onboarding

POST /hcm/v2/applicant.onboard : The Applicant Onboarding API is used to initiate the onboarding process for an applicant.
GET /hcm/v2/applicant.onboard/meta : The Get Applicant Onboarding Metadata API retrieves metadata information related to the applicant onboarding process.

Worker Profile

GET /hr/v2/workers/meta : The Get Worker Meta Information API retrieves meta information about workers.
GET /hr/v2/workers/{aoid} : The Get Worker Details API retrieves detailed information about a worker identified by the Associate OID (aoid).
GET /hr/v2/workers/{aoid}/worker-images/photo : This API retrieves a worker's profile picture using the GET method.
POST /hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/additional-remunerations : This API operation allows the creation of additional remunerations for a worker, such as bonuses or commissions.
GET /hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/additional-remunerations/meta : This API endpoint retrieves metadata for a worker's additional remuneration.
PUT /hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/base-remuneration : This API operation updates a worker's base remuneration details such as salary, hourly rate, daily rate, or pay period rate.
GET /hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/base-remuneration/meta : This API operation retrieves metadata about a worker's base remuneration update.
POST /hr/worker-profile/v1/workers/{aoid}/work-assignments/{assignment-id}/corporate-groups : This API endpoint allows the creation of a corporate group for a specific work assignment.

ADP API Use Cases

Easy to use, intuitive interface and highly customizable with efficient customer support
Access best-practice guides, HR forms, policies, and an employee handbook template
Automation of processes like onboarding, status change, offboarding
Providing employees access to to their pay, benefits and time information, offering true self service
Real time mobile phone access to important information like time off, benefits data, etc. with a mobile application
Tracking and monitoring of key metrics like labor costs, overtime, actual vs. scheduled hours, turnover rate for better HR services

Top Customers

Jelly Belly, gourmet jelly belly candies and confections manufacturer
Amazon, a vast Internet-based enterprise
The Boston Globe, an American daily newspaper
Dell Technologies, a provider of desktop personal computers, software, and peripherals
Sunstone Partners, a growth-oriented private equity firm

ADP API FAQs

Here is a comprehensive list of questions that can help you navigate ADP API for success:

How to obtain ADP API Client Secret for OAuth? Answer
How to get ADP API past SSL error? Answer
How to update ADP API Worker Information? Answer
How to get Powershell ADP API Token? Answer
How to Solve ADP API Connection Problem(Error : Status-58)? Answer
How to change a person's custom string using ADP's API? Answer
How to get access_token from ADP Api using rest? Answer
What is the latest API updated or released for ADP Workforce Now? Answer
What is the release plan for ADP Workforce Now APIs? Answer
What are latest API updated or released for RUN Powered by ADP? Answer
What APIs will be released or enhanced for RUN Powered by ADP soon? Answer
How to integrate ADP employee data in Wordpress? Answer
How to read properties from an ADP project by C#? Answer

Common Integrations with ADP API

While there can be multiple integrations and use cases for ADP API, here is a list of the top SaaS companies or products that can integrate with ADP API to facilitate customer success:

Learning Management Solutions
Rewards, Recognitions, and Performance
Communication and Collaborations
Employee Travel and Booking Tools
Workforce Planning and Org Chart Solutions

How to integrate with ADP API

Here is a comprehensive resource for anyone who wishes to integrate with ADP API and streamline and optimize their HR and allied operations.

Get started with ADP API

The pricing for ADP API is not publicly available. However, the platform does offer a demo for interested customers. At the same time, ADP provides tailor-made pricing based on specific company requirements. Thus companies can share the required information to get access to competitive pricing, across different tiers based on the features they need. You can request pricing here.

To make the integration process smooth with ADP, you can get started with Knit, one API for all your integrations. Sign up with Knit or book a demo here with one of our experts - Book Demo

‍

Apr 4, 2025

Workday API Directory

This guide is part of our growing collection on HRIS integrations. We’re continuously exploring new apps and updating our HRIS Guides Directory with fresh insights

Founded in 2005, Workday is a leading provider of financial, HR and planning software. It facilitates financial management, human capital management and analytics management for companies, students/ educational institutions and government agencies. They provide solutions across analytics and reporting, payroll, workforce management, spend management, talent management, professional services automation.

Looking to dive deep into how Workday API works? Check our detailed Workday API Guide to learn more on Workday authentication, best practices and more.

Below you will find a comprehensive directory of Workday API endpoints.

Workday API endpoints

While there are several Workday API endpoints, some of the top ones include:

Absence management

GET /balances/{ID}
GET /workers/{ID}/eligibleAbsenceTypes
GET /workers/{ID}/leavesOfAbsence/{subresourceID}
POST /workers/{ID}/requestTimeOff
GET /workers/{ID}/validTimeOffDates
GET /values/leave/status/
GET /values/timeOff/status/

Compensation

GET /scorecardResults
GET /scorecards/{ID}
POST /workers/{ID}/requestOneTimePayment

Payroll

GET /jobs/{ID}/payGroup
GET /payGroupDetails/{ID}
POST /taxRates
GET /values/payrollInputsGroup/payComponents/

Performance management

GET /feedbackBadges/{ID}

Recruitment

GET /interviews
GET /interviews/{ID}/feedback
GET /jobPostings/{ID}
GET /prospects/{ID}/educations
POST /prospects/{ID}/experiences
GET /prospects/{ID}/resumeAttachments
GET /prospects/{ID}/skills
GET /values/common/countries/

Time tracking

POST /timeClockEvents
GET /timeValidations
GET /workerTimeBlocks/{ID}
POST /workers/{ID}/timeReviewEvents

Talent management

POST /createMentorshipForMe
POST /createMentorshipForWorker
POST /mentorships/{ID}/close
POST /mentorships/{ID}/edit

‍

Here’s a detailed guide on all Workday API endpoints as a ready reference.

Workday API use cases

Financial management with accounting and finance, revenue management, grants management, analytics and reporting, audit and internal controls
Human capital management via payroll and workforce management, talent, help, knowledge, and case management, workforce planning
Adaptive ERP to automate and streamline plans, budgets, and forecasts and align headcount, sales, and operational plans
Employee voice to collect and analyze feedback, with insights on employee experience to drives organizational success with AI
Spend management with sourcing project intake, pipeline management, contract management, supplier onboarding and performance management

Workday API FAQs

Check out the top FAQs for Workday API to help you get started

Is a Workday WID a UUID? Answer
How to authenticate Workday SOAP API? Answer
How to receive real time notifications for my Workday? Answer
How to get a Workday worker / employee web profile URL? Answer
How to authenticate Spring SOAP to Workday? Answer
How to edit worker additional data using Workday API? Answer
How to create XSLT process Workday report - XML to JSON output - method="json" <xsl:output method="json" />? Answer
How to create a calculated Field in Workday with multiple conditions? Answer

Get started with Workday API

Workday doesn’t offer its pricing publicly and you can get in touch with their team for the same. However, if you are looking to integrate with multiple HRMS or Recruitment APIs in the shortest time, you can get started with Knit, one API for all top HR integrations.

To sign up for free, click here. To check the pricing, see our pricing page‍

Mar 22, 2025

Oracle HCM API Directory

Oracle Fusion Cloud HCM API Directory

Oracle Fusion Cloud HCM is a cloud-based human resource solution provider which seeks to connect every aspect of the human resources process. It seeks to help enterprises with critical HR functions including, recruiting, training, payroll, compensation, and performance management to drive engagement, productivity, and business value. As a market leader, it allows developers to use Oracle REST APIs to access, view and manage data stored in Oracle Fusion Cloud HCM

Oracle Fusion Cloud HCM API Authorization

Oracle Fusion Cloud HCM API uses authorization to define which users can access the API and relevant information. To get this access, users need to have predefined roles and the necessary security privileges. Oracle’s REST APIs are secured by function and aggregate security privileges, delivered through job roles which are predefined. However, users can also create custom roles to provide access. Authorization and access to Oracle Fusion Cloud HCM API depends on the role of a person and the level of access offered.

Oracle Fusion Cloud HCM API Objects, Data Models & Endpoints

To get started with Oracle Fusion Cloud HCM API, it is important to understand the end points, data models and objects and make them a part of your vocabulary for seamless access and data management.

Application Management

POST https://<hostname>.com/odata/v2/upsert : The Update Application Stage API allows users to update the stage of a specific application by providing the application ID and the target stage ID. The request requires an Authorization header with a Bearer token unless accessed through knit. The response includes the status of the update operation, a message indicating success, and the HTTP status code.

Employee Information

GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/absences : The 'Get leave requests of an employee' API retrieves the leave requests for a specific employee. It requires an Authorization header for Basic Authentication unless accessed through knit. The API accepts optional query parameters 'offset' and 'limit' to paginate the results. The response includes a list of leave requests with detailed information such as absence type, status, duration, and associated metadata. The response body contains an array of leave request items, each with attributes like absenceTypeId, approvalStatusCd, startDate, endDate, and more, providing comprehensive details about each leave request.
GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/benefitEnrollments : This API retrieves the benefit enrollments of a specific employee identified by the personId. It requires an Authorization header for Basic Authentication. The API supports pagination through the offset and limit query parameters. The response includes details such as EnrollmentResultId, PersonId, ProgramId, PlanTypeId, PlanId, OptionId, PersonName, and various dates related to the enrollment coverage. The response also indicates if there are more items to fetch with the hasMore flag.
GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/documentRecords : The 'Get documents of an employee' API retrieves document records associated with an employee. It requires a Basic Authorization header unless accessed through knit. The API supports query parameters 'offset' and 'limit' to paginate results. The response includes detailed information about each document, such as document type, person details, and creation metadata. The response body contains an array of document records, each with attributes like 'DocumentsOfRecordId', 'DocumentType', 'PersonId', and more. The API also indicates if more records are available with the 'hasMore' flag.
GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/locations : This API retrieves all locations associated with an employee. It requires an Authorization header for Basic Authentication, unless accessed through knit. The API supports query parameters 'offset' and 'limit' to paginate through the results. The response includes a list of location objects with details such as LocationId, SetId, ActiveStatus, and various flags indicating the type of site. Additional information like address details, effective dates, and creation/update timestamps are also provided.
GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/salaries : The 'Get compensation information of an employee' API retrieves detailed salary information for a specified employee. The API requires an Authorization header for Basic Authentication, unless accessed through knit. It accepts optional query parameters 'offset' and 'limit' to paginate the results. The response includes a list of salary details such as AssignmentId, SalaryId, SalaryAmount, CurrencyCode, and more, along with metadata like count, hasMore, limit, and offset. The API provides comprehensive salary data including frequency, basis, and range details, as well as action and person-related information.
GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/workers : The 'List all employees' API retrieves a list of employees from the specified server URL. It requires an Authorization header with a Bearer token unless accessed through knit. The API supports optional query parameters 'offset' and 'limit' to paginate the results. The response includes a list of employee objects with details such as PersonId, PersonNumber, and metadata like CreatedBy and LastUpdateDate. The response also contains links for navigation and indicates if more employees are available with the 'hasMore' field.
GET https://{{server_url}}/hcmRestApi/resources/{resource_id}1.13.18.05/workers/{{workersUniqID}}/child/nationalIdentifiers : This API retrieves the identification information of an employee using their unique worker ID. The request requires an Authorization header for Basic Auth, unless accessed through knit. The API accepts optional query parameters 'offset' and 'limit' to paginate the results. The response includes a list of national identifiers with details such as NationalIdentifierId, LegislationCode, NationalIdentifierType, and more. The response also indicates if there are more items to fetch with 'hasMore'.
GET {{base_url}}/workers : The 'List Details of All Employees' API retrieves detailed information about all employees. It requires an Authorization header with Basic authentication credentials. The API supports an optional query parameter 'expand' to specify which related fields to include in the response, such as addresses, emails, legislative information, phones, names, work relationships, and more. The response includes a success flag, a message containing headers and a body with detailed employee information, including personal details, addresses, emails, legislative info, names, national identifiers, phones, photos, and work relationships. The response also includes pagination details like count, hasMore, limit, and offset.

Check out this detailed guide for all endpoints and data models

Oracle Fusion Cloud HCM API Use Cases

Seamless end-to-end HR process management including, hiring, onboarding, managing, and engaging workforce aligned with global compliances
Flexible programs to meet specific benefit requirements and the option to calculate and manage benefit plans for each employee group
Predictive analytics for workflow planning based on risk of leaving, managing team performance and retaining your best performers.
Advanced reporting helping teams create, manage, and visualize data from Microsoft Excel within Oracle HCM
Secure, self-service, mobile-responsive options for employees to manage personal data, PTO, payslips, and more

Top customers

12,000+ companies use Oracle Fusion Cloud HCM as their preferred HR tool, including:

ArcelorMittal S.A., a Luxembourg-based multinational steel manufacturing corporation
The Deutsche Bahn AG, the national railway company of Germany
Fujifilm Holdings Corporation, a Japanese company operating in photography, optics, office and medical electronics, biotechnology, and chemicals
Hormel Foods Corporation, an American food processing company
Sofigate, a leading business technology transformation company in the Nordics

Oracle Fusion Cloud HCM API FAQs

To better prepare for your integration journey with Oracle Fusion Cloud HCM API, here is a list of FAQs you should go through:

How to properly paginate in the API for Oracle Fusion Cloud HCM? Answer
What to do when Oracle Fusion HCM cannot get data from Rest api /workers? Answer
How to GET Employee Absences data from HCM Fusion by sending two dates in REST API query parameter? Answer
How to include multiple query parameters in HCM cloud rest Get call? Answer
How to get Workers by HireDate in Oracle HCM Cloud API? Answer
How to pull the latest record when there are multiple records with different dates in Oracle HCM? Answer
How to use SQL Developer with BIPublisher Oracle Cloud HCM? Answer
How do I get previous data with respect to effective date in Oracle HCM cloud reporting in a separate column? Answer
What applications that Integrate with Oracle's PeopleSoft Enterprise Human Capital Management? Answer
Where are Oracle Fusion Assets REST APIs? Answer

How to integrate with Oracle Fusion Cloud HCM API

To integrate with Oracle Fusion Cloud HCM API, ensure that you review the basics and have an understanding of REST APIs. Then get your Fusion Applications Account Info, including username and password. Configure your client, authorize and authenticate and then send an HTTP request and you’re all set to go. For a more detailed understanding of the best practices and a step-by-step guide to integrate with Oracle Fusion Cloud HCM API, check out this comprehensive guide.

Get started with Oracle Fusion Cloud HCM API

While integrating with Oracle Fusion Cloud HCM API can help businesses seamlessly view, access and manage all HR data, the process of integration can be tricky. Right from building the integration in-house which requires API knowledge, developer bandwidth and much more to managing the integrations, there are several steps in the way. Naturally, the entire integration lifecycle can turn out to be quite expensive as well. Fortunately, companies today can leverage and integrate with a unified HRIS API like Knit, which allows them to connect with multiple HRIS applications, without the need to integrate with each one individually. Connect for a discovery call today to understand how you can connect with Oracle Fusion Cloud HCM API and several other HRIS applications faster and in a cost-effective manner.

To get started with Knit for Oracle HCM or any other integrations setup a demo here

‍

Quickbooks Online API Directory

QuickBooks is an easy-to-use accounting software that helps small and medium-sized businesses manage their finances. It offers tools for invoicing, tracking expenses, handling payroll, and preparing taxes, all in one place.

‍

With QuickBooks Online APIs, whether you’re launching a new business or have been running one for years, managing your finances becomes easier and more efficient.

‍

Key highlights of QuickBooks Online APIs:

Easy Data Access: Helps to connect and access your financial data like transactions, invoices, and reports easily with other apps.

Automation: Let’s you automate tasks like invoicing and expense tracking to save time and reduce errors.

Custom Integration: You can easily integrate QuickBooks with other tools and create custom solutions to fit your business needs.

Real-Time Sync: It helps you keep your data up-to-date across platforms with real-time synchronization.

Strong Security: It helps you protect your financial data with secure authentication and authorization.

Scalable: As your business grows, QuickBooks APIs can handle more transactions and complexity.

Developer-Friendly: Clear documentation and support make it easier for developers to work with the APIs.

Global Support: Works with different currencies, tax systems, and languages, making it great for businesses around the world.

While we have covered the Quickbooks Online API in depth earlier, in this article, we'll provide an overview of the QuickBooks Online API endpoints.

‍

QuickBooks Online API Endpoints

While there are several QuickBooks Online API endpoints, here are the most commonly used ones:

Customer Endpoint (/customer)some text
- /customer/{customer_id}/balance: Retrieve the current balance of a specific customer.
- /customer/{customer_id}/creditmemo: Manage credit memos associated with a customer.
- /customer/{customer_id}/estimate: Handle estimates or quotes for a customer.
Invoice Endpoint (/invoice)some text
- /invoice/{invoice_id}/send: Send an invoice to a customer via email.
- /invoice/{invoice_id}/payment: Retrieve payment details associated with a specific invoice.
- /invoice/{invoice_id}/refundreceipt: Create or manage refund receipts for a specific invoice.
Payment Endpoint (/payment)some text
- /payment/{payment_id}/apply: Apply a payment to specific invoices or other transactions.
- /payment/{payment_id}/unapplied: Retrieve payments that have not yet been applied to invoices.
Sales Receipt Endpoint (/salesreceipt)some text
- /salesreceipt/{salesreceipt_id}/email: Send a sales receipt to a customer via email.
- /salesreceipt/{salesreceipt_id}/payment: Retrieve payment details related to a sales receipt.
Bill Endpoint (/bill)some text
- /bill/{bill_id}/payment: Manage payments made against a specific bill.
- /bill/{bill_id}/attachment: Attach documents, such as receipts, to a bill.
Vendor Endpoint (/vendor)some text
- /vendor/{vendor_id}/purchaseorder: Manage purchase orders associated with a vendor.
- /vendor/{vendor_id}/bill: Retrieve bills linked to a specific vendor.
Expense Endpoint (/purchase)some text
- /purchase/{purchase_id}/receipt: Attach and manage receipts related to a specific purchase.
- /purchase/{purchase_id}/payment: Manage payments made for specific purchases.
Account Endpoint (/account)some text
- /account/{account_id}/balance: Retrieve the current balance for a specific account.
- /account/{account_id}/transaction: List transactions associated with a specific account.
Item Endpoint (/item)some text
- /item/{item_id}/inventory: Manage inventory levels for a specific item.
- /item/{item_id}/sales: Track sales associated with a particular item.
Journal Entry Endpoint (/journalentry)some text
- /journalentry/{journalentry_id}/line: Manage individual line items within a journal entry.
- /journalentry/{journalentry_id}/reversal: Reverse a journal entry if needed.
Employee Endpoint (/employee)some text
- /employee/{employee_id}/payroll: Manage payroll details and history for a specific employee.
- /employee/{employee_id}/timeactivity: Retrieve time activities logged by a particular employee.
Time Activity Endpoint (/timeactivity)some text
- /timeactivity/{timeactivity_id}/approve: Approve time entries submitted by employees or contractors.
- /timeactivity/{timeactivity_id}/project: Associate time activities with specific projects or jobs.
Company Info Endpoint (/companyinfo)some text
- /companyinfo/preferences: Retrieve or update company-level preferences, such as tax settings or currency.
- /companyinfo/financialyear: Get details about the company's financial year, including start and end dates.

These endpoints offer more granular control and functionality, allowing developers to build more customized and detailed integrations with QuickBooks.

Here’s a detailed reference to all the QuickBooks Online APIs.

‍

QuickBooks Online APIs FAQs

Here are the frequently asked questions about QuickBooks Online APIs to help you get started:

How to integrate QuickBooks into a PHP codebase? Answer
Tracking Shopify Refunds as Payments in QuickBooks Online Answer
How to add custom tax to invoice? Answer
Is it possible to use intuit quickbooks online API without creating an app Answer
How do I link payments to invoices using the API Explorer? Answer

‍

Get started with QuickBooks Online API

QuickBooks Online API access is available only for enterprise and developer tier accounts. If you're looking to integrate with various HRMS or recruitment APIs easily, consider using Knit. Knit offers a single API for connecting with all major HR integrations.

‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Adobe Acrobat Sign API Directory

Adobe Sign, introduced in 2006 as part of Adobe's comprehensive suite of document management solutions, has transformed the way businesses handle electronic signatures and document workflows.

‍

With Adobe Sign APIs, developers can access powerful tools that enable seamless integration of e-signature capabilities into their applications, providing a secure and efficient way to manage digital transactions.

‍

Key highlights of Adobe Sign APIs are as follows:

Comprehensive Document Management: It automates the entire document lifecycle, from creation and distribution to signing and archiving.

Real-time Tracking and Notifications: It helps to monitor the status of documents in real time, receiving instant updates on signatory actions.

Robust Security and Compliance: It ensures that all electronic signatures are legally binding and compliant with industry standards such as GDPR, eIDAS, and HIPAA.

Seamless Integration: It is easy to integrate with popular platforms like Microsoft Office 365, Salesforce, and other CRM and ERP systems, enhancing productivity and collaboration.

Customizable Workflows: It helps to tailor the signing process to fit specific business needs, incorporating custom branding and user experiences.

In this article, we'll provide an overview of the Adobe Sign API endpoints.

‍

Adobe Sign API Endpoints

While there are several Adobe Sign API endpoints, here are the most commonly used ones in the latest version:

Transient Documents

These endpoints are used to upload a document, get its document ID, and get the requested views for that document.

POST /transientDocuments
POST /transientDocuments/{transientDocumentId}/views

Agreements

These are used to create, send, and manage agreements and documents for e-signature.

POST /agreements
POST /agreements/{agreementId}/members/participantSets/{participantSetId}/delegatedParticipantSets
POST /agreements/{agreementId}/members/share
POST /agreements/{agreementId}/reminders
GET /agreements
GET /agreements/{agreementId}
GET /agreements/{agreementId}/auditTrail
GET /agreements/{agreementId}/documents
GET /agreements/{agreementId}/reminders
GET /agreements/{agreementId}/members
GET /agreements/{agreementId}/members/participantSets/{participantSetId}
GET /agreements/{agreementId}/shares
PUT /agreements/{agreementId}/me/visibility
PUT /agreements/{agreementId}/members/participantSets/{participantSetId}
DELETE /agreements/{agreementId}/documents
DELETE /agreements/{agreementId}/shares

‍

Users

These are used to manage user accounts, permissions, and roles within the Adobe Sign system.

POST /users
POST /users/{userId}/views
GET /users
GET /users/{userId}
GET /users/{userId}/events
PUT /users/{userId}
PUT /users/{userId}/locale
PUT /users/{userId}/state

‍

Library Documents

These help to create and manage template documents that can be reused for multiple agreements.

POST /libraryDocumentsCreates
POST /libraryDocuments/{libraryDocumentId}/views
GET /libraryDocuments
GET /libraryDocuments/{libraryDocumentId}
GET /libraryDocuments/{libraryDocumentId}/auditTrail
GET /libraryDocuments/{libraryDocumentId}/events
GET /libraryDocuments/{libraryDocumentId}/members
PUT /libraryDocuments/{libraryDocumentId}

‍

Search

This API helps to retrieve, search, filter, and sort agreements for the user.

POST /search

‍

Workflows

These APIs help to automate and manage multi-step signing processes and workflows.

GET /workflows
GET /workflows/{workflowId}

‍

MessageTemplates

These APIs help to retrieve a list of message templates applicable to the current user.

GET /messageTemplates

‍

MegaSigns

These APIs help to send a single document to multiple recipients for individual signatures.

POST /megaSigns
POST /megaSigns/{megaSignId}/members/share
POST /megaSigns/{megaSignId}/reminders
POST /megaSigns/{megaSignId}/views
GET /megaSigns
GET /megaSigns/{megaSignId}
GET /megaSigns/{megaSignId}/agreements
GET /megaSigns/{megaSignId}/documents
GET /megaSigns/{megaSignId}/documents/imageUrls
GET /megaSigns/{megaSignId}/documents/{documentId}
GET /megaSigns/{megaSignId}/events
GET /megaSigns/{megaSignId}/members
GET /megaSigns/{megaSignId}/reminders
GET /megaSigns/{megaSignId}/reminders/{reminderId}
PUT /megaSigns/{megaSignId}

‍

Webhooks

These APIs help to create and manage webhooks.

POST /webhooks
GET /webhooks
GET /webhooks/{webhookId}
PUT /webhooks/{webhookId}
PUT /webhooks/{webhookId}/state
DELETE /webhooks/{webhookId}

Here’s a detailed reference to all the Adobe Sign APIs.

‍

Adobe Sign API FAQs

Here are the frequently asked questions about Adobe Sign APIs to help you get started:

How to customize Signature fields in Document using adobe sign API? Answer
How to create a widget with pre-filling details? Answer
Adobe Sign access token invalid_request Answer
Attached pdf in the email is base64 encoded and does not show the actual PDF Answer
Adobe Sign API password protection not working Answer

‍

Get started with Adobe Sign API

Adobe Sign API access is reserved exclusively for enterprise and developer tier accounts. However, if you want to integrate with multiple HRMS or Recruitment APIs quickly, you can get started with Knit, one API for all top HR integrations.

To sign up for free, click here. To check the pricing, see our pricing page.

Find more FAQs here.

‍

Pandadoc API Directory

PandaDoc is a simple platform for creating, sending, and signing documents like contracts and quotes. It helps businesses reduce paperwork, save time, and work more smoothly with templates and eSignatures.

‍

PandaDoc also provides APIs that let companies integrate its features into their own apps, automating document creation, managing templates, and handling eSignatures easily. This is especially useful for businesses that need to scale or customize their document processes. In this article, we will provide an overview of the Pandadoc API endpoints.

‍

Key features of PandaDoc APIs include:

Document Automation: They help to easily create and send documents programmatically, reducing manual tasks.
Template Management: They help to access and manage templates directly from your app or system.
eSignature Integration: They can be used to seamlessly add legally binding eSignatures to documents.
Real-time Tracking: They can be used to monitor document status with real-time notifications and updates.
Customizable Workflows: They help to tailor document workflows to fit your business needs.
CRM Integration: They can help you connect with popular tools like Salesforce, HubSpot, and others for smooth data flow.
Webhooks: They can also be used to get event notifications for document updates, status changes, and more.

These features allow businesses to automate and streamline their document processes effectively.

‍

Pandadoc API Endpoints

Here are the most commonly used Pandadoc API endpoints -

Documents

GET https://api.pandadoc.com/public/v1/documents
POST https://api.pandadoc.com/public/v1/documents
GET https://api.pandadoc.com/public/v1/documents/{id}
DELETE https://api.pandadoc.com/public/v1/documents/{id}
POST https://api.pandadoc.com/public/v1/documents/{id}/send
POST https://api.pandadoc.com/public/v1/documents/{id}/transfer-ownership
POST https://api.pandadoc.com/public/v1/documents/{id}/attachments

Templates

GET https://api.pandadoc.com/public/v1/templates
GET https://api.pandadoc.com/public/v1/templates/{id}
POST https://api.pandadoc.com/public/v1/templates
DELETE https://api.pandadoc.com/public/v1/templates/{id}

Folders

GET https://api.pandadoc.com/public/v1/folders
POST https://api.pandadoc.com/public/v1/folders
GET https://api.pandadoc.com/public/v1/folders/{id}
PATCH https://api.pandadoc.com/public/v1/folders/{id}

Webhooks

POST https://api.pandadoc.com/public/v1/webhooks
DELETE https://api.pandadoc.com/public/v1/webhooks/{id}

Contacts

GET https://api.pandadoc.com/public/v1/contacts
POST https://api.pandadoc.com/public/v1/contacts
GET https://api.pandadoc.com/public/v1/contacts/{id}
PATCH https://api.pandadoc.com/public/v1/contacts/{id}
DELETE https://api.pandadoc.com/public/v1/contacts/{id}

Users

GET https://api.pandadoc.com/public/v1/users
GET https://api.pandadoc.com/public/v1/users/{id}

Here’s a detailed reference to all the Pandadoc APIs.

‍

Pandadoc API FAQs

Here are the frequently asked questions about Pandadoc APIs to help you get started:

What is the limit of PandaDoc? Answer
How to getthe API key in PandaDoc? Answer
How many documents can I send with PandaDoc? Answer
Is PandaDoc legally binding? Answer
Can you send multiple documents in PandaDoc? Answer

Find more FAQs here.

‍

Get started with Pandadoc API

Pandadoc API is available for free testing in a sandbox environment and later has to be upgraded to an enterprise account for use in production. However, if you want to integrate with multiple e-signature APIs quickly, you can get started with Knit, one API for all top integrations.

‍

To sign up for free, click here. To check the pricing, see our pricing page.

UKG Pro API Directory

UKG Pro is a human capital management (HCM) solution that simplifies payroll, HR, talent management, and employee engagement. With an easy-to-use interface, it helps businesses manage their workforce efficiently and boost productivity.

‍

UKG Pro APIs allow developers to integrate its HR, payroll, and management features into custom applications. These APIs provide access to employee data, payroll, and more, enabling businesses to build tailored solutions, improve workflows, and create a connected HR system.

‍

Key highlights of UKG Pro APIs are as follows -

‍

Comprehensive Data Access: They provide seamless access to employee data, payroll, time management, and HR information.

‍

Custom Integrations: They enable the integration of UKG Pro features into custom applications for tailored solutions.

‍

Automation and Efficiency: They help to streamline workflows by automating HR processes like payroll and employee management.

‍

Real-Time Data: They provide real-time access to information, ensuring up-to-date data for decision-making.

‍

Secure and Scalable: They are built with robust security and scalability to support growing business needs.

‍

Developer-Friendly: They offer clear documentation and flexible endpoints to simplify development.

‍

This article will provide an overview of the UKG Pro API endpoints. These endpoints enable businesses to build custom solutions, automate workflows, and streamline HR operations.

‍

UKG Pro API Endpoints

‍

Here are the most commonly used API endpoints in the latest version -

‍

Company Details

GET /configuration/v1/company-details

‍

Compensation Details

GET /personnel/v1/compensation-details
GET /personnel/v1/companies/{companyId}/compensation-details
GET /personnel/v1/companies/{companyId}/employees/{employeeId}/compensation-details
GET /personnel/v1/compensation-details/{employeeId}

‍

Employee Deductions

GET /personnel/v1/emp-deductions

‍

Employee Change

GET /personnel/v1/employee-changes
GET /personnel/v1/employee-changes/{employeeId}

‍

Employee Contact Details

GET /personnel/v1/contacts
GET /personnel/v1/contacts/{contactId}

‍

Employee Contract Details

GET /personnel/v1/employee-contract-details

‍

Employee Demographic Details

GET /personnel/v1/employee-demographic-details

‍

Employee Education Details

GET /personnel/v1/employee-education

‍

Employee Employment Details

GET /personnel/v1/employee-employment-details

‍

Employee Job History Details

GET /personnel/v1/employee-job-history-details
GET /personnel/v1/employee-job-history-details/{systemId}

‍

Employee ID Lookup

POST /personnel/v1/employee-ids

‍

Employee Pay Statement

POST /payroll/v1/companies/pay-statements-summary
POST /payroll/v1/companies/pay-statements
POST /payroll/v1/employees/pay-statements
POST /payroll/v1/employees/pay-statement/last
POST /payroll/v1/employees/pay-statement/{PayIdentifier}

‍

Employment Details

GET /personnel/v1/employment-details
GET /personnel/v1/companies/{companyId}/employment-details
GET /personnel/v1/companies/{companyId}/employees/{employeeId}/employment-details

‍

Jobs Configuration

/configuration/v1/jobgroup
/configuration/v1/jobs
/configuration/v1/jobs/{code}

‍

Person Details

GET /personnel/v1/person-details
GET /personnel/v1/companies/{companyId}/person-details
GET /personnel/v1/companies/{companyId}/employees/{employeeId}/person-details
GET /personnel/v1/person-details/{employeeId}

‍

PTO Plans

GET /personnel/v1/pto-plans
POST /personnel/v1/pto-plans
PATCH /personnel/v1/companies/{companyId}/employees/{employeeId}/pto-plans/{ptoPlan}
GET /personnel/v1/companies/{companyId}/employees/{employeeId}/pto-plans/{ptoPlan}
GET /personnel/v1/companies/{companyId}/employees/{employeeId}/pto-plans

‍

Recruiting

GET /talent/recruiting/v2/{tenantalias}/api/applications
POST /talent/recruiting/v2/{tenantalias}/api/applications
GET /talent/recruiting/v2/{tenantalias}/api/applications/{applicationId}
POST /talent/recruiting/v2/{tenantalias}/api/applications/{applicationId}/documents
GET /talent/recruiting/v2/{tenantalias}/api/applications/{applicationId}/comments
POST /talent/recruiting/v2/{tenantalias}/api/applications/{applicationId}/comments
POST /talent/recruiting/v2/{tenantalias}/api/applications/{applicationId}/hire
GET /talent/recruiting/v2/{tenantalias}/api/background-check-order-requests
POST /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/background-checks
GET /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/background-checks
GET /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/background-checks/{backgroundCheckId}
PUT /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/background-checks/{backgroundCheckId}
GET /talent/recruiting/v2/{tenantalias}/api/background-check-results-requests
GET /talent/recruiting/v2/{tenantalias}/api/candidates
POST /talent/recruiting/v2/{tenantalias}/api/candidates
GET /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}
GET /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/user-name-email
POST /talent/recruiting/v2/{tenantalias}/api/candidates-lookup
POST /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/documents
GET /talent/recruiting/v2/{tenantalias}/api/candidates/{candidateId}/skills
GET /talent/recruiting/v2/{tenantalias}/api/offers
POST /talent/recruiting/v2/{tenantalias}/api/offers
GET /talent/recruiting/v2/{tenantalias}/api/offers/{offerId}/offer-actions
POST /talent/recruiting/v2/{tenantalias}/api/offers/{offerId}/submit-for-approval

‍

User Details

GET /personnel/v1/user-details

Here’s a detailed reference to all the UKG Pro API Endpoints.

‍

UKG Pro API FAQs

Here are the frequently asked questions about UKG Pro APIs to help you get started:

How do I generate the API key for UKG? Answer
How to Configure Confidential Time Offs Accessible to Only Authorized Managers in UKG Ready? Answer
How to Retrieve Employee’s Pay Statement from UKG PRO? Answer
Authentication and Security for UKG PRO WFM (Dimensions) API Answer
How to Create an API Only User in UKG PRO WFM Answer
UKG Pro WFM Open Shift APIs: Creation, Scheduling, Dynamic Updates for Employee Removal, and Efficient Deletion Answer

‍

Find more FAQs here.

Get started with UKG Pro API

UKG Pro API access is only available by contacting their support or account management team. However, if you want to integrate with multiple HRMS or Recruitment APIs quickly, you can get started with Knit, one API for all top integrations.

‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Dropbox Sign API Directory

Dropbox Sign, formerly HelloSign, is an electronic signature platform allowing users to securely sign, send, and manage legally binding documents online. It can be integrated seamlessly with Dropbox and other cloud services, and simplifies workflows by enabling remote collaboration and reducing the need for physical paperwork. Ideal for businesses of all sizes, Dropbox Sign ensures compliance with global e-signature laws, offering a fast and reliable contract management and document processing solution.

‍

Dropbox Sign APIs enable developers to integrate electronic signature functionality directly into their applications. With easy-to-use endpoints, the API allows businesses to automate document workflows, request signatures, and track the status of agreements in real-time. It supports advanced features like template creation, embedded signing, and customizable branding, making it flexible for many use cases. The API also ensures security and compliance, providing audit trails and adhering to global e-signature standards like ESIGN and eIDAS.

‍

Key highlights of Dropbox Sign APIs include:

Easy Integration: They simplify embedding e-signatures into websites or apps with minimal code.
Embedded Signing: They allow users to sign documents directly within your app or site.
Templates: They support reusable templates for recurring documents, improving workflow efficiency.
Custom Branding: They also offer white-label options for branded signing experiences.
Real-time Status Tracking: They provide real-time updates on document signing progress.
Security & Compliance: They ensure documents meet global e-signature standards (ESIGN, eIDAS) with audit trails and secure encryption.
Team Management: They support multi-user workflows and team-based access to documents.

In this article, we’ll provide an overview of the Dropbox Sign API endpoints.

‍

Dropbox API Endpoints

Here are the most commonly used Dropbox API endpoints:

Account

GET /v3/account
PUT /v3/account
POST /v3/account/create
POST /v3/account/verify

Signature Request

GET /v3/signature_request/{signature_request_id}
GET /v3/signature_request/list
GET /v3/signature_request/files/{signature_request_id}
GET /v3/signature_request/files_as_data_uri/{signature_request_id}
GET /v3/signature_request/files_as_file_url/{signature_request_id}
POST /v3/signature_request/send
POST /v3/signature_request/send_with_template
POST /v3/signature_request/bulk_send_with_template
POST /v3/signature_request/remind/{signature_request_id}
POST /v3/signature_request/release_hold/{signature_request_id}
POST /v3/signature_request/update/{signature_request_id}
POST /v3/signature_request/cancel/{signature_request_id}
POST /v3/signature_request/remove/{signature_request_id}
POST /v3/signature_request/create_embedded
POST /v3/signature_request/create_embedded_with_template
POST /v3/signature_request/bulk_create_embedded_with_template

Templates

GET /v3/template/{template_id}
GET /v3/template/list
POST /v3/template/create
POST /v3/template/create_embedded_draft
POST /v3/template/delete/{template_id}
GET /v3/template/files/{template_id}
GET /v3/template/files_as_data_uri/{template_id}
GET /v3/template/files_as_file_url/{template_id}
POST /v3/template/update_files/{template_id}
POST /v3/template/add_user/{template_id}
POST /v3/template/remove_user/{template_id}

Bulk Send Job

GET /v3/bulk_send_job/{bulk_send_job_id}
GET /v3/bulk_send_job/list

Report

POST /v3/report/create

Team

GET /v3/team
GET /v3/team/info
GET /v3/team/members/{team_id}
GET /v3/team/sub_teams/{team_id}
POST /v3/team/create
PUT /v3/team
DELETE /v3/team/destroy
PUT /v3/team/add_member
POST /v3/team/remove_member

Unclaimed Draft

POST /v3/unclaimed_draft/create
POST /v3/unclaimed_draft/create_embedded
POST /v3/unclaimed_draft/create_embedded_with_template
POST /v3/unclaimed_draft/edit_and_resend/{signature_request_id}

Embedded

GET /v3/embedded/sign_url/{signature_id}
POST /v3/embedded/edit_url/{template_id}

‍

Here’s a detailed reference to all the Dropbox API endpoints.

‍

Dropbox Sign API FAQs

‍

Here are the frequently asked questions about Dropbox Sign APIs to help you get started:

What is the rate limit for Dropbox sign API? Answer
Get Embedded Sign URL is asking for client ID Answer
Dropbox sign refresh token getting expired after 1 hour Answer
Create Template API Error Answer
What is a best way to identify each document with its template after download Answer

‍

Find more FAQs here.

Get started with Dropbox Sign API

‍

Dropbox Sign API access is offered through various pricing plans: Essentials, Standard, and Premium. It also includes a test mode for trying out features before deploying them in production. For quick integration with multiple eSignature APIs, you can use Knit, a single API that connects to top SaaS platforms.

‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍

Nov 10, 2024

Paycom API Directory

Paycom is a comprehensive cloud-based HR and payroll software provider that helps businesses manage their workforce with ease. Founded in 1998, it offers an all-in-one solution that integrates various HR functions, including payroll processing, time and attendance tracking, talent management, and benefits administration.

Paycom’s platform streamlines HR tasks by providing real-time data and automating workflows, allowing companies to reduce manual errors and increase efficiency. Its user-friendly interface empowers employees to access and manage their personal information, making it a valuable tool for both HR teams and employees alike.

Paycom also offers a suite of APIs for integrating various HR and payroll functionalities into applications. Key highlights include:

Employee Data Management:
- Employee Information: Access and update employee details such as personal information, job history, and compensation.
- Employee Self-Service: Enable employees to view and update their information, including personal details, pay stubs, and benefits.
Payroll Processing:
- Payroll Calculations: Integrate payroll calculations, including earnings, deductions, and taxes.
- Payroll Reports: Retrieve payroll reports for auditing and compliance purposes.
Time and Attendance:
- Time Tracking: Access and manage employee time and attendance data, including clock-in/clock-out records and time-off requests.
- Scheduling: Integrate with scheduling systems to manage employee shifts and work schedules.
Benefits Administration:
- Benefits Enrollment: Manage employee benefits enrollment, including health insurance, retirement plans, and other benefits.
- Benefits Reporting: Retrieve data on employee benefits usage and enrollment for reporting and compliance.
Compliance and Reporting:
- Tax Compliance: Access and manage tax information, including filings and withholdings.
- Regulatory Reports: Retrieve and generate reports required for regulatory compliance.
Recruitment and Onboarding:
- Applicant Tracking: Integrate with applicant tracking systems to manage job postings, applications, and candidate information.
- Onboarding: Facilitate the onboarding process for new hires, including document management and training.
Security and Access Control:
- User Authentication: Manage user authentication and authorization to ensure secure access to API functionalities.
- Data Encryption: Ensure that data transmitted via APIs is encrypted for security and privacy.

‍

Paycom API Endpoints

Paycom offers several commonly used API endpoints that cover various aspects of HR, payroll, and employee management.

Here are some of the key endpoints you might use:

Employee Management
- GET /employees: Retrieve a list of employees or specific employee details.
- POST /employees: Create a new employee record.
- PUT /employees/{employee_id}: Update an existing employee record.
- DELETE /employees/{employee_id}: Delete an employee record.
Payroll Processing
- GET /payrolls: Retrieve payroll information and details.
- POST /payrolls: Submit payroll data for processing.
- GET /payrolls/{payroll_id}: Get details of a specific payroll run.
- GET /payrolls/{payroll_id}/reports: Retrieve payroll reports associated with a specific payroll run.
Time and Attendance
- GET /time_entries: Retrieve time and attendance records.
- POST /time_entries: Submit new time and attendance entries.
- PUT /time_entries/{entry_id}: Update existing time and attendance records.
- DELETE /time_entries/{entry_id}: Delete a time and attendance record.
Benefits Administration
- GET /benefits: Retrieve benefits information and details.
- POST /benefits: Enroll employees in benefits programs.
- GET /benefits/{benefit_id}: Get details of a specific benefit plan.
- PUT /benefits/{benefit_id}: Update benefit plan details.
Compliance and Reporting
- GET /taxes: Retrieve tax information and details.
- POST /taxes: Submit tax-related data.
- GET /reports: Retrieve various compliance and regulatory reports.
- GET /reports/{report_id}: Get details of a specific report.
Recruitment and Onboarding
- GET /applicants: Retrieve a list of job applicants and their details.
- POST /applicants: Submit new applicant information.
- GET /applicants/{applicant_id}: Get details of a specific applicant.
- PUT /applicants/{applicant_id}: Update applicant details.
Security and Access Control
- POST /auth/token: Obtain an authentication token for API access.
- GET /users: Retrieve user information and permissions.
- PUT /users/{user_id}: Update user permissions and access.

‍

Paycom API FAQs

‍

Here are the frequently asked questions about Paycom APIs to help you get started:

‍1. Does Paycom provide public APIs for direct integration?

No, Paycom doesn’t offer public APIs. Instead, you can use services like Knit that provide pre-built integrations to access Paycom’s HR and payroll data.

2. What type of data can I retrieve through Paycom integrations?

You can access employee details, payroll information, time and attendance records, benefits, and compliance reports through integrations.

3. Is custom API development required to integrate Paycom with my systems?

No, using third-party platforms like Knit eliminates the need for custom API development by offering standardized, pre-built APIs for Paycom and other HR systems.

4. What security measures are in place for Paycom integrations?

Third-party platforms such as Knit handle security by using data encryption and secure API access. They also comply with data privacy regulations like GDPR and HIPAA.

5. Can I automate employee onboarding and payroll using Paycom integrations?

Yes, integrations with Paycom can automate employee onboarding and payroll processes, enabling seamless data transfer between Paycom and other HR or payroll systems.

‍

Get started with Paycom API

‍

Paycom doesn’t provide public APIs for direct integration. Instead, companies can use third-party services like Knit, which offers ready-made integrations with Paycom. Knit helps you connect to Paycom’s systems to get important data like employee records, payroll details, and time tracking.

By using Knit’s unified APIs, you can standardize data and simplify processes across different HR systems, including Paycom. This makes it easier to automate HR tasks and connect Paycom with other tools without needing custom API development.

‍

To sign up for free, click here. To check the pricing, see our pricing page.

‍

greytHR API Guide

greytHR API Directory

‍

greytHR is a leading HR and Payroll software provider for small and medium sized companies. It enables HR teams and professionals to automate all people operations including employee information management, leave and attendance management, training, appraisals, compensation, etc. greytHR API enables developers to access HR related information like Employee/Leave/Attendance/Salary for seamless exchange between different applications.

greytHR API Authentication

greytHR is based on oAuth2 based authentication for access to APIs, which is an industry-standard protocol for authorization. Since the greytHR API captures a lot of sensitive and confidential information, only authorized entities get access to it. Each API request is authenticated with an auth-token using the client id and client credentials obtained during the registration process. A verified username and password is used for basic authentication.

greytHR API API Objects, Data Models & Endpoints

If you are working with greytHR API for integration with other applications, it is important to understand the data models, objects and endpoints to facilitate data normalization and accurate API requests. Some of these are captured below to help you get started.

Employee

GET Get all Employees: https://api.greythr.com/employee/v2/employees?page=1&size=35
GET Get Employee: https://api.greythr.com/employee/v2/employees/{employee-id}
GET Employee Lookup: https://api.greythr.com/employee/v2/employees/lookup?q={EmployeeNo./Email/Guid/Access card/ Personal email}
POST Add Employee: https://api.greythr.com/employee/v2/employees
PUT Update Employee: https://api.greythr.com/employee/v2/employees/{employee-id}
GET Get All Employee Profile Details: https://api.greythr.com/employee/v2/employees/profile
GET GET All employees Photo: https://api.greythr.com/hr/v2/employees/photo?photoSize=large&page=1&size=0
GET Get Employee Photo: https://api.greythr.com/hr/v2/employee/{employeeId}/photo
GET Get Employee Profile Details: https://api.greythr.com/employee/v2/employees/{employee-id}/profile
PUT Update Employee Profile Details: https://api.greythr.com/employee/v2/employees/{employee-id}/profile
GET Get All Employee Personal Details: https://api.greythr.com/employee/v2/employees/personal
GET Get Employee Personal Details: https://api.greythr.com/employee/v2/employees/{employee-id}/personal
PUT Update Employee Personal Details: https://api.greythr.com/employee/v2/employees/{employee-id}/personal
GET Get All Employee Work Details: https://api.greythr.com/employee/v2/employees/work
GET Get Employee Work Details Copy: https://api.greythr.com/employee/v2/employees/{employee-id}/work
PUT Update Employee Work Details: https://api.greythr.com/employee/v2/employees/{employee-id}/work
GET Get All Employee Separation Details: https://api.greythr.com/employee/v2/employees/separation
GET Get Employee Separation Details Copy: https://api.greythr.com/employee/v2/employees/{employee-id}/separation
PUT Update Employee Separation Details: https://api.greythr.com/employee/v2/employees/{employee-id}/separation
GET Get All Employee Address Details: https://api.greythr.com/employee/v2/employees/addresses/{address-type}
GET Get Employee Address Details: https://api.greythr.com/employee/v2/employees/{employee-id}/addresses/{address-type}
PUT Update Employee Address Details: https://api.greythr.com/employee/v2/employees/{employee-id}/addresses/{address-type}
DELETE Delete Employee Address Details: https://api.greythr.com/employee/v2/employees/{employee-id}/addresses/{address-type}
GET Get All Employee Statutory Details: https://api.greythr.com/employee/v2/employees/statutory/india
GET Get Employee Statutory Details: https://api.greythr.com/employee/v2/employees/{employee-id}/statutory/india
PUT Update Employee Statutory Details: https://api.greythr.com/employee/v2/employees/{employee-id}/statutory/india
GET Get Orgtree - Reporting Structure: https://api.greythr.com/employee/v2/employees/org-tree
GET Get Employee Manager details: https://api.greythr.com/employee/v2/employees/{employee-id}/org-tree
POST Add Employee Manager: https://api.greythr.com/employee/v2/employees/{employee-id}/org-tree
PUT Update Employee Manager: https://api.greythr.com/employee/v2/employees/{employee-id}/org-tree
GET Get All Employee Positions details: https://api.greythr.com/employee/v2/employees/categories
GET Get Employee Positions Details: https://api.greythr.com/employee/v2/employees/{employee-id}/categories
POST Add Employee Positions: https://api.greythr.com/employee/v2/employees/{employee-id}/categories
GET Get All Employee Bank Details: https://api.greythr.com/employee/v2/employees/bank
GET Get Employee Bank Details: https://api.greythr.com/employee/v2/employees/{employee-id}/bank
POST Add Employee Bank Details: https://api.greythr.com/employee/v2/employees/{employee-id}/bank
PUT Update Employee Bank Details: https://api.greythr.com/employee/v2/employees/{employee-id}/bank
GET Get All Employee PF & ESI details: https://api.greythr.com/employee/v2/employees/pf
GET Get Employee PF & ESI details: https://api.greythr.com/employee/v2/employees/{employee-id}/pf
POST Add Employee PF & ESI details: https://api.greythr.com/employee/v2/employees/{employee-id}/pf
PUT Update Employee PF & ESI details: https://api.greythr.com/employee/v2/employees/{employee-id}/pf
GET Get Employee's All Identity Details: https://api.greythr.com/employee/v2/employees/{employee-id}/identities
GET Get Employee Identity Details: https://api.greythr.com/employee/v2/employees/{employee-id}/identities/{identity-code}
POST Add Employee Identity: https://api.greythr.com/employee/v2/employees/{employee-id}/identities/{identity-code}
PUT Update Employee Identity: https://api.greythr.com/employee/v2/employees/{employee-id}/identities/{identity-code}
DELETE Delete Employee Identity: https://api.greythr.com/employee/v2/employees/{employee-id}/identities/{identity-code}
GET Get Employees Family Details: https://api.greythr.com/employee/v2/employees/families/{relationtype-id}
GET Get Employee Family Details: https://api.greythr.com/employee/v2/employees/{employee-id}/families
POST Add family member to Employee: https://api.greythr.com/employee/v2/employees/{employee-id}/families
PUT Update Family member details: https://api.greythr.com/employee/v2/employees/{employee-id}/families/{relation-id}
DELETE Delete Family member details: https://api.greythr.com/employee/v2/employees/{employee-id}/families/{relation-id}
GET Get All Employee Asset details: https://api.greythr.com/employee/v2/employees/assets
GET Get Employee Asset details: https://api.greythr.com/employee/v2/employees/{employee-id}/assets
POST Add Asset to Employee: https://api.greythr.com/employee/v2/employees/{employee-id}/assets
POST Add Asset to Employee: https://api.greythr.com/employee/v2/employees/{employee-id}/assets
DELETE Delete Update Family member details: https://api.greythr.com/employee/v2/employees/{employee-id}/assets/{asset-id}
GET Get All Employee Qualifications details: https://api.greythr.com/employee/v2/employees/qualifications
GET Get Employee Qualifications details: https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications
POST Add Employee Qualifications: https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications
PUT Update Employee Qualifications details: https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications/{qualification-id}
DELETE Delete Employee Qualifications details: https://api.greythr.com/employee/v2/employees/{employee-id}/qualifications/{qualification-id}
GET Get Employee All Card Details: https://apigee-test.greythr.com/employee/v2/employees/{employeeId}/card-details
GET Get Employee Card Details: https://apigee-test.greythr.com/employee/v2/employees/employeeId/card-details/cardId
POST Add Employee Card Details: https://apigee-test.greythr.com/employee/v2/employees/{employeeId}/card-details
DELETE Delete Employee Card Details: https://apigee-test.greythr.com/employee/v2/employees/{employeeId}/card-details/{cardId}

Leave

GET Get Leave Balance details for All Employees: https://api.greythr.com/leave/v2/employee/years/{{Year}}/balance
GET Get Employee Leave Balance for a year: https://api.greythr.com/leave/v2/employee/{employee-id}/years/{{Year}}/balance
GET Get Leave Transactions details for All Employees: https://api.greythr.com/leave/v2/employee/transactions?start={{StartDate}}&end={{EndDate}}
GET Get Employee Leave Transactions: https://api.greythr.com/leave/v2/employee/{employee-id}/transactions?start={{StartDate}}&end={{EndDate}}
POST Leave Transaction: https://api.greythr.com/leave/v2/employee/transactions

Attendance

GET Get Attendance Summary for All Employees: https://api.greythr.com/attendance/v2/employee/insights?end={{EndDate}}&start={{StartDate}}
GET Get Employee Attendance Summary: https://api.greythr.com/attendance/v2/employee/{employee-id}/insights?end={{EndDate}}&start={{StartDate}}
GET Get Employee Attendance Summary: https://api.greythr.com/attendance/v2/employee/{employee-id}/insights?end={{EndDate}}&start={{StartDate}}
GET Get Employee Attendance Muster: https://api.greythr.com/attendance/v2/employee/{employee-id}/muster?end={{EndDate}}&start={{StartDate}}

Payroll

GET Get All Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/handentry
GET Get Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/{employee-id}
GET Get Salary Repository Items: https://api.greythr.com/payroll/v2/salary/repository
POST Add Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/{employee-id}
PUT Update Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/{employee-id}
DELETE Delete Employee Handenrty salary Items: https://api.greythr.com/payroll/v2/employees/{employee-id}
GET Get Salary Statement for a Month: https://api.greythr.com/payroll/v2/employees/salary/statement/{{yyyy-mm-01}}
GET Get Salary Statement for an Employee for a Month: https://api.greythr.com/payroll/v2/employees/salary/statement/{{yyyy-mm-01}}/{employee-id}
GET Get Employees Resettlement for a Month: https://api.greythr.com/payroll/v2/employees/resettlement/{payrollMonth}
POST Add Salary Revision: https://api.greythr.com/payroll/v2/salary/revision/employees/{employee-id}
GET Get Salary Revision History: https://api.greythr.com/payroll/v2/salary/revision/employees/{employee-id}/{status}
GET Get Salary Revision Difference: https://api.greythr.com/payroll/v2/salary/revision/difference/employees/{employee-id}
GET Get Attendance Snapshot details: https://apigee-test.greythr.com/payroll/v2/attendance/snapshot/employees/{employee-id}
POST Save Attendance Snapshot: https://apigee-test.greythr.com/payroll/v2/attendance/snapshot/employees/{employee-id}
DELETE Delete Attendance Snapshot: https://apigee-test.greythr.com/payroll/v2/attendance/snapshot/employees/{employee-id}

List of Values

POST Get greytHR LOV: https://api.greythr.com/hr/v2/lov
POST Get greytHR Position/Category: https://api.greythr.com/hr/v2/lov
GET Get Bank Branch Details: https://api.greythr.com/hr/v2/lov/banks/{bankId}/branches
POST Add greytHR Org Entities: https://api.greythr.com/hr/v2/lov/org/entities

Documents

GET Get Employee Documents: https://api.greythr.com/employee/v2/emp-docs/{employeeId}/{categoryId}
GET Download Employee Documents: https://api.greythr.com/employee/v2/emp-docs/{employeeId}/{documentId}/{fieId}
POST Add Employee Document Category: https://api.greythr.com/employee/v2/emp-docs/category
POST Add Employee Document: https://api.greythr.com/employee/v2/employee-docs/{employeeId}/{category}

Users

POST Add New Users: https://api.greythr.com/user/v2/users
GET Get Users List: https://api.greythr.com/user/v2/users
GET Get Employee User ID: https://api.greythr.com/user/v2/users?userType=employee&userName=Employee Number
POST User SSO: https://api.greythr.com/user/v2/users/{userid}/auth

greytHR API Use Cases

Centralized employee information management and simplification of HR processes by eliminating inconsistencies, duplication and clutter in employee information
Easy payroll management with accurate and timely payouts
Seamless leave management with accurate leave accounting and integration with payroll
Real time attendance management, easy shift and overtime management
Goal alignment and performance management, progress tracking, rewards achievements

Top customers

greytHR provides HRMS services to 20,000+ companies across 250+ cities, including:

‍

Dunzo, a 24x7 delivery app
HealthifyMe, an Indian digital health and wellness company
Rapido, an Indian ride-hailing service
Hutchinson, a French manufacturer of non-tire rubber
Lentra, a new-age domain-native platform
ClickDesk, a live support chat software
CORE Energy Systems, an emerging engineering services and project management company

greytHR API FAQs

How can admin enable the role for API users? Answer
How to generate API credentials for the greytHR admins? Answer
Is it possible to configure API credentials in Tally without enabling the integration of greytHR? Answer

How to integrate with greytHR API

To integrate with the greytHR API, you need to create an account. You can create an account here. You can then go through this documentation to understand the REST API for external applications to integrate and interoperate with greytHR.

Get started with greytHR API

greytHR offers a freemium model for its users. While some features for a certain number of employees can be availed free of cost, the paid version starts at ₹3495/month adding more features which users can leverage. There are more premium tiers to choose from. Each pricing plan comes with a free trial.

‍

However, integrating with greytHR API with in-house resources can be quite expensive and time consuming, for both building and managing the integration. You can significantly bring this cost down by partnering with a platform like Knit. With a nominal integration cost, Knit helps you integrate with a unified HRIS API, with which you can connect with its bouquet of HRIS applications, including greytHR, at no additional cost. As a unified API, Knit helps you connect with your preferred HRIS applications in a fraction of the cost and time. Book a demo today to learn more!

https://people.zoho.com/people/api/forms?

Zoho People API Guide

Zoho People API Directory

‍

Zoho People is a leading HR solution provider which enables companies to automate and simplify their HR operations. Right from streamlining core HR processes, to supporting time and attendance management, to facilitating better performance management and fostering greater learning and development, Zoho People has been transforming HR operations for 4500+ companies for over a decade.

‍

With Zoho People API, companies can seamlessly extract and access employee data, update it and integrate this application with other third party applications like ATS, LMS, employee onboarding tools, etc. to facilitate easy exchange of information.

‍

Zoho People API Authentication

Like most industry leading HRIS applications, Zoho People API uses OAuth2.0 protocol for authentication. The application leverages Authorization Code Grant Type to obtain the grant token(code), allowing users to share specific data with applications, without sharing user credentials. Zoho People API uses access tokens for secure and temporary access which is used by the applications to make requests to the connected app.

‍

Using OAuth2.0, Zoho People API users can revoke a customer's access to the application at any time, prevent disclosure of any credentials, ensure information safeguarding if the client is hacked as access tokens are issued to individual applications, facilitate application of specific scopes to either restrict or provide access to certain data for the client.

‍

Zoho People API Objects, Data Models & Endpoints

Integrating with any HRIS application requires the knowledge and understanding of the objects, data models and endpoints it uses. Here is a list of the key concepts about Zoho People API which SaaS developers must familiarize themselves with before commencing the integration process.

Forms API

POSTInsert Record API

https://people.zoho.com/people/api/forms/<inputType>/<formLinkName>/insertRecord?inputData=<inputData>

‍

POSTInsert Record API for Adding Employees

https://people.zoho.com/people/api/forms/json/employee/insertRecord?inputData=<inputData>

‍

POSTUpdate Record API

https://people.zoho.com/people/api/forms/<inputType>/<formLinkName>/updateRecord?inputData=<inputData>&recordId=<recordId>

‍

GETGet Bulk Records API

https://people.zoho.com/people/api/forms/<formLinkName>/getRecords?sIndex=<record starting index>&limit=<maximum record to fetch>

‍

POSTAdd Department API

https://people.zoho.com/people/api/department/records?xmlData=<xmlData>

‍

GETFetch Forms API

‍

GETFetch Single Record API

https://people.zoho.com/people/api/forms/<formLinkName>/getDataByID?recordId=261091000000049003

‍

GETFetch Single Record API (Section Wise)

https://people.zoho.com/people/api/forms/<formLinkName>/getRecordByID?recordId=<recordId>

‍

GETGet Related Records API

https://people.zoho.com/people/api/forms/<formLinkName>/getRelatedRecords?sIndex=<sIndex>&limit=<limit>& parentModule=<parentModule>&id=<id>&lookupfieldName=<lookupfieldName>

‍

GETSearch Records Based on Record Values

https://people.zoho.com/people/api/forms/<formLinkName>/getRecords?searchParams={searchField: '<fieldLabelName>', searchOperator: '<operator>', searchText : '<textValue>'}

‍

GETGet Fields of Form API

https://people.zoho.com/people/api/forms/<formLinkName>/components?

Cases API

POSTAdd Case API

https://people.zoho.com/api/hrcases/addcase?categoryId=<Category ID>&subject=<subject>&description=<description>

‍

GETView Case API

https://people.zoho.com/api/hrcases/viewcase?recordId=<Reord ID of the case>

‍

GETView Case Listing API

https://people.zoho.com/api/hrcases/getRequestedCases?index=<index>&status=<status>

‍

GETView List of Categories API

https://people.zoho.com/api/hrcases/listCategory?

Timesheet API

POSTCreate Timesheets API

https://people.zoho.com/people/api/timetracker/createtimesheet?user=<user>&timesheetName=<timesheetName>&description=<description>&dateFormat=<dateFormat>&fromDate=<fromDate>&toDate=<toDate>&billableStatus=<billableStatus>&jobId=<jobId>&projectId=<projectId>&clientId=<clientId>&sendforApproval=<sendforApproval>

‍

POSTModify Timesheets API

https://people.zoho.com/people/api/timetracker/modifytimesheet?timesheetId=<timesheetId>&timesheetName=<timesheetName>&description=<description>&sendforApproval=<sendforApproval>&removeAttachment=<removeAttachment>

‍

GETGet Timesheets API

https://people.zoho.com/people/api/timetracker/gettimesheet?user=<user>&approvalStatus=<approvalStatus>&employeeStatus=<employeeStatus>&dateFormat=<dateFormat>&fromDate=<fromDate>&toDate=<toDate>&sIndex=<sIndex>&limit=<limit>

‍

GETGet Timesheets Details API

https://people.zoho.com/people/api/timetracker/gettimesheetdetails?timesheetId=<timesheetId>&dateFormat=<dateFormat>

‍

POSTApprove Timesheets API

https://people.zoho.com/people/api/timetracker/approvetimesheet?authtoken=<authtoken>&timesheetId=<timesheetId>&approvalStatus=<approvalStatus>&timeLogs=<timeLogs>&comments=<comments>&isAllLevelApprove=<isAllLevelApprove>

‍

POSTDelete Timesheets API

https://people.zoho.com/people/api/timetracker/deletetimesheet?timesheetId=<timesheetId>

Onboarding API

POSTTrigger Onboarding API

https://people.zoho.com/api/<Employee|Candidate>/triggerOnboarding

‍

POSTAdd Candidate API

https://people.zoho.in/people/api/forms/json/Candidate/insertRecord?inputData=<inputData>

‍

POSTUpdate Candidate API

https://people.zoho.com/people/api/forms/<inputType>/Candidate/updateRecord?inputData=<inputData>&recordId=<recordId>

Leave API

POSTAdd Leave API

https://people.zoho.com/people/api/forms/<inputType>/<formLinkName>/insertRecord?inputData=<inputData>

‍

POSTGet Record API

https://people.zoho.com/people/api/forms/leave/getDataByID?recordId=413124000068132003

‍

PATCHCancel Leave API

https://people.zoho.com/api/v2/leavetracker/leaves/records/cancel/<record-id>

‍

GETUser Report API

https://people.zoho.com/people/api/v2/leavetracker/reports/user

‍

GETLeave Booked and Balance Report API

https://people.zoho.com/people/api/v2/leavetracker/reports/bookedAndBalance

‍

GETLeave Bradford API

https://people.zoho.com/people/api/v2/leavetracker/reports/bradford

‍

GETEncashment Report API

https://people.zoho.com/people/api/v2/leavetracker/reports/encashment

‍

GETLOP Report API

https://people.zoho.com/people/api/v2/leavetracker/reports/lop

POSTAdd Leave Balance API

https://people.zoho.com/api/leave/addBalance?balanceData=<balanceData>&dateFormat=<dateFormat>

Attendance API

POSTBulk Import API

https://people.zoho.com/people/api/attendance/bulkImport?data=<JSONArray>

‍

GETFetch Last Attendance Entries API

https://people.zoho.com/api/attendance/fetchLatestAttEntries?duration=5&dateTimeFormat=dd-MM-yyyy HH:mm:ss

‍

POSTAttendance Check In Check Out API

https://people.zoho.com/people/api/attendance?dateFormat=<dateFormat>&checkIn=<checkin time>&checkOut=<checkout time>&empId=<employeeId>&emailId=<emailId>&mapId=<mapId>

‍

POSTAttendance Entries API

https://people.zoho.com/people/api/attendance/getAttendanceEntries?date=<date>&dateFormat=<dateformat>&erecno=<erecno>&mapId=<mapId>&emailId=<emailId>&empId=<empId>

‍

POSTAttendance User Report API

https://people.zoho.com/people/api/attendance/getUserReport?sdate=<sdate>&edate=<edate>&empId=<employeeId>&emailId=<emailId>&mapId=<mapId>&dateFormat=<dateFormat>

‍

POSTEmployee Shift Mapping API

https://people.zoho.com/people/api/attendance/updateUserShift?dateFormat=<dateformat>&empId=<employee Id>&shiftName=<shift name>&fdate=<FromDate>&tdate=<toDate>

‍

GETGetting Shift Details Of Employee API

https://people.zoho.com/people/api/attendance/getShiftConfiguration?empId=<employee Id>&emailId<email Id>=&mapId<Mapper ID>=&sdate<startDate>=&edate=<endDate>

‍

GETGet Regularization Records API

https://people.zoho.com/people/api/attendance/getRegularizationRecords

‍

For more information and details on other endpoints, check out this detailed resource.

Zoho People API Use Cases

Quick candidate onboarding with offer letter management, new hire portal, customizable workflows and status-view reports
Cloud-based attendance management system to generate insightful reports, regularize attendance, option to check in from anywhere
Simple time off management tool with leave policy compliance, instant access to employee leave history, mobile leave applications and approvals and multi-location time off and holiday management
Productivity timesheets to view the details of the time spent on every project, task, and client, get a centralized overview of your tasks and time resources, calculate payouts faster with accurate employee time logs and automate invoicing
Shift scheduling to map employees to standard shifts, enable automatic shift rotation with a custom scheduler, mark, track, and analyze breaks and allowances
Performance management with 360-degree, continuous feedback system, to evaluate employees with customized performance appraisal methods
Case management to sort and organize employee questions, track their status, and reply promptly from a central location with an easily accessible knowledge base

Top customers

‍

Zomato, an Indian multinational restaurant aggregator and food delivery company
The Logical Indian, an independent and public-spirited digital media platform for Indian millennials
IIFL Finance, a leading finance & investment services company
Meesho, an online shopping platform
Waterfield Advisors, a leading independent Multi-Family Office and Wealth Advisory Firm
DLT Labs, a global leader in the development and delivery of enterprise blockchain technologies and solutions

Zoho People API FAQs

What to do when you cannot use searchParams on Zoho People API (HTTP Status 400)? Answer
How to achieve webhook integration between Podio and Zoho People? Answer
How to get the attendance API from Zoho People in postman? Answer
What to do if permission is denied when trying to fetch records from Zoho People? Answer
How to parse through the following ZOHO People JSON string using VB.NET? Answer
How to write a custom function in Zoho People Deluge to fetch all the dates between from and to given? Answer
How to sync Zoho People with Google Calendar API for event time update without changing date? Answer

How to integrate with Zoho People API

To integrate your preferred applications with Zoho People API, you need valid Zoho People user credentials. In addition you also must have a valid authentication token or OAuth to access Zoho People API.

Get started with Zoho People API

Integrating with Zoho People API requires engineering bandwidth, resources and knowledge. Invariably, building and maintaining this integration can be extremely expensive for SaaS companies. Fortunately, with Knit, a unified HRIS API, you can easily integrate with Zoho People API and other multiple HRIS applications at once. Knit enables users to normalize data from across HRIS applications, including Zoho People, 10x faster, ensure higher security with double encryption and facilitates bi-directional data sync with webhook architecture to ensure guaranteed scalability, irrespective of data load. Book a demo to learn how you can get started with Zoho People API with ease.

‍

Ceridian Dayforce API Directory

Ceridian Dayforce is an all-inclusive human capital management system that helps employers take care of all stages of an employee’s lifecycle, across HR, payroll, employee engagement, workforce management, services, etc. It is a cloud based system. Ceridian Dayforce enables businesses to unlock workforce intelligence, empower people, and manage compliance.

‍

With the Ceridian Dayforce Connector, developers can get access to the REST API of Ceridian Dayforce HCM, to facilitate integrations across their preferred applications. With this REST API, organizations can store all information regarding their employees and retrieve it as and when the need arises.

Ceridian Dayforce API Authentication

Ceridian Dayforce API supports authentication in 2 ways. First, developers can limit and authorize access via token based authentication. In this mechanism, Ceridian Dayforce verifies the user’s identity to provide a unique access token for API access. Second, developers can leverage the basic auth connection for Ceridian Dayforce API authentication. Here, a username along with a password and API key is what users can use to facilitate API access and ensure reliable authentication. In addition, Ceridian Dayforce API comes with AES 256 encryption, to ensure that the connection’s password/ credentials are safe.

Ceridian Dayforce API Objects, Data Models & Endpoints

When working with Ceridian Dayforce API, you need to understand the data models, objects and endpoints. Here is a quick overview to get started:

Dependents

This object represents a dependent of an employee, including child, spouse, partner, etc. It contains data fields like first/last name, relationship, date of birth, gender, if the dependent is a student

Employee

This object covers all details relating to an individual or candidate who has been employed by the organization. It contains information or data fields like employee number, first/last name, preferred name, work email, personal email, groups, phone number, home/ work location, employments, manager, team, gender, marital status, employment status, start date, termination date, etc.

Employment

This object represents a job position at any company. It contains data fields like employee, job title, pay rate, pay period, pay currency, effective date, employment type, pay frequency, etc.

Group

A group is a subset in which an employee can be placed. Groups can be of multiple types, including teams, pay groups. At the same time, each employee can be a part of multiple groups. It contains data fields or information along the lines of name, type, etc.

Location

This object represents the geographical area which can be associated with an employee. The location object contains data fields including name, street number, city, zip code, country, location type, state, etc.

Team

Team as an object is a subgroup of a company like a department. Each employee is allocated to a particular team as a part of their employment.

Time Off

This object comprehensively represents time off entries for all employees to get a complete picture of attendance in the organization. It contains details like employee, status, employee note, units, amount, request type, start time, end time, etc.

Time Off Balance

This object represents the current status or balance remaining as a part of an employee’s allocated time off. This includes data fields like employee, balance, policy type, among others.

Common Ceridian Dayforce API endpoints

GET/v1/Employees/{employee_id}/DependentsBeneficiaries

With this endpoint, you can get access to information about the dependents, including their name, date of birth, relationship, etc.

GET/v1/Employees

This endpoint can be used to get any information needed about the employee, including employment, time off, time off balance, etc.

GET/v1/employees/{employee_id}/TimeAwayFromWork

This endpoint helps get access to information about time off including start time, end time, request type, etc.

GET/v1/Employees/{employee_id}/WorkAssignments

With this end point, users can get access to information about an employee’s work assignment focusing on location, zip code, country, among others.

GET/V1/Employees/{employee_id}/CompensationSummary

This endpoint helps get access to information about the employment and payroll in general, including pay period, pay frequency, rate, etc.

Merge interacts with this API endpoint to...

GET/V1/Employees/{employee_id}

With this endpoint, one can get information about a particular employee, including personal email, home location, ethnicity, employment status, etc.

GET/v1/OrgUnits

This endpoint is used to gain access to information about an employee’s team and groups the employee is a part of.

GET/v1/EmployeeBalancePeriods

With this endpoint, users get access to information about the time off balance and policy type for each employee.

Ceridian Dayforce API Use Cases

Provides a unified view for all employees, giving all information regarding performance, payroll, time off and other details on one platform, preventing any toggling for users
Facilitates in-depth and real time analytics for all HR data to help employers understand the health of their organization and make well-informed decisions in a timely manner. It provides a vast catalog of standard reports along with the option to customize reporting based on organizational needs
Curates insights for business intelligence and helps organizations with flight risk assessment to prevent attrition, gauge personality types, easily access performance data and understand status for each employee
Ensures self service for employees to empower them to get quick access to their pay details, benefits and all the other information they might need. It also allows employees to update personal information and other details on their own, following chat commands for smooth onboarding and updates
Promotes role based access and security to uphold high levels of data privacy. This ensures that confidential data has very limited access and employees are only able to view data which is required and relevant to their role
Helps with workforce management to make data-driven staffing decisions, utilizing flexible scheduling for better business outcomes, streamline absence management and overall optimize HR operations for greater efficiency and productivity
Makes hire to retire employee lifecycle seamless with AI based screening and automated onboarding, personalized learning recommendations and succession planning, employee engagement interventions and much more

Top customers

With ~6000+ customers, Ceridian Dayforce is a popular HRIS/ HCM provider for organizations, especially in the United States. Here is a list of the top customers that Ceridian Dayforce is servicing:

‍

CBS News, the news division of the American television and radio service CBS
Gannett Co., Inc., an American mass media holding company
Amphenol Corporation, a United States based Manufacturing organization
Travis Perkins, a United Kingdom based Distribution organization
The Hanover Insurance Group, Inc., a United States based Insurance organization
Harley-Davidson, Inc., a United States based Manufacturing organization
Marrakech Inc., a diverse nonprofit organization

Ceridian Dayforce API FAQs

How to facilitate Ceridian Dayforce Integration with Active Directory? Answer
What is the Ceridian Dayforce HRIS API location? Answer
How to extract the URL to call the Authenticate API method with Dayforce API? Answer
How to navigate Dayforce Reporting Custom Field SQL? Answer
How to set up a token-based auth connection to Ceridian Dayforce? Answer
How to set up a basic auth connection to Ceridian Dayforce? Answer
How to set up the Ceridian Dayforce Environment? Answer
What is a Ceridian Dayforce Connector Example? Answer
How to configure Ceridian Dayforce REST Operations? Answer
How to enable testing of the Ceridian Dayforce APIs against your own environment? Answer
How to contribute to the Ceridian Dayforce Connector? Answer

How to integrate with Ceridian Dayforce API

To start your integration journey with Ceridian Dayforce API, you need to create an account on the Ceridian Dayforce Developer Network and the same can be accessed here. In addition, you can also check out this Ceridian Dayforce Connector Overview for a detailed snapshot.

Get started with Ceridian Dayforce API

Ceridian Dayforce HCM doesn’t provide its pricing publicly on its website. However, interested customers can fill in their details or get in touch with the sales team with this link to get an understanding of how much it would cost to get access to Ceridian Dayforce API. To make the integration process smooth with Ceridian Dayforce API or any other HRIS API, you can get started with Knit, one API for all your integrations. Sign up with Knit, and you can integrate with top HRIS API in a short span of time at a fraction of the cost.

‍

A Guide toIntegrating with Freshteams API

Freshteam API Directory

A cloud based HR software, Freshteam enables organizations with managing employee details, recruitment, on-boarding, time-off, off-boarding, and organization details, among other aspects of their HR processes and practices. With Freshteam API integration, organizations can seamlessly synchronize data between their application and Freshteam to ensure real time updation of employee information across both platforms. It helps capture any changes in employee status, designation, HR policies, etc. across different applications a business uses.

Freshteam API Authentication, Filtering, Rate Limits

To ensure utmost security and prevent unauthorized access, Freshteam API uses Oauth2.0 for authentication and authorization. Developers can use the Freshteam UI to make calls to the Freshteam authentication server to obtain an access token. This access token can be used to make valid API calls thereon. The access token identifies the requester and the requester’s permission. In the Freshteam domain, the access token is present under Your API Key, which can be copied and used to make API calls.

‍

Rate limits i.e. the number of API calls that can be made in a minute for Fresteam API are determined by the plan selected by the organization. The rate limit variation for each plan is dependent on the number of subscribed employees for the organization. The trial account has a limit of 10 API calls per minute, which goes on to as high as (100, 2 * number of subscribed employees) API calls per minute for the enterprise plan. Developers or admins can also keep a track of the API calls to understand their usage patterns via:

‍

X-ratelimit-total: Permissible number of API calls in a minute.
X-ratelimit-remaining: Number of API calls remaining.
X-ratelimit-used-currentrequest: Number of API calls consumed by the API request that obtained the response.

‍

There are several endpoints in Freshteam API which retrieve bulk data, especially the ones which are required to List a certain object. In such a case, developers can use pagination parameters to filter data and limit the responses for a streamlined understanding. Developers can select the page value (from which page number they want responses), as well as the number of responses required for each page (default is set at 50). They can also sort the values as ascending or descending or select some other attribute for sorting as well.

Freshteam API Objects, Data Models & Endpoints

Employees

List all employees: GET /employees
Create an employee: POST /employees
Retrieve employee information: GET /employees/{id}
Update employee information: PUT /employees/{id}
List all employee fields: GET /employee_fields
Create a custom employee field: POST /employee_fields

‍

Common attributes: id, created at, updated at, workstation number, date of birth, gender, address, communication address, designation, phone number, joining date, termination date, first name, last name, status, official email, personal email, employee type, team id, department id, reporting to id, time off, hire reason, marital status, etc.

Branches

(Used to configure different geographical locations for an organization and associate employees to a branch)

‍

List all branches: GET /branches

‍

Common attributes: id, created at, updated at, name, street, state, country code, zip, time zone, currency, language, main office, date format

Departments & Sub-Departments

List all departments: GET /departments
List all sub-departments: GET /sub_departments

Business Units

List all business units: GET /business_units

‍

Common attributes: id, created at, updated at, name, description

Teams

List all teams: GET /teams

Levels

List all levels: GET /levels

Timeoffs

List all timeoffs: GET /time_offs
Create a timeoff request: POST /time_offs
List all timeoff types: GET /time_off_types
Retrieve timeoff information: GET /time_off_types/{id}
Cancel A Timeoff Request: PUT /time_off_types/{id}/ cancel
Approve A Timeoff Request: PUT /time_off_types/{id}/ approve

‍

Common attributes: id, created at, updated at, start date, end date, status, leave units, leave type id, status comments, comments, attachment, applied by, approved by, rejected by, canceled by, notify to, description, add to calendar, canceled at, optional leave days, applicable for, auto approve, status

Roles

List all roles: GET /roles

Job Postings

List all job postings: GET /job_postings
Retrieve job posting information: GET /job_postings/{id}
List all job posting fields: GET /job_posting_fields
List all applicant fields: GET /job_postings/{id}/applicant_fields
Create an applicant: POST /job_postings/{id}/applicants

‍

Common attributes: id, created at, updated at, deleted, title, description, status, show_pursue_as_career, closing date, experience, remote, type, salary, branch, department, title, location, skills, requisitions, label, field type, position, candidate, candidate id, first name, last name, date of birth, mobile, phone number, source id, resume, cover letter, portfolio, skype id, content file name, url, gender, profile link, rejected at, archived at, on hold at, on hold till

Candidate Sources

List all candidate sources: GET /candidate_sources
Create a candidate source: POST /candidate_sources
List all candidate source categories: GET /candidate_source_categories

‍

Common attributes: id, created at, updated at, deleted, label, default, leads count

User Functions

List all user functions: GET /user_functions

New Hires

Create a new hire: POST /new_hires
Retrieve new hire information: GET /new_hires/{id}
Update new hire information: PUT /new_hires/{id}

‍

Common attributes: id, created at, updated at, deleted, first name, middle name, last name, official email, employee id, status, workstation number, designation, joining date, probation start date, probation end date, branch id, team id, department id, sub department id, termination date, termination reason, notice period, notice start date, notice end date, employee type, hired on, no show, no show reason, date of birth, marital status, gender, blood group, emergency contacts, social profiles, address, communication address, phone numbers, job codes, job exempt, scheduled weekly hours, retirement eligibility date, rehire eligibility, rehire status, confirmed, language, branch, team

Freshteam API Use Cases

Centralize HR operations with AI-powered virtual agents, self-service solutions and seamless integration with MS Teams, Slack, and other applications
Automate internal processes with easy-to-configure workflows, leading to streamlined work and increased efficiency
Leverage 50+ job descriptions out of the box for use to accelerate hiring processes
Capture qualitative feedback about candidates along with better candidate relationships through built-in email and a manageable candidate database

Top customers

50,000+ companies from across 120+ countries use Freshteam to power their HR operations and streamline processes to make them efficient, robust and optimized. Here are some of the top customers that are leveraging Freshteam:

‍

Gartner, Inc., an American technological research and consulting firm
OpeninApp, a smart link generator tool that ensures all social media links open in the apps they should
Dymocks Booksellers, an Australian-founded privately owned bookstore chain
Valley Medical Center, a 321-bed, acute care community hospital and clinic network
Kirat Plastics, a full-service custom plastic injection molding, metal pressing, fabrication, and assembly facility
Lot Squared Development, a Washington DC based design-build residential real estate developer

Freshteam API FAQs

Here is a list of Freshteam API FAQs that developers must understand to make their integration journey more effective and robust:

‍

How to use Freshteam Developer API? Answer
Where to find Freshteam API key, how to reset it and Scope of an API Key? Answer
What are the status and error messages that indicate the success or failure of an API request in Freshteam API? Answer
What are the common request header parameters used in requests to Freshteam APIs? Answer
What are the API methods that developers interact with for Freshteam API? Answer
What are models in Freshteam API? Answer

Common Integrations with Freshteam API

Businesses, especially those engaged in the employee side of work, are increasingly seeking integration with Freshteam API to streamline data exchange between this HRIS platform and their application. Some of the top use cases and common integrations with Freshteam API include:

‍

Recruitment companies which can use the write APIs to update candidate information into Freshteam once a client is hired to ensure the customer’s HRIS is up to date for all onboarding and future requirements
Payroll providers can leverage both read APIs to fetch employee information for payroll creation and disbursement, as well as write APIs, to push back data into customer’s Freshteam account to notify that salaries have been paid
Rewards and recognition companies which can use integration with Freshteam API to fetch information on employees to seamlessly manage their operations and help end customers build a culture of recognition.

How to integrate with Freshteam API

To kickstart the integration journey with Freshteam API, developers can go through this quick start guide. The first step is to create a developer account and join the Freshteam developer community. Next developers need to follow the installation instructions to install the API SDK. Following this it is important to get acquainted with the authorization and authentication protocols to access data and make API calls. Learn about the terms of use for accessing or using the Freshteam developer portal and understand the different terminology used. For more support and information, businesses can scroll through the Freshteam support page and get answers to their queries.

Get started with Freshteam API

Companies that integrate with Freshteam API benefit from the seamless exchange of information between this HRIS platform and their application and have been able to explore multiple use cases for their end customers. However, manually building and maintaining integration with Freshteam API can be a daunting task for developers. Building the integration alone can take 4 weeks on an average and cost USD 10K (considering the cost of software developers, QA engineers, etc.). Further, the cost associated with maintaining the Freshteam API adds another burden on the bottom line, while diverting resources away from core product functionalities and enhancements. And, this is for a single HRIS integration in question here (Freshteam API). Businesses generally need to integrate with multiple HRIS APIs, meeting the demands of their end customers. Here, a unified HRIS API like Knit can enable businesses to easily integrate with multiple HRIS applications with a single connector. By incorporating an additional layer of abstraction, a unified API allows businesses to ship and scale integrations faster and in an efficient manner. Book a discovery call today to learn how developers can integrate with Freshteam API and other HRIS applications within hours and not weeks.

‍

GET https://api.zenefits.com/platform/applications

A Guide to Integrating with Zenefits APIs

Zenefits API Directory

TriNet Zenefits is a leading provider of full service HR solutions. It enables small and medium sized companies to administer and manage benefits, HR offerings, including time tracking, onboarding, employee engagement, employee record keeping; payroll; performance and well-being. As a highly sought after HRIS platform, companies have been increasingly integrating with TriNet Zenefits to facilitate seamless exchange of HRIS data, captured by Zenefits, with their own apps to drive diverse use cases.

Zenefits API Authentication, Filtering, Rate Limits

Owing to the sensitive nature of information held by the HRIS application, including personal identifiable information (PII), Zenefits API ensures that all data scopes are accessed at a granular level. The Zenefits API uses OAuth2 to authenticate and authorize access to information stored in the application. OAuth2 authorizes third party applications to request private details from Zenefits accounts, without passwords. It is limited only to admins and developers receive unique Client ID and Client Secret to access data with integration.

‍

Zenefits API pagination helps developers define the records needed per page. The developers can use the limit parameter to specify the number of records in a response. The maximum limit can be 100, however, in case the limit is not defined, the default limit is 20. In case the total number of records do not fit into a single page, the next_url field will have a link to the next page with the remaining records. In case the next_url field displays null, then no records exist for subsequent pages. Developers can also use the starting_after or ending_before query parameter to specify pagination based on object ids. The ending_before query parameter is useful for backwards pagination.

Zenefits API Objects, Data Models & Endpoints

It is extremely important for developers to understand the objects, data models and endpoints when it comes to integrating with Zenefits API. While the overall scope might be large, here are a few which can be considered as a starting point for Zenefits API integration.

‍

Applications: Used to return information about the application

‍

Companies: Used to get information about the company

GET https://api.zenefits.com/core/companies

Fields include: ‘legal_name', 'ein','departments', 'locations'

‍

People: Used to return information about a company’s employees

GET https://api.zenefits.com/core/companies/{:company_id}/people

GET http://api.zenefits.com/core/people/{:id} (For information about a single employee)

GET http://api.zenefits.com/core/people (For information for all employees across the company)

Fields include: 'work_email', 'date_of_birth', 'manager', 'department', 'location', 'work_phone', 'status', 'subordinates', 'banks','company', 'employments', 'department', 'location', 'manager', 'banks'

‍

Employments: Used to return information about an employee’s employment history

GET https://api.zenefits.com/core/people/{:person_id}/employments

GET https://api.zenefits.com/core/employments/{:employment_id} (For information on a specific employment

GET https://api.zenefits.com/core/employments (For information on all employments across all people)

Fields include: 'termination_type', 'employment_type', 'comp_type', 'annual_salary', 'pay_rate', 'working_hours_per_week','person'

‍

Employee Bank Accounts: Used to return information about employee’s bank account

GET https://api.zenefits.com/core/people/{:person_id}/banks

GET http://api.zenefits.com/core/banks/{:bank_id} (For information for a specific bank)

GET http://api.zenefits.com/core/banks (For information for all banks across all people)

‍

Departments: Used to return the list of a company’s department

GET https://api.zenefits.com/core/companies/{:id}/departments

GET http://api.zenefits.com/core/departments/{:department_id} (For information regarding a single department:

GET http://api.zenefits.com/core/departments (For information relating to all departments across all companies)

‍

Locations: Used to return the list of a company’s location

GET https://api.zenefits.com/core/companies/{:company_id}/locations

GET http://api.zenefits.com/core/locations/{:location_id} (For information relating to a single location)

GET http://api.zenefits.com/core/locations (For information relating to all locations across all companies)

‍

Vacation Requests: Used to return information about employees' PTO vacation requests

GET https://api.zenefits.com/time_off/vacation_requests

GET http://api.zenefits.com/time_off/vacation_requests/{:id} (For information relating to a single vacation request)

GET http://api.zenefits.com/time_off/vacation_types/{:vacation_type_id}/vacation_requests/ (For all vacation requests for a single vacation type)

Fields include:

status: Requested, approved, denied, cancelled, deleted
vacation_type: Vacation Type for this request, e.g. Jury Duty, Work From Home, Doctor's Appointment
start_date: Start date of vacation request (inclusive)
end_date: End date of vacation request (inclusive)
creator i.e. Person who filed this vacation request
person i.e. Person who this vacation request applies to (often the same as creator)
created_date: Date this vacation request was created
hours: Number of hours requested, generally calculated at 8 hours a day for multi-day requests and specified manually for single day requests
approved_date: Date this request was moved from requested status, either to approved or denied.
reason: Note from the person requesting this vacation
deny_reason: Note from the approver for why this vacation request was denied. (Only applies if status is denied)

‍

Vacation Types: Used to return information about a company's PTO vacation types

GET https://api.zenefits.com/time_off/vacation_types

GET http://api.zenefits.com/time_off/vacation_types/{:id} (For information relating to a single vacation type)

Fields include:

status: Active, deleted
vacation_types
name: Name of the type
company: Company for this vacation type
vacation_requests: Vacation Requests for this type
counts_as: What account this type counts towards (vacation, sick, personal)

‍

Time Durations: Used to return information about a person's T&A hours

GET https://api.zenefits.com/time_attendance/time_durations

GET http://api.zenefits.com/time_attendance/time_durations/{:id} (For information relating to a single time duration object)

Fields include:

person: Person that this time duration is logged for people
activity: Activity type (work, meal_break)
state: Effective, overridden, deleted, correction
valid_status: valid, exceeds, overlapping same day, overlapping previous day, overlapping next day, missing clock out, missing clock in
hours: Number of hours logged
start: When this time duration started
end: When this time duration ended
is_overnight: Whether this time duration has been marked as part of an overnight shift
is_approved: When this time duration was approved.
approver: Person who approved this time duration

Zenefits API Use Cases

Automate onboarding, saving 100s of hours as information gets auto synced to Benefits and Payroll
Simplify employee management with organizational charts, company directories allowing employees to update their own records
Improve HR processes and decision making with business intelligence reports and insights on turnover, workforce diversity, with understanding of how to pay new hires
Simplify the process of providing great benefits to employees, from comprehensive healthcare plans to extra perks like commuter benefits
Facilitate time and attendance management with employee scheduling tools, with time off and clocked-in hours automatically syncing Payroll

Zenefits API FAQs

Here is a list of FAQs about TriNet Zenefits API which can help commence and accelerate your integration:

‍

What is the software stack of Zenefits? Answer
How to address the CORS issue in Angular 8 without changing the backend in Zenefits API? Answer
How to handle New Company Installations in TriNet Zenefits API? Answer
How to handle New People's Subscriptions in TriNet Zenefits API? Answer
What does Webhooks shared secret vs OAuth client secret mean? Answer
How to read and write custom data with Zenefits API? Answer
How to issue Access Tokens for Zenefits API authentication and authorization? Answer
Where can I find a guidebook for Zenefits integration? Answer
Does Zenefits have a public API? Answer
What is Zenefits’ App Acceptance Criteria for API integration? Answer
Where is the developer portal for Zenefits API? Answer

Common Integrations with Zenefits API

Several businesses are increasingly building integrations with Zenefits API to power operations for the end customers, facilitated by seamless data exchange, including:

‍

Payroll providers to get access to employee information, employment records and agreement terms, compensation details and other relevant information like leaves, time off, etc.
Candidate recruitment companies to push data about selected candidates and relevant information for smooth onboarding
Employee engagement companies to fetch employee data, including demographic information, personal and professional details, attendance, etc.
Early wage access providers to get access to employee information, payroll details and even write back data regarding early payments/ deductions for accurate payroll processing

How to integrate with Zenefits API

To get started with the Zenefit API integration journey, a developer account needs to be created. To create the same, developers can reach out to Zenefits team by dropping an email on this email address. Reaching out on this email ID will take the developers to the next step to get access to a sandboxed Zenefits test company and credentials to start using the API. Once the Zenefits developer account is active, developers can leverage this getting started guide for a detailed overview on REST API, Modules, Webhooks, Authentication and much more. It is important to read through and understand the App Acceptance Criteria well. The same can be accessed here. At the same time, knowledge of the Zenefits Developer Policy is critical to understand the technical, brand and general requirements and restrictions.

Get started with Zenefits API

Integrating with Zenefits API is beneficial for businesses looking to seamlessly exchange data with this leading HRIS provider with bi-directional sync. However, building a custom 1:1 integration can be a complex, time and resource intensive process. The above mentioned steps, restrictions and requirements can all choke up developer bandwidth. Invariably, SaaS businesses today are moving away from building integrations to partnering with unified APIs like Knit. A unified API, in this case for HRIS integrations, enables companies to integrate once and seamlessly connect with multiple HRIS applications, including Zenefits API, without any additional requirements. With a unified HRIS API, maintenance and management of integration with Zenefits and other applications also becomes quite easy. Book a discovery call today to learn how a unified API can help you ship and scale integrations fast.

‍

GET https://api.gusto-demo.com/v1/companies/{company_id}/locations

Mar 19, 2024

Gusto API Directory

Gusto is an online payroll and HR solutions company. Backed by global expertise Gusto provides companies with one easy, integrated platform, to automate and simplify payroll, benefits, and HR processes. From time tracking, to performance management, analytics and even benefits administration, Gusto application enables businesses to make HR management seamless and streamlined, while saving hours and reducing human errors considerably.

Gusto API Authentication, Pagination, Rate Limits

As a security first application, Gusto leverages OAuth2 for authentication. Gusto API integration uses two types of tokens for security and authentication. On the one side are organization level API tokens which can be accessed through the Developer Portal. Additionally, there are company level tokens (generally access tokens or refresh tokens), which are provided via the OAuth2 process. It is very important for developers building integrations with Gusto API to manage, store and maintain all tokens securely to prevent unauthorized authentication and access.

‍

Essentially, API tokens are used specifically for organization level endpoints, like creating a company, and cannot be used for company or employee level endpoints. For the latter, developers must focus on access tokens via OAuth2. To facilitate higher levels of security, Gusto API ensures that all endpoints which are authenticated via access tokens require a strict access token, which is reserved for access only to a single company.

‍

Gusto API endpoints support pagination. To use pagination, developers can add a page and a per parameter to their URL’s query string. The page can define the page number from where records are sought, and the per parameter dictates the number of records per page. In case the per parameter is left blank, by default 25 records will be returned. Each endpoint’s documentation reflects on whether or not it supports pagination.

‍

To ensure high performance throughput, Gusto API maintains an API rate limit of 200 requests per minute. This suggests that 200 API calls can be made within the 60 second time window, beyond which a violation will be evaluated. A 429 error, highlighting too many requests will be displayed if the rate limit is hit for an active integration and the request will be subsequently rejected.

Gusto API Objects, Data Models & Endpoints

An understanding of the Gusto API objects, data models and endpoints is extremely important for developers seeking to build integrations with Gusto API. Some of the key endpoints include:

Companies

Create a company

POST https://api.gusto-demo.com/v1/provision

Get a company

GET https://api.gusto-demo.com/v1/companies/{company_id}

Get the custom fields of a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/custom_fields

Locations

Create a company location

POST https://api.gusto-demo.com/v1/companies/{company_id}/locations

Get company locations

Get a location

GET https://api.gusto-demo.com/v1/locations/{location_id}

Update a location

PUT https://api.gusto-demo.com/v1/locations/{location_id}

Get minimum wages for a location

GET https://api.gusto-demo.com/v1/locations/{location_uuid}/minimum_wages

Pay Schedules

Get the pay schedules for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/pay_schedules

Get a pay schedule

GET https://api.gusto-demo.com/v1/companies/{company_id}/pay_schedules/{pay_schedule_id}

Get pay periods for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/pay_periods

Get pay schedule assignments for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/pay_schedules/assignments

Departments

Create a department

POST https://api.gusto-demo.com/v1/companies/{company_uuid}/departments

Get all departments of a company

GET https://api.gusto-demo.com/v1/companies/{company_uuid}/departments

Get a department

GET https://api.gusto-demo.com/v1/departments/{department_uuid}

Update a department

PUT https://api.gusto-demo.com/v1/departments/{department_uuid}

Delete a department

DELETE https://api.gusto-demo.com/v1/departments/{department_uuid}

Add people to a department

PUT https://api.gusto-demo.com/v1/departments/{department_uuid}/add

Remove people from a department

PUT https://api.gusto-demo.com/v1/departments/{department_uuid}/remove

Earning Types

Create a custom earning type

POST https://api.gusto-demo.com/v1/companies/{company_id}/earning_types

Get all earning types for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/earning_types

Update an earning type

PUT https://api.gusto-demo.com/v1/companies/{company_id}/earning_types/{earning_type_uuid}

Deactivate an earning type

DELETE https://api.gusto-demo.com/v1/companies/{company_id}/earning_types/{earning_type_uuid}

Payrolls

Get all payrolls for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/payrolls

Get a single payroll

GET https://api.gusto-demo.com/v1/companies/{company_id}/payrolls/{payroll_id}

Update a payroll by ID

PUT https://api.gusto-demo.com/v1/companies/{company_id}/payrolls/{payroll_id}

Prepare a payroll for update

PUT https://api.gusto-demo.com/v1/companies/{company_id}/payrolls/{payroll_id}/prepare

Contractor Payments

Get contractor payments for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/contractor_payments

Get a single contractor payment

GET https://api.gusto-demo.com/v1/companies/{company_id}/contractor_payments/{contractor_payment_id}

Company Benefits

Create a company benefit

POST https://api.gusto-demo.com/v1/companies/{company_id}/company_benefits

Get benefits for a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/company_benefits

Get a company benefit

GET https://api.gusto-demo.com/v1/company_benefits/{company_benefit_id}

Update a company benefit

PUT https://api.gusto-demo.com/v1/company_benefits/{company_benefit_id}

Delete a company benefit

DELETE https://api.gusto-demo.com/v1/company_benefits/{company_benefit_id}

Get all benefits supported by Gusto

GET https://api.gusto-demo.com/v1/benefits

Get a supported benefit by ID

GET https://api.gusto-demo.com/v1/benefits/{benefit_id}

Get company benefit summary by company benefit id.

GET https://api.gusto-demo.com/v1/company_benefits/{company_benefit_id}/summary

Get benefit fields requirements by ID

GET https://api.gusto-demo.com/v1/benefits/{benefit_id}/requirements

Employees

Create an employee

POST https://api.gusto-demo.com/v1/companies/{company_id}/employees

Get employees of a company

GET https://api.gusto-demo.com/v1/companies/{company_id}/employees

Get an employee

GET https://api.gusto-demo.com/v1/employees/{employee_id}

Update an employee

PUT https://api.gusto-demo.com/v1/employees/{employee_id}

Delete an onboarding employee

DELETE https://api.gusto-demo.com/v1/employees/{employee_id}

Get an employee's custom fields

GET https://api.gusto-demo.com/v1/employees/{employee_id}/custom_fields

Get employee time off activities

GET https://api.gusto-demo.com/v1/employees/{employee_uuid}/time_off_activities

Employee Employments

Get terminations for an employee

GET https://api.gusto-demo.com/v1/employees/{employee_id}/terminations

Get an employee rehire

GET https://api.gusto-demo.com/v1/employees/{employee_id}/rehire

Get employment history for an employee

GET https://api.gusto-demo.com/v1/employees/{employee_id}/employment_history

Employee Addresses

Get an employee's home addresses

GET https://api.gusto-demo.com/v1/employees/{employee_id}/home_addresses

Create an employee's home address

POST https://api.gusto-demo.com/v1/employees/{employee_id}/home_addresses

Get an employee's home address

GET https://api.gusto-demo.com/v1/home_addresses/{home_address_uuid}

Update an employee's home address

PUT https://api.gusto-demo.com/v1/home_addresses/{home_address_uuid}

Delete an employee's home address

DELETE https://api.gusto-demo.com/v1/home_addresses/{home_address_uuid}

Get an employee's work addresses

GET https://api.gusto-demo.com/v1/employees/{employee_id}/work_addresses

Create an employee work address

POST https://api.gusto-demo.com/v1/employees/{employee_id}/work_addresses

Get an employee work address

GET https://api.gusto-demo.com/v1/work_addresses/{work_address_uuid}

Update an employee work address

PUT https://api.gusto-demo.com/v1/work_addresses/{work_address_uuid}

Delete an employee's work address

DELETE https://api.gusto-demo.com/v1/work_addresses/{work_address_uuid}

Jobs and Compensations

Create a job

POST https://api.gusto-demo.com/v1/employees/{employee_id}/jobs

Get jobs for an employee

GET https://api.gusto-demo.com/v1/employees/{employee_id}/jobs

Get a job

GET https://api.gusto-demo.com/v1/jobs/{job_id}

Update a job

PUT https://api.gusto-demo.com/v1/jobs/{job_id}

Delete an individual job

DELETE https://api.gusto-demo.com/v1/jobs/{job_id}

Get compensations for a job

GET https://api.gusto-demo.com/v1/jobs/{job_id}/compensations

Create a compensation

POST https://api.gusto-demo.com/v1/jobs/{job_id}/compensations

Get a compensation

GET https://api.gusto-demo.com/v1/compensations/{compensation_id}

Update a compensation

PUT https://api.gusto-demo.com/v1/compensations/{compensation_id}

Delete a compensation

DELETE https://api.gusto-demo.com/v1/compensations/{compensation_id}

Employee Benefits

Create an employee benefit

POST https://api.gusto-demo.com/v1/employees/{employee_id}/employee_benefits

Get all benefits for an employee

GET https://api.gusto-demo.com/v1/employees/{employee_id}/employee_benefits

Get an employee benefit

GET https://api.gusto-demo.com/v1/employee_benefits/{employee_benefit_id}

Update an employee benefit

PUT https://api.gusto-demo.com/v1/employee_benefits/{employee_benefit_id}

Delete an employee benefit

DELETE https://api.gusto-demo.com/v1/employee_benefits/{employee_benefit_id}

Create year-to-date benefit amounts from a different company

POST https://api.gusto-demo.com/v1/employees/{employee_id}/ytd_benefit_amounts_from_different_company

Garnishments

Create a garnishment

POST https://api.gusto-demo.com/v1/employees/{employee_id}/garnishments

Get garnishments for an employee

GET https://api.gusto-demo.com/v1/employees/{employee_id}/garnishments

Get a garnishment

GET https://api.gusto-demo.com/v1/garnishments/{garnishment_id}

Update a garnishment

PUT https://api.gusto-demo.com/v1/garnishments/{garnishment_id}

Gusto API Use Cases

Automate employee time tracking (with flexible scheduling and remote work options), approval and accurate payroll creation
Rely on robust and customizable checklists for employee onboarding and ensure software provisioning with a few clicks
Automate workflow for performance management including self evaluation, manager review and career development sources with custom performance software
Leverage customizable reports, anonymous team surveys, automatic compliance alerts for holistic team insights
Create a payroll which runs on autopilot with automated calculations, compliances and much more

Top customers

Serving 300,000+ businesses, Gusto API is the preferred HR and payroll solutions provider for many global names, including:

Little Fish Accounting, a boutique CPA firm providing small businesses, entrepreneurs, and freelancers with accounting + tax support
ApproveMe.com, a document signing experience™ that helps businesses build better relationships with their signers
Snapbar, a company that develops intuitive, web-based products leveraging the power of photo and video
Heckler Design, a firm that creates beautifully simple, commercial-grade hardware and furniture for design-conscious consumers and businesses
Floyd Lee Locums, a company that provides an elite concierge experience to physicians, CRNAs, nurse practitioners, physician assistants, and other healthcare providers

Gusto API FAQs

Following is a list of FAQs that can help guide your Gusto API integration journey:

‍

How do I get access to a sandbox environment to build Gusto API integration? Answer
How do I get API keys for Gusto API? Answer
Can I change the redirect URI for the API Keys? Answer
How long does it usually take to build an integration with Gusto API? Answer
Once an employee is created in Gusto via the API, what happens next? Answer
What’s required to obtain API Keys for Production? Answer
What debits can I expect to see via the Gusto API? Answer
Can I make test calls in production after my Gusto API integration has passed QA and launched? Answer
What are the error codes associated with Gusto API? Answer
How can I create a job ID and compensation for an employee in Gusto API? Answer
Does Gusto API have any sample codes I can use to get started on? Answer
What kind of support will I get when building my integration? Answer

Common Integrations with Gusto API

Undoubtedly, there are several categories of applications which can benefit from integrating with Gusto API. Listing a few for developers to get an idea:

‍

ATS applications to push newly hired candidate data
Performance management systems to get access to employee rosters and information
HR analytics platforms to get access to employee data, including payroll, compensation, etc.
Benefits applications to facilitate accurate deductions and benefits administration

How to integrate with Gusto API

To commence your integration journey with Gusto API, it is important to create a developer account. You can sign up for an account here. Once you sign up for a developer account, the next steps are quite streamlined. It involves accepting the terms of service, setting up the account, creating the application to get access to your unique Gusto API keys. As a best practice, it is ideal to go through the detailed documentation and guides offered by Gusto API to understand the diverse aspects of integration. You can check out the documentation resource to answer all questions you may have, here. Gusto API also offers a sandbox functionality to test and demo your work, before making a firm commitment.

Get started with Gusto API

Developers can build Gusto API integration for their applications following the steps mentioned in the section above and by leveraging the documentation shared. However, building one integration can take up to 4-6 weeks on an average, utilizing a lot of developer bandwidth, becoming a cost intensive project. In case you need to build more than one HRMS integration, leveraging a unified API like Knit is ideal. A unified API adds an additional layer of abstraction on top of the API, ensuring that developers only have to integrate with one unified API to connect with several HRMS applications supported by the unified API. To understand how a unified API like Knit can help your integration journey, book a demo today.

‍

Mar 19, 2024

Paylocity API Directory

Paylocity is a market leader in providing cloud-based payroll and human capital management software. It provides intuitive and easy to use products that enable businesses to automate and streamline their HR and payroll processes, facilitate better hiring practices and build a culture of retention and engagement. To facilitate connections with different applications, Paylocity offers open, developer-friendly APIs. With automation at the core, Paylocity API ensures that updates, i.e. when payroll is processed or when there is any change in the employee base (hire, transfer, termination) webhooks are pushed to reflect the changes.

‍

This article will help you understand how Paylocity API functions, how developers can authenticate and access the same. Furthermore, it will highlight the different endpoints, use cases and FAQs that are integral to a smooth integration journey. Finally, it will discuss the common integration use cases for Paylocity API, focusing on the category of applications that can seamlessly integrate with Paylocity for business impact.

Paylocity API Authentication, Filtering, Rate Limits

To ensure safe and limited access, Paylocity API leverages OAuth2 for authentication using Client Credentials. In this form of authentication, each API call to Paylocity API is accompanied by a HTTP Header named Authorization, along with a bearer token (with limited time validity), from the Paylocity Identity Provider. The token for authentication only has a life of 60 minutes and expires post that. Using an expired token will lead to a failed response. To receive the token, you must have client_id and secret.

‍

API filtering is quite an important attribute when it comes to ensuring that only relevant data is exchanged and also increases the speed of exchange. Paylocity API filtering works on the principle of request-response communication. Whenever an API request is made to the server, the filter criteria must be specified. Subsequently, once the server processes this request, the filter is applied and only relevant data, which meets the criteria is sent back.

‍

To prevent overuse or overconsumption of resources, Paylocity API has set rate limits, permitting up to 40,000 calls per hour. If more requests are made than the set limit, a 403 forbidden error message appears, indicating overuse. To prevent overuse of API calls and to stay within the rate limit, developers can optimize their code to minimize the API calls made per minute, by caching data, removing redundant requests and making API calls only when necessary. Implementing rate limiting logic, and retry mechanism can also help in error handling.

Paylocity API Objects, Data Models & Endpoints

To integrate with Paylocity API, it is important to have an understanding of the objects, data models and endpoints you will be working with. Here’s a quick starting point:

‍

Add / Update Deduction (sends new or updated employee deduction information directly to Paylocity Payroll/HR solution)

POST https://apisandbox.paylocity.com/api/v1/deduction

Delete deduction for deduction code / start date

DELETE https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}/{startDate}

Get All Deductions (returns all deductions for the selected employee)

GET https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/deductions

Get Deduction for Deduction Code (returns records for a specific deduction for the selected employee)

GET https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/deductions/{deductionCode}

Add Employee to Onboarding (sends employee data into Paylocity Onboarding to help ensure an easy and accurate hiring process)

POST https://apisandbox.paylocity.com/api/v1/companies/{companyId}/onboarding/employees

Get Local Tax for Tax Code (returns local tax information for the specific tax code for the selected employee)

GET https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode}

Update Local Tax (sends updated local tax code information for the selected employee)

PUT https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode}

Delete Local Tax for Tax Code (deletes the local tax code from Paylocity Payroll/HR solution)

DELETE https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode}

Get All Local Taxes (returns all local tax information for the selected employee)

GET https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes

Add Local Tax (sends new local tax information directly to Paylocity Payroll/HR solution)

POST https://apisandbox.paylocity.com/api/v1/companies/{companyId}/employees/{employeeId}/localTaxes

Add/update additional rates (sends new or updated employee additional rates information directly to Paylocity Payroll/HR solution)

PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/additionalRates

Get All Company Codes

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/codes/{codeResource}

Get All Custom Fields

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/customfields/{category}

Get All Direct Deposit (returns main direct deposit and all additional direct deposits for the selected employee)

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/directDeposit

Get All Earnings (returns all earnings for the selected employee)

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings

Add/Update Earning (sends new or updated employee earnings information directly to Paylocity Payroll/HR solution)

PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings

Get Earning by Earning Code and Start Date (returns the single earning with the provided earning code and start date for the selected employee)

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{startDate}

Delete Earning by Earning Code and Start Date

DELETE https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{startDate}

Get Earnings by Earning Code (returns all earnings with the provided earning code for the selected employee)

GET

https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}

Add/update emergency contacts (sends new or updated employee emergency contacts directly to Paylocity Payroll/HR solution)

PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/emergencyContacts

Add/update employee's benefit setup (sends new or updated employee benefit setup information directly to Paylocity Payroll/HR solution)

PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/benefitSetup

Get all employees (returns employee data currently available in Paylocity Payroll/HR solution)

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees

Add new employee (sends new employee data directly to Paylocity Payroll/HR solution)

POST https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees

Get employee (returns employee data currently available in Paylocity Payroll/HR solution)

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}

Update employee (updates existing employee data in WebPay)

PATCH https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}

Get sensitive data

GET https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/sensitivedata

Add/update sensitive data (sends new or updated employee sensitive data information directly to Paylocity Payroll/HR solution)

PUT https://apisandbox.paylocity.com/api/v2/companies/{companyId}/employees/{employeeId}/sensitivedata

Gets Retirement Contributions (provides deferrals, loan payments, employer match)

GET https://dc1demogwext.paylocity.com/apiHub/benefits/v1/companies/{companyId}/retirementPlans/{planId}/checks/{checkDate}

Paylocity API Use Cases

Access real-time, visual representation of information through reports, analytics, and dashboards for tracking essential metrics, spotting trends, and making informed decisions based on data.
Simplify the gathering of information, documents, and task management across various users and environments.
Easily create tailored employee appreciation initiatives, oversee rewards and budgets, and monitor program performance instantly.
Measure employee engagement levels to gain insight into potential time and cost efficiencies.
Gather input from colleagues, supervisors, and team members for comprehensive 360-degree feedback. Utilize talent assessment frameworks like the 9-box grid.
Delegate training tasks using an extensive course library, upload custom materials, or empower employee experts to develop and distribute training through our online collaboration platform, Community.
Reduce manual input by automatically incorporating reimbursements into employee paychecks.
Access consolidated global payroll data in real-time for over 100 countries through our integrated payroll system.

Top customers

36,000+ customers use Paylocity for the HR and payroll needs, including:

‍

Meyer Distributing, a leader in automotive specialty products marketing and distribution
Noble House, a curated collection of award-winning boutique hotels, luxury resorts
Crafton Tull, an engineering, design, and surveying firm
HP Piping Solutions, manufacturers and suppliers of high-pressure mud piping, mud gas separators and other drilling-related products
BASIS.ed, a for-profit education management organization based in Scottsdale, Arizona
Momentus Technologies, a global provider of industry leading venue and event management solutions

Paylocity API FAQs

A quick glance on the common FAQs that developers have about Paylocity API can help you accelerate your integration journey:

‍

How to get the REST API cURL Token for Paylocity? Answer
How to retrieve an employee's PTO from Paylocity API? Answer
How to get the Paylocity API Access Token? Answer
How to get the access token for Paylocity Web API in Node.js without getting an error "invalid_client"? Answer
How to use Paylocity API to get employee department? Answer
How to address the issue of pulling data from Paylocity API? Answer
How to get employee custom fields from Paylocity API? Answer
How to extract data from Paylocity API using cloud data fusion? Answer
How to get Paylocity API Access using Python? Answer
What are the requirements to get production credentials and launch Paylocity API integration? Answer
What authentication method do you use to access Paylocity APIs? Answer
How do I find Paylocity APIs that fit my use case? Answer
Is there a cost for using Paylocity’s APIs? Answer

Common Integrations with Paylocity API

Here’s a non-exhaustive list of applications (categories), which can easily integrate with Paylocity API to facilitate easy exchange of employee relevant information and further their impact, without the need to duplicate information upload:

‍

Benefits administration systems to ensure correct allocation and deduction in employee payrolls
Application tracking systems for seamless onboarding, payroll setup, etc.
Payroll and accounting systems to facilitate compensation management
Active employee directories, ensuring all employee data is updated for consumption
Workforce planning tools to set hiring and retention strategy

How to integrate with Paylocity API

Paylocity offers several APIs for different use cases. Therefore, as the first step, you need to understand your integration needs and then identify the right API and endpoints to connect with. The next step is to get the access token to access the sandbox or the demo environment (oAuth credentials). Once you get the access, leverage guides like this one to build, test and go-live with your Paylocity API integration.

Get started with Paylocity API

As visible from the section above, integration with Paylocity API involves several steps and knowledge transfer across several documentation guides. Fortunately, unified API providers like Knit, make it very easy for developers to integrate with Paylocity and multiple other HRIS applications in a very short time. Adding an additional abstraction layer to the API infrastructure, Knit’s unified HRIS API ensures that customers only have to integrate once and they can then connect with all other HRIS applications from there. To understand more about how a unified HRIS API can help you significantly optimize your integration building and management process, book a discovery call today.

‍

GET https://{company}.{environment}.com/api/v1/hris/employees

Mar 19, 2024

Comprehensive Guide to Keka API Directory

Keka is a leading human resources management system that enables organizations to seamlessly manage diverse aspects of their human resource processes, including recruitment and onboarding, attendance and time management, payroll, expense and performance management. With OAuth authentication, rate limiting, pagination, and adherence to industry standards, Keka provides developers with everything they need to build robust integrations with their software/ platform and facilitate data exchange between their application and this leading HRMS portal.

Keka API Authentication, Pagination, Rate Limit

To ensure safe and secure access, Keka API uses OAuth for authentication. This suggests that for successful integration, developers need an access token which can be generated with specific details. This includes client id (identifier for the client), client secret (for secure authentication), api key (unique API key for accessing the system), scope (requires passing kekaapi for this key). To facilitate integration testing for applications, developers can also leverage the Sandbox Environment which is offered by Keka. This allows developers to ensure robust functionality, before integration production begins. Keka APIs already come with pagination implemented to ensure response time optimization. The standard or the default page size in Keka is 100 with 1 being the default page number.

‍

API limit is a critical element of any API and so is the case with Keka, which helps define the number of requests that can be made to Keka within a limited time period. Keka has a rate limit of 50 API requests/ minute. This suggests that once 50 requests are made in a minute, the user needs to wait for the quote to be refilled before any other request is made. The rate limits are enforced and automatically reset after 60 seconds. In case a request is made before the quota is refilled, a 429 error with the reason rateLimitExceeded will be sent.

Keka API Objects, Data Models & Endpoints

As a developer or the representative of an organization seeking to integrate with Keka API, it is important to understand the endpoints that you will be using eventually for data exchange, both when it comes to read APIs (getting data from Keka) as well as write APIs (providing data to Keka).

CORE HR

Employees

Get all Employees

Create an Employee

POST https://{company}.{environment}.com/api/v1/hris/employees

Get an Employee

GET https://{company}.{environment}.com/api/v1/hris/employees/{id}

Get all update fields

GET https://{company}.{environment}.com/api/v1/hris/employees/updatefields

Update Employee personal details

PUT https://{company}.{environment}.com/api/v1/hris/employees/{id}/personaldetails

Update employee job details

PUT https://{company}.{environment}.com/api/v1/hris/employees/{id}/jobdetails

Groups

Get all Groups

GET https://{company}.{environment}.com/api/v1/hris/groups

Get all Group Types

GET https://{company}.{environment}.com/api/v1/hris/grouptypes

Departments

Get all departments

GET https://{company}.{environment}.com/api/v1/hris/departments

Locations

Get all Locations

GET https://{company}.{environment}.com/api/v1/hris/locations

Job Title

Get all job titles

GET https://{company}.{environment}.com/api/v1/hris/jobtitles

Currency

Get all currencies

GET https://{company}.{environment}.com/api/v1/hris/currencies

Notice Period

Get all notice periods

GET https://{company}.{environment}.com/api/v1/hris/noticeperiods

LEAVE

Leave Types

Get all Leave Types

GET https://{company}.{environment}.com/api/v1/time/leavetypes

Leave Balance

Get all Leave balances

GET https://{company}.{environment}.com/api/v1/time/leavebalance

Leave Requests

Get all Leave Requests

GET https://{company}.{environment}.com/api/v1/time/leaverequests

Create an Leave Request

POST https://{company}.{environment}.com/api/v1/time/leaverequests

ATTENDANCE

Attendance

Get all Attendance Records

GET https://{company}.{environment}.com/api/v1/time/attendance

Attendance Capture Scheme

Get all captureschemes

GET https://{company}.{environment}.com/api/v1/time/capturescheme

Holiday Calendar

Get all holidays Calendar

GET https://{company}.{environment}.com/api/v1/time/holidayscalendar

PAYROLL

Salary Components

Get all Salary Components

GET https://{company}.{environment}.com/api/v1/payroll/salarycomponents

Pay Groups

Get all Pay Groups

GET https://{company}.{environment}.com/api/v1/payroll/paygroups

Pay Cycles

Get all Pay Cycles

GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles

Get Pay Register

GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/payregister

Get all Pay Batches

GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/paybatches

Get all Batch Payments

GET https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/paybatches/{payBatchId}/payments

Update the Payments status

PUT https://{company}.{environment}.com/api/v1/payroll/paygroups/{payGroupId}/paycycles/{payCycleId}/paybatches/{payBatchId}/payments

Pay Grades

Get all Pay Grades

GET https://{company}.{environment}.com/api/v1/payroll/paygrades

Pay Bands

Get all Pay Bands

GET https://{company}.{environment}.com/api/v1/payroll/paybands

PSA

Clients

Get all clients

GET https://{company}.{environment}.com/api/v1/psa/clients

Create a Client

POST https://{company}.{environment}.com/api/v1/psa/clients

Get a client

GET https://{company}.{environment}.com/api/v1/psa/clients/{id}

Update a Client

PUT https://{company}.{environment}.com/api/v1/psa/clients/{id}

Project Phases

Get project phases.

GET https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/phases

Create a Project Phase

POST https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/phases

Projects

Get all projects.

GET https://{company}.{environment}.com/api/v1/psa/projects

Create a Project

POST https://{company}.{environment}.com/api/v1/psa/projects

Get a project

GET https://{company}.{environment}.com/api/v1/psa/projects/{id}

Update a Project

PUT https://{company}.{environment}.com/api/v1/psa/projects/{id}

Get a project allocations

GET https://{company}.{environment}.com/api/v1/psa/projects/{id}/allocations

Get project timesheet entries.

GET https://{company}.{environment}.com/api/v1/psa/projects/{id}/timeentries

Tasks

Get project tasks.

GET https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks

Create a task

POST https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks

Update a task

PUT https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks/{taskId}

Get project task time entries.

GET https://{company}.{environment}.com/api/v1/psa/projects/{projectId}/tasks/{taskId}/timeentries

PMS

Time Frames

Get time frame list.

GET https://{company}.{environment}.com/api/v1/pms/timeframes

Goal

Get goal list.

GET https://{company}.{environment}.com/api/v1/pms/goals

Update goal progress

PUT https://{company}.{environment}.com/api/v1/pms/goals/{goalId}/progress

Badge

Get badge list.

GET https://{company}.{environment}.com/api/v1/pms/badges

Praise

Add Praise

POST https://{company}.{environment}.com/api/v1/pms/praise

EXPENSE

Expense Category

Get all Expense Categories

GET https://{company}.{environment}.com/api/v1/expense/categories

Expense

Get all Expense Claims

GET https://{company}.{environment}.com/api/v1/expense/claims

Expense Policy

Get all expense policies

GET https://{company}.{environment}.com/api/v1/expensepolicies

ASSETS

Asset

Get all Assets

GET https://{company}.{environment}.com/api/v1/assets

Asset Type

Get all Asset Types

GET https://{company}.{environment}.com/api/v1/assets/types

Asset Category

Get all Asset Categories

GET https://{company}.{environment}.com/api/v1/assets/categories

Asset Condition

Get all Asset Conditions

GET https://{company}.{environment}.com/api/v1/assets/conditions

Keka API Use Cases

Easy payroll processing and integration with attendance and leave to ensure proper calculation of payroll and taxes
Covers every HR workflow to manage people processes, including hiring, onboarding, probation confirmation, internal movements, etc.
Streamline all HR operations with automated workflows, comprehensive analytics, and hassle-free employee management
Conduct a multi-dimensional assessment of employees' abilities, behavioral competencies, and performance for constructive team evaluation
Get an accurate view of revenue against each project, resources allocation, and amount of time spent
Robust attendance management system that integrates every aspect of time tracking, including scheduling shifts, and tracking over-time, fully integrated with payroll

Top Customers

Keka, as an HRMS tool, is widely used with 5000+ customers, including:

‍

Noise, India's trusted wearable watch brand
GrabOn, one of India’s top players in the coupons and deals industry
ICM, a UK-based global multi-regulated financial service provider
Easypolicy, a leading insurance aggregator
Traveazy, a Dubai-based travel-tech company focused on simplifying pilgrimage travel
Unbox Robotics, a leading supply chain robotics technology company specializing
HackerEarth, a comprehensive developer assessment software that helps companies accurately measure developers' skills while recruiting
Metrochem API, a manufacturer of Active Pharmaceutical Ingredients (APIs), Pellets, and Intermediates in Multi Therapeutic segments

Keka API FAQs

Here’s a list of quick FAQs which will help answer any thoughts that you might have during your journey of integrating your application with Keka API

‍

How can an admin create an API access key on Keka? Answer
How to integrate the Mettl assessment app with Keka Hire? Answer
How to integrate Naukri with Keka Hire? Answer
How to integrate Keka Hire with HackerEarth for Sending Assessments? Answer
How to integrate Keka Hire with LinkedIn? Answer
How to integrate MS Teams account with Keka Hire? Answer
How to integrate SpringVerify with Keka? Answer

How to integrate with Keka API

If you are just getting started, it might be a good idea to go through this documentation to understand how you can initiate the integration process. The detailed documentation contains everything you need to know about the overview, endpoints and much more. Leverage this to learn about the different data models scope and other details which will come in handy to get started. At the same time, this link will help you generate the access token for seamless authentication.

Get started with Keka API

While the guide shared above will serve as a comprehensive starting point for you to integrate your application with Keka API, it is important to understand that the entire process can be engineering heavy, time consuming and resource intensive. Put simply, it’s not just about building an integration, but also about managing and maintaining it over time. At the same time, if you want to connect with other HRMS APIs, the process becomes multifold. In such a situation, leveraging a unified HRMS API like Knit can come in handy. Knit enables SaaS businesses to easily connect with multiple HRMS applications by integrating once with its unified API, eliminating the need to connect with each application separately.

‍

Book a demo call today to learn how you can accelerate your integration journey with Keka and other HRMS applications using Knit.

‍

Oct 30, 2023

Getting Started with Greenhouse API Integration: Developer's Guide to Integration

In this article, we will discuss a quick overview of popular Greenhouse APIs, key API endpoints, common FAQs and a step-by-step guide on how to generate your Greenhouse API keys as well as steps to authenticate it. Plus, we will also share links to important documentation you will need to effectively integrate with Greenhouse.

‍

Overview of Greenhouse API

Imagine having the ability to revolutionize your hiring processes, making them more efficient, data-driven, and tailored to your organization's unique needs. That's where the Greenhouse API can help you.

Greenhouse, an applicant tracking software (ATS) and hiring platform. It is a powerful tool that empowers organizations to foster fair and equitable hiring practices.

With a proven track record of assisting over 7500 companies, Greenhouse offers a comprehensive recruitment tool suite, valuable resources, expert guidance, and robust support to help businesses scale and optimize their hiring processes.

Whether you're a developer looking to integrate Greenhouse into your company's tech stack or an HR professional seeking to streamline your hiring workflows, the Greenhouse API offers a world of possibilities.

Let's explore common Greenhouse APIs, popular endpoints, and how to generate your Greenhouse API keys.

‍

Common Greenhouse APIs

The Greenhouse API offers a wide range of endpoints to interact with various aspects of the Greenhouse platform. Here are 5 most commonly used Greenhouse APIs:

1. Harvest API

The Harvest API serves as a key gateway to your Greenhouse data, offering extensive accessibility. Initially designed for data export, this versatile API goes beyond its core function.
It empowers users to carry out a range of actions, including -

updating candidate information
adding attachments to candidate profiles
merging candidate profiles
managing the application process (advancing, hiring, or rejecting them).

Some endpoints include:

GET: List applications to access candidate applications from Greenhouse Recruiting
DELETE: Delete application to delete candidate applications from the platform

Authentication: Basic Auth over HTTPS

Job Board API

Through the Greenhouse Job Board API, you gain effortless access to a user-friendly JSON representation of data about your company's offices, departments, and published job listings.
With direct access to this raw data, you can design career pages according to your specific needs, generate department-specific content, and unlock a multitude of other possibilities tailored to your preferences.
Additionally, they offer support for JSONP callbacks and provide a POST method, enabling you to construct customized online job application forms tailored to your specific needs.

Some endpoints include:

GET: List jobs to access job post information and display job posts on API-driven career site
POST: Submit application to enable potential candidates to submit their application for open positions

Authentication: Basic Auth

Click here for more information.

Assessment API

Primarily used for Greenhouse API to create and conduct customized tests across coding, interviews, personality tests, etc. to check the suitability of the candidate for a particular role. You can leverage tests from third party candidate testing platforms as well and update status for the same after the completion by candidate.

Some endpoints include:

GET https://www.testing-partner.com/api/list_tests to see a list of available tests for the candidate
GET https://www.testing-partner.com/api/test_status?partner_interview_id=12345 to check the current status of a take home test

Authentication: HTTP Basic Authentication over HTTPS

Ingestion API

The Ingestion API offers the capability to acquire candidate leads from third-party platforms and also provides visibility into the current stages of applications within the system.
Through this API, you gain the ability to:

send candidates from their applications to Greenhouse.
fetch the current stage and status of candidates.
retrieve information about jobs on which the Greenhouse users have operational permissions.

Some endpoints include:

GET https://api.greenhouse.io/v1/partner/candidates to retrieve the data for a particular candidate
POST https://api.greenhouse.io/v1/partner/candidates to create one or more candidate
GET https://api.greenhouse.io/v1/partner/jobs to retrieve jobs visible to current use

Authentication: OAuth 2.0 and Basic Auth

Onboarding API

Greenhouse Onboarding API allows you to seamlessly retrieve and update employee data, as well as essential company information, for a smooth onboarding process.

This API only supports GraphQL and not the traditional REST API approach. The key endpoints are in GET, PUT, POST, PATCH, and DELETE.

Authentication: HTTP Basic Authentication over HTTPS

Integrate with Greenhouse API 10X faster. Learn more

How to get a Greenhouse API token?

To make requests to Greenhouse's API, you would need an API Key. Here are the steps for generating an API key in Greenhouse:

Step 1: Go to the Greenhouse website and log in to your Greenhouse account using your credentials.

Step 2: Click on the "Configure" tab at the top of the Greenhouse interface.

‍

Step 3: From the sidebar menu under "Configure," select "Dev Center."

‍

Step 4: In the Dev Center, find the "API Credential Management" section.

‍

Step 5: Click on "Create New API Key."

‍

Step 6: Configure your API Key

Select the API type you want to use.
Give your API key a description that helps you identify its purpose or the application it will be used for.
Specify the permissions you want to grant to this API key by clicking on “Manage Permissions”. Greenhouse provides granular control over the data and functionality that can be accessed with this key. You can restrict access to specific parts of the Greenhouse API to enhance security.

‍

Step 7: After configuring the API key, click "Create" or a similar button to generate the API token. The greenhouse will display the API token on the screen. This is a long string of characters and numbers.

Step 8: Copy the API token and store it securely. Treat it as sensitive information, and do not expose it in publicly accessible code or repositories.

Important: Be aware that you won't have the ability to copy this API Key again, so ensure you store it securely.

‍

‍

Once you have obtained the API token, you can use it in the headers of your HTTP requests to authenticate and interact with the Greenhouse API. Make sure to follow Greenhouse's API documentation and guidelines for using the API token, and use it according to your specific integration needs.

Always prioritize the security of your API token to protect your Greenhouse account and data. If the API token is compromised, revoke it and generate a new one through the same process.

Now, let’s jump in on how to authenticate for using the Greenhouse API.

How to authenticate Greenhouse API?

To authenticate with the Greenhouse API, follow these steps:

Step 1: In your HTTP requests to the Greenhouse API, you need to include the API token in the headers. Use the "Authorization" header to pass your API token as follows -

```

Authorization: Basic YOUR_API_TOKEN

```

Step 2: With the API token included in the headers, you can now make authenticated requests to the Greenhouse API. The token serves as your authentication credential, granting you access to the API endpoints and data according to the permissions associated with the token.

Remember to follow Greenhouse's API documentation and guidelines for best practices, and ensure that you protect your API token from unauthorized access to maintain the security of your Greenhouse account and data.

Common FAQs on Greenhouse API

Check out some of the top FAQs for Greenhouse API to scale your integration process:

1. Is there pagination support for large datasets?

Yes, many API endpoints that provide a collection of results support pagination.
When results are paginated, the response will include a Link response header (as per RFC-5988) containing the following details:

"next": This corresponds to the URL leading to the next page.
"prev": This corresponds to the URL leading to the previous page.
"last": This corresponds to the URL leading to the last page.

When this header is not present, it means there is only a single page of results, which is the first page.

2. Are there rate limits for API requests?

Yes, Greenhouse imposes rate limits on API requests to ensure fair usage, as indicated in the `X-RateLimit-Limit` header (per 10 seconds).
If this limit is exceeded, the API will respond with an HTTP 429 error. To monitor your remaining allowed requests before throttling occurs, examine the `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers.

3. Does Greenhouse have a sandbox?

Yes, Greenhouse provides a sandbox that enables you to conduct testing and simulations effectively.

The sandbox is created as a blank canvas where you can manually input fictitious data, such as mock job listings, candidate profiles, or organizational information.

Refer here for more info.

4. What are the challenges of building Greenhouse API integration?

Building Greenhouse API integration on your own can be challenging, especially for a team with limited engineering resources. For example,

It can take around 4 weeks to up to 3 months to fully plan, build and deploy Greenhouse integration. And ongoing maintenance and monitoring of the API can take ~10 hours each week — all the time that could be invested into improving your core product features. To calculate the cost yourself, click here
The data models of Greenhouse API may not match the data models from other ATS applications (if you are building multiple ATS integrations). In that case, you need to spend additional bandwidth decoding and understanding nuances of Greenhouse API which again is not very productive use of in-house engineering resources.
You need to design and implement workflows to serve specific use cases of your customers using Greenhouse APIs.
The API is updated frequently, so you need to always keep an eye out for the changes to make sure your user experience is not diminished.
Handle integration issues manually as and when they arise.

5. When should I consider integrating with Greenhouse API?

Here are some of the common Greenhouse API use cases that would help you evaluate your integration need:

Access job listings from 1000+ job boards with recommendations based on historical trends
Create scorecard of key attributes for fair and consistent evaluation
Automate surveys for candidate experience and enable candidate to self schedule interviews
Access 40+ reports and dashboard snapshots
Automated tasks and reminders for smooth onboarding
Structured process for paperwork
Easy reports to understand onboarding trends

Ready to build?

If you want to quickly implement your Greenhouse API integration but don’t want to deal with authentication, authorization, rate limiting or integration maintenance, consider choosing a unified API like Knit.

Knit helps you integrate with 30+ ATS and HR applications, including Greenhouse, with just a single unified API. It brings down your integration building time from 3 months to a few hours.

Plus, Knit takes care of all the authentication, monitoring, and error handling that comes with building Greenhouse integration, thus saving you an additional 10 hours each week.

Ready to scale? Book a quick call with one of our experts or get your Knit API keys today. (Getting started is completely free)

Sep 21, 2023

Get Started with Darwinbox API: Complete Integration Guide

DarwinBox is a cloud based HRMS portal built to support the entire employee lifecycle from hire to retire. Serving 750+ organizations with a total of 2Mn+ employees, DarwinBox is powered by artificial intelligence and machine learning to automate HR processes for smooth execution. DarwinBox API allows users to seamlessly access data stored on the platform or import data into it. With a focus on privileged access, DarwinBox provided access only on a request-basis.

DarwinBox API endpoints

DarwinBox API endpoints are secured by a deal factor auth mechanism, supported by end point authorization. The platform has different modules to support different HR functions and each one has several subsections and associated endpoints. Some of the top DarwinBox API endpoints include:

Employee Core Module Inbound APIs

POST Validate Employee Username / Password
POST Validate Custom SSO Token
POST Add Standard Documents
POST Add/Update Email ID
POST Add/Update Education Details
POST Add/Update Past Work Details

Employee Core Module Outbound APIs

POST Fetch Employee Data (Full Load)
POST Fetch Deleted Employees
POST Fetch Custom Workflow Details
POST Fetch Organization Masters - Employee Type
POST Fetch Position History
POST Fetch Completed Training Review Flows

Recruitment Module APIs

POST Fetch Job List V3
POST Fetch Candidate Data - Bulk V3
POST Reject Candidate V3
POST Add Tags to Candidate Profile V3

Onboarding Module APIs

POST Background Verification - Fetch Candidate List V2
POST Background Verification - Download Form
POST Background Verification - Submit Verification Report V2

Attendance and Timesheets Module APIs

POST Fetch Attendance Status (Monthly) V1
POST Fetch Attendance Status (Date Range) V1
POST Fetch Weekly Off & Shift Assignment
POST Fetch Attendance Requests Approved Between Given Dates
POST Fetch OT Approved Between Given Dates
POST Add Attendance Punches
POST Employee Timesheet Datewise

Leave Module APIs

POST Update Leave Status API
POST Fetch Leave Transactions API
POST Fetch Holidays list
POST Fetch Leave Balance
POST Import Leaves API
POST Fetch Leave Encashment details

Performance Module APIs

POST Fetch Talent profile
POST Update Achievement
POST Get Employee Promotion History
POST Get Job Level History

Compensation Module APIs

POST Import Component Payslip
POST Fetch Employee CTC Data
POST Fetch Employee Global CTC Data
POST Fetch Global Extra Payments
POST Fetch Monthly PF details
POST Fetch Salary Register Details
POST Fetch CTC Breakup Computation
POST Fetch Payroll Custom Report Data

Expenses Module APIs

POST Fetch Expense Details

Recognition Module APIs

POST Fetch Redemption Points
POST Update Redemption Transaction
POST Fetch Budget History
POST Fetch Reward Activity
POST Fetch Redemption History
POST Fetch Nomination Activity

Travel Module APIs

POST Fetch Approved Travel Requests
POST Fetch Cancelled Travel Requests
POST Fetch Advance Travel
POST Fetch Travel Booking Report

Vibe and Pulse APIs

POST Fetch Pulse Updates

HR Documents APIs

POST Push HR documents

DarwinBox API use cases

Core HR with employee master, custom workflows, HR documents & more
Employee helpdesk with auto ticket assignment, closure & feedback, SLA configuration, 1-on-1 chat
Rewards & recognition via 100% configurable programs, budget control, redemption platform integration
Time & attendance with touchless attendance, granular policy configuration, one-view dashboards
Digital employee onboarding with AI based doc validation
Performance management through OKRs, continuous feedback, role-based dashboards, talent development & more
Recruitment support with candidate sourcing, advanced job, candidate & offer management, reports
Travel & expense management with smart OCR capture, automated spend approval & budget controls, analytics
Employee engagement with an organizational social network, pulse, polls, surveys, e-noticeboards, custom groups

Top customers

Zee Media, news broadcasting company of the Essel Group
Rupeek, a pioneer among gold finance companies in India
MobiKwik, an Indian payment service provider
Duroflex, India's most trusted sleep solutions expert
Tata CLiQ, an Indian e-commerce company

How to integrate with DarwinBox API

Check out this detailed documentation to get started with DarwinBox API integration.

Get started with DarwinBox API

The pricing for DarwinBox API is not available publicly. You can request a quote here and choose the module that works best for you. However, you can get started with Knit, one API for all your integrations. Sign up with Knit, starting at $1500 for up to 5 connected customers. Claim your free access here

Sep 21, 2023

Get Started with Lever API

Lever is a leading recruitment software that combines the power of ATS and CRM to help hire top talent for companies. It provides a complete talent management solution to facilitate sourcing, nurturing and interviews. It helps companies ensure inclusivity in recruitment while eliminating bias in hiring with its tools including Lever Hire, Lever Nurture, Lever Analytics.

All data in Lever API is sent and received as JSON over HTTPS and unencrypted HTTP is not supported. Lever API uses basic auth for authentication using API key as the username or OAuth.

Lever API endpoints

Top Lever API endpoints to access particular information are as follows:

‍

GET https://api.lever.co/v1/candidates to use an access token
GET /opportunities/:opportunity/applications/:application to retrieve full record of a single application
GET /opportunities/:opportunity/applications to list all applications for a candidate
GET /archive_reasons/:archive_reason to retrieve a single archive reason
GET /archive_reasons to list all archive reasons in Lever account
GET /audit_events to list all audit events
GET /contacts/:contact to retrieve a single account
GET /opportunities/:opportunity/feedback/:feedback to retrieve a feedback form
GET /opportunities/:opportunity/feedback to list all feedback for a candidate for this opportunity
GET /feedback_templates/:feedback_template to retrieve a feedback template
GET /feedback_templates to list all feedback templates
GET /opportunities/:opportunity/files/:file/download to download a file
POST /opportunities/:opportunity/interviews to create a new interview
POST /opportunities/:opportunity/notes to create a note and add it to a candidate profile
POST /opportunities/:opportunity/addLinks to update contact links by opportunity
POST /opportunities/:opportunity/removeTags to remove tags from an opportunity
GET /postings/:posting to retrieve a single posting
GET /postings to list all postings
POST /postings to create a posting

‍

Check out this detailed documentation for more endpoints.

‍

Lever API use cases

Candidate relationship building with easy-to-use nurturing capabilities
Collaborative interviews with visibility into the entire candidate pipeline and a single location for every candidate interaction
Hiring and recruiting insights with out-of-the-box, actionable analytics
Inclusive hiring to set and assess DEI strategies and overcome unconscious
Candidate record maintenance to keep every candidate’s information and all correspondence

‍

Lever API FAQs

Check out the top FAQs for Lever API to help you get started

‍

What is the difference between the Lever API and Postings API? Answer
Does the Lever API archive encompass all candidates that have been either rejected or somehow stopped the interview process? Answer
Are stages in Lever API customized by each company? Answer
How do I add global tags to a Lever account? Answer
Are tags customized by each company in Lever? Answer

‍

How to integrate with Lever API

To learn how you can get started with Lever API integration, check out this detailed guide.

‍

Get started with Lever API

To get access to Lever pricing for integration, you can get a free quote here. However, you can get started with Knit, one API for all your integrations. Sign up with Knit, starting at $1500 for up to 5 connected customers. Claim your free access here

Sep 20, 2023

Get Started with SuccessFactors API

SuccessFactors by SAP is a leading cloud human capital and experience management platform. It provides cutting edge solutions for core HR (payroll), talent management (performance, compensation, recruitment, onboarding) along with reporting and analytics. SAP SUccessFactors can be deployed in hybrid or full cloud variants. Founded in 2001, SuccessFactors was acquired by SAP in 2012.

SuccessFactors API endpoints

Some endpoints for SAP SuccessFactors API include:

‍

GET /odata/v2/Attachment(1L)
GET /odata/v2/Attachment?$filter=module eq ‘'EMPLOYEE_PROFILE'
GET, URL: odata/v2/Country
GET, URL: odata/v2/PickListV2
POST, URL: odata/v2/TimeZone
DELETE, URL: odata/v2/Currency
POST /odata/v2/upsert
POST /odata/v2/UserBadges
MERGE, URL: odata/v2/Country
MERGE, URL: odata/v2/CurrencyConversion
DELETE /odata/v2/Background_InsideWorkExperience
POST /odata/v2/Attachment

‍

Here’s a guide for more information.

SuccessFactors API use cases

Facilitates embedded engagement and automation to help companies source, engage and hire best talent
Ensures engagement among internal and external new hires for productivity from day one
Provides multiple human capital management tool to leverage and manage employee master data
Ensures bias free performance evaluations
Aligns employee goals to business targets
Helps in identifying and nurturing top talent
Facilitates HR analytics and workforce planning to align HR with corporate strategy and identify attrition risks
Centralizes document management with process harmonization
Optimizes performance, recognition, learning and development

Top customers

Microsoft, a multinational technology corporation
Purolator Inc., a Canadian courier
Swiss Re, a reinsurance company based in Zürich
Milliken & Company, an American industrial manufacturer

SuccessFactors API FAQs

Here are some of the top SuccessFactors FAQs that can help you understand this integration better:

‍

What are the available APIs for SuccessFactors? Answer
How to use SuccessFactors APIs for custom integrations? Answer
How to address SSIS Odata Source feed error while executing a task using SuccessFactors as source? Answer
How to integrate SuccessFactors and S4HANA using S4 SDK? Answer
How to pull all data via API from successfactors? Answer
What is the Successfactors API limit number of records return per request? Answer
How to get CandidateID from SuccessFactors Career (recruitment) site? Answer
How to filter out all Upsertable entities in successfactors using postman? Answer
How to retrieve snapshot data using SuccessFactors Compound Employee API? Answer
How to set up OAuth Authentication in SAP SuccessFactors? Answer
How to get the top 1 element when calling the API of SAP Successfactor using RestAssured? Answer

How to integrate with SuccessFactors API

To get started with SAP SuccessFactors API, click here for more information.

Get started with SuccessFactors API

SAP SuccessFactors Employee Central pricing starts from 6.3 USD per CLD_S0071 / Month and you can request a custom quote based on your requirements. However, you can get started with Knit, one API for all your integrations. Sign up with Knit, starting at $1500 for up to 5 connected customers. Claim your free access here

‍

Jul 31, 2023

Guide to Integrating with Rippling API

Rippling is a workforce management platform which enables companies to manage their IT, HR and Finance functions with one solution. It offers payroll, benefits, expenses, corporate cards, computers, apps, services among others. It seeks to automate manual work across workforce management like onboarding, by enabling companies to set up payroll, health insurance, corporate card, work computer, and third-party apps, etc. for new employees with a single click.

‍

With Rippling API, customers and partners can access company and employee data to power their workforce management. Rippling API follows OAuth 2.0 for authorization and authentication.

Rippling API endpoints

Let’s quickly look at the endpoints for Rippling API across fields like companies, employees, groups, etc.

Companies

GET https://api.rippling.com/platform/api/companies/current
GET https://api.rippling.com/platform/api/departments
GET https://api.rippling.com/platform/api/work_locations
GET https://api.rippling.com/platform/api/custom_fields
GET https://api.rippling.com/platform/api/teams
GET https://api.rippling.com/platform/api/levels
GET https://api.rippling.com/platform/api/company_leave_types
GET https://api.rippling.com/platform/api/company_activity

Employees

GET https://api.rippling.com/platform/api/employees
GET https://api.rippling.com/platform/api/employees/{employeeId}
GET https://api.rippling.com/platform/api/employees/include_terminated

Groups

GET https://api.rippling.com/platform/api/groups
POST https://api.rippling.com/platform/api/groups
PUT https://api.rippling.com/platform/api/groups/{groupId}
PATCH https://api.rippling.com/platform/api/groups/{groupId}
DELETE https://api.rippling.com/platform/api/groups/{groupId}

SAML

GET https://api.rippling.com/platform/api/saml/idp_metadata

Current User

GET https://api.rippling.com/platform/api/me

ATS

POST https://api.rippling.com/platform/api/ats_candidates/push_candidate

Application Management

POST https://api.rippling.com/platform/api/mark_app_installed

Leaves

GET https://api.rippling.com/platform/api/leave_requests
POST https://api.rippling.com/platform/api/leave_requests
GET https://api.rippling.com/platform/api/leave_balances
GET https://api.rippling.com/platform/api/leave_balances/{role}
POST https://api.rippling.com/platform/api/leave_requests/{id}/process
PATCH https://api.rippling.com/platform/api/leave_requests/{id}
DELETE https://api.rippling.com/platform/api/leave_requests/{id}

‍

To know more about Rippling API endpoints, click here.

Rippling API use cases

Global workforce management with seamless onboarding, global payments in local currencies, and automation of compliance work
Policy management to manage all your HR, IT, and Finance policies in one place with automated policy enforcement with reminders, updates
Custom workflows to automate your manual HR, IT, and Finance processes with custom triggers and automated actions for emails, messages, etc.
Access and approval management to seamless keep a check on what your employees can see and do in every business system by controlling access, data and approvals
Workforce analytics to unify and analyze all your workforce data across every business system with powerful reporting

Top customers

Literati, a children's book club and subscription service
Morning Consult, a business intelligence company
Stacklet, a cloud governance company
M9 Solutions, an IT services and solutions company
Open Door Legal, an award-winning nonprofit in legal services

Rippling API FAQs

Check out some of the top Rippling API FAQs to address some of your initial queries:

What apps does Rippling integrate with? Answer
How long does IT take to implement Rippling? Answer
What type of system is Rippling? Answer
Does Rippling require pagination? Answer
How do I build a user management integration with Rippling's API? Answer
Why is there a beta tag attached to my application in the Rippling app shop? Answer
Are there any costs or fees associated with building an API integration with Rippling? Answer
Does Rippling support IDP-initiated OIDC SSO flows? Answer

How to integrate with Rippling API

Here is a quick guide to help you get started with integration for Rippling API.

Get started with Rippling API

The pricing for Rippling API starts at $8 a month, per user. For more custom pricing based on your requirements, you can request a custom quote. However, you can get started with Knit, one API for all your integrations. Sign up with Knit, starting at $1500 for up to 5 connected customers. Claim your free access here