--- title: "CharlieHR API Directory" description: "Learn about the common CharlieHR API data models and API end points in this comprehensive CharlieHR API directory" source_url: "https://www.getknit.dev/blog/charliehr-api-directory-ebCukz" page_type: "blog" --- _This is an educational blog post from Knit's blog: “CharlieHR API Directory”._ # 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](https://help.charliehr.com/en/articles/6193173-integrate-charliehr-with-selected-apps?) **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 **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](https://help.charliehr.com/en/articles/6193173-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](https://help.charliehr.com/en/articles/6193173-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.](https://apitracker.io/a/charliehr) **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](https://www.charliehr.com/api_docs) **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.](https://apitracker.io/a/charliehr) ## 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](https://developers.getknit.dev/docs/charliehr-usecases). 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](https://app.getknit.dev/signup). To check the pricing, see our [pricing page](https://www.getknit.dev/pricing). ## Related pages - [How Knit works](https://md.getknit.dev/how-knit-works) - [Unified API product](https://md.getknit.dev/products/unified-api)