---
title: "Add an API client"
slug: "add-an-api-client"
updated: 2025-07-22T10:52:18Z
published: 2025-07-22T11:18:07Z
canonical: "totara.help/add-an-api-client"
---

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

# Add an API client

To use the [external API](/19/docs/what-is-the-external-api) in Totara, you need to have one or more registered clients. These clients control which services can be accessed by an external system, and how the API is used. We recommend that you create a separate client for each use of the API, and configure the client to have the relevant access to complete a specific task only.

From the **Clients** page, you can manage the API clients on your site. Follow these steps to add a new API client:

1. Navigate to *Quick-access menu > Development > API > API clients*.
2. Click **Add client**.
3. Enter a **Name** and **Description** for the API client.
4. Select a **Service Account** to be used by the client. See [API service accounts](/19/docs/api-service-accounts) for more information.
5. Use the **Status** checkbox to determine whether the client is enabled. You can edit and enable the client at a later date if required.
6. Click **Save**.

Once the client has been created you will see the new client expanded to show its details.

A tenant member can't create a client outside of their tenant, but system users can create a client within a tenant.

![Adding a new API client.](https://cdn.document360.io/a007399b-031e-436b-999a-528240e16f58/Images/Documentation/image-1663931078286.png?sv=2026-02-06&spr=https&st=2026-11-01T15%3A49%3A54Z&se=2026-11-01T16%3A49%3A54Z&sr=c&sp=r&sig=oi7irovPAJDmmeRY3rHV5sNFezEArGHsgVy7%2Bj6%2BaXs%3D)

## Next steps

- [Edit an API client](/19/docs/edit-an-api-client)
- [Enable or disable an API client](/19/docs/enable-or-disable-an-api-client)

Join the [Totara Community](https://totara.community/) for more resources to help you get the most out of Totara.

© Copyright 2026 Totara Learning Solutions. All rights reserved.