> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sonderplan.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Clients

> Create and configure API clients to build custom applications using RESTful APIs, enabling flexible integration and development.

API clients allow you to integrate external applications or services with Sonderplan using our RESTful API. Each API client is assigned to a specific Sonderplan user, inheriting their user group permissions and ensuring that the external application can perform only actions authorized for that user. This provides a secure and precise mechanism for managing integration points, custom applications, and automated workflows.

We recommend creating separate API clients for each distinct use case or integration. By isolating API clients, you reduce risks associated with credential exposure or unauthorized access, and it becomes easier to audit and manage access, troubleshoot issues, and enforce precise permission scopes tailored to each integration scenario.

## Creating an API Client

1. Expand **Admin** then click **Integrations -> New -> Api Client**, the sidebar editor opens.
   <img src="https://mintcdn.com/sonderplan-b228cb35/COGNuOeevCLC_Y0F/images/admin/api/sonderplan-new-api-client.png?fit=max&auto=format&n=COGNuOeevCLC_Y0F&q=85&s=81c9f35fea81fdec1f59f5f41d5e3002" alt="Sonderplan new api client" width="1454" height="1186" data-path="images/admin/api/sonderplan-new-api-client.png" />
2. Enter a **description** on the purpose of the API Client, for example *"Zapier client"*
3. Select the **User** that this API Client should be linked to. The API Client will have the same permissions as the User
   <Warning>We recommend creating a dedicated user for your API integrations, placed in a User Group with the least permissions possible.</Warning>
4. Click **Save** to create the API Client.
5. The Authentication Bearer Token is **displayed once only**. Be sure to copy the token before closing the API Client sidebar.

   <img src="https://mintcdn.com/sonderplan-b228cb35/COGNuOeevCLC_Y0F/images/admin/api/sonderplan-api-authentication-token.png?fit=max&auto=format&n=COGNuOeevCLC_Y0F&q=85&s=7f27a864bbca825ebafad41470548709" alt="Sonderplan api authentication token" width="956" height="945" data-path="images/admin/api/sonderplan-api-authentication-token.png" />

<Info>API Client tokens expire after a period of 5 years, but can be withdrawn and reset instantly.</Info>

## Modifying an API Client

It is currently only possible to modify the description of an existing API client.

To edit an API client:

1. Click the **Client Id** in the API Clients Data Table, this opens the API Client sidebar editor.
2. Edit the **Description** field
3. Click **Save**

## Deleting an API Client

Deleting an API Client immediately revokes the authentication token so that it can no longer be used to make requests to the Sonderplan REST API.

To delete an API client:

1. Click the **Client Id** in the API Clients Data Table, this opens the API Client sidebar editor.
2. Click the **<Icon icon="trash" iconType="solid" color="#dc3545" />** button in the bottom right corner of the editor.
3. Click the **Delete** button in the delete confirmation popover.

<img src="https://mintcdn.com/sonderplan-b228cb35/COGNuOeevCLC_Y0F/images/admin/api/sonderplan-delete-api-client-confirmation.png?fit=max&auto=format&n=COGNuOeevCLC_Y0F&q=85&s=3298d1f18f6c123ef0737754d955747d" alt="Sonderplan delete api client" width="1085" height="651" data-path="images/admin/api/sonderplan-delete-api-client-confirmation.png" />

## Further Resources

<Card title="Sonderplan REST API Docs" icon="terminal" href="/api-reference" horizontal="true">
  Explore our comprehensive REST API documentation to learn how to build powerful integrations, automate tasks, and extend your companies capabilities.
</Card>

<Card title="Sonderplan Zapier Connector" icon="bolt" href="/admin/zapier" horizontal="true">
  Set up a new API client, integrate it with Zapier, and build a test Zap to automate workflows and streamline data connections.
</Card>
