Getting Started with the Accountability API: Web and Postman Instructions

API Usage Instructions

This guide provides simple, step-by-step instructions for using our API documentation and Postman. It’s designed for team members who may not have a technical background.

Using the API Documentation Website

1. Open your web browser and go to the token endpoint here.

Authenticate Using Form Data

1. Scroll to the bottom of the page to find the section labeled Form Data.

2. Fill in the following fields:

• grant_type: type in password

• tenantId: enter your company’s tenant ID

• username: enter your username (usually your email)

• password: enter your password

Trigger Authentication

1. Click the Try it! button at the top-right of the section.

2. After a moment, you’ll see a response on the screen with different information.

3. Look for the line that says: "access_token": "..."

4. Copy only the text inside the quotes — this is your token (don’t copy the quotation marks).

Use Token to Access Endpoints

1. Find the section or tab for the endpoint you want to use (for example, Employee).

2. In the Headers section (usually at the top right), add a new key-value pair:

• Key: Authorization

• Value: Bearer [Paste your copied token here]

Test Endpoint Calls

1. Click Try it! to test the endpoint.

2. If the endpoint needs extra info (like an employee ID), make sure to fill it in before clicking Try it.

Authenticate with the API Using Postman

To get your access token and start making authorized requests, follow these steps in Postman.

Steps

1. Set Up the Token Request

Endpoint:

POST https://api.accountabilityone.com/v1/token

1. Open Postman.

2. Click + New Request (or import the API collection if provided).

3. Set the method to POST and paste the following URL:

4. https://api.accountabilityone.com/v1/token

5. Go to the Body tab.

6. Select x-www-form-urlencoded as the format.

7. Add the following key-value pairs:

• grant_type: password

• tenantId: [Your Tenant ID]

• username: [Your Username]

• password: [Your Password]

1. Click Send.

2. Retrieve and Use the Access Token

1. In the response section below, look for the access_token field.

2. Copy the value (without the quotation marks).

3. Set Authorization at the Collection Level

1. In the Postman sidebar, find your API Collection.

2. Click the collection top level folder.

3. Go to the Authorization tab.

4. Set Type to Bearer Token.

5. Paste your copied token into the Token field.

6. Click Save.

4. Use Your Token in Other Requests

Now that you've retrieved and set your access token, you can use it to make requests to any other secured API endpoint in your collection.