---
title: "OpenAPI Interface"
canonical: "https://help.agiloft.com/space/HELP/929595396/OpenAPI%20Interface"
format: markdown
---
You can access detailed OpenAPI documentation with [Swagger UI](https://swagger.io/) directly in your KB at **Setup > System > View REST documentation**. This code repository includes entries for the tables and fields specific to your system, and offers you the ability to test API calls with specified parameters once you obtain [authorization](https://agiloft-public.atlassian.net/wiki/spaces/HELP/pages/43715778/REST+Interface#1). Testing API calls should always be performed in test KBs, rather than a production environment. If you have no other choice but to use the production environment, use extreme caution.

You can download a comprehensive Open API JSON file from the right-hand side of the page by clicking **Download Open API JSON**. This file is useful for importing into Postman.

## > Macro (anchor)

Authorization

You need to go through an authorization process before you can test API calls. Follow the steps below to complete this process:

1. In your test KB, navigate to **Setup > System > View REST documentation**.
2. Under Schemes, select HTTPS.
3. Open the General section and click POST /login.
4. Click Try It Out.
5. Replace the "string" values in the parameters.
  1. For password and login, enter the user that you are going to use for your REST calls, which is commonly just a user created specifically for this purpose. This user must be in a REST-enabled Group.
  2. For KB, enter the name of the KB as it appears in the top right-hand corner of your KB next to the Help icon.
  3. For language, enter the [language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) your KB uses. Language codes are generally two lowercase letters. For example, English would be "en".
6. Click Execute.
7. Scroll down slightly to the Server response section and copy the access token. Do not include the quotation marks.
8. Scroll back up to the top of the page and click Authorize.
9. Paste the access token into the Value field in the window that appears.
10. Click Authorize to complete the authorization process.

Now, you can begin to test API calls in the KB you just authorized. You only need to authorize once, but will need to log in again after the default 15 minute expiration time.

## Testing an API Call

Now that you are authorized, you can test commands in the KB using various methods of POST, GET, DELETE, and PUT. Currently, there are no rate limits per user, token, KB, or otherwise.

Below are example steps for testing a call. This example uses PUT to update a record in the People table.

1. Click the table you'd like to test calls against.
2. Click PUT /contacts/{id}.
3. Click Try it Out.
4. In the body field, you'll see a list of the parameters for a Person record. Find the fields you'd like to update, and replace the "string" value with the new data. ID is a required field because it indicates which record will receive the update. You can delete any fields you do not want to update with this call.
5. Click Execute.

#### Related articles

> Macro (contentbylabel)