> For the complete documentation index, see [llms.txt](https://help.paintscout.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.paintscout.com/support/beta-guides/openapi-beta-guide.md).

# OpenAPI Beta Guide

Connect PaintScout with your own tools and workflows by accessing your data programmatically through the OpenAPI.

PaintScout's OpenAPI allows you to connect PaintScout with your own tools, workflows, and integrations. Access your data programmatically and build custom solutions tailored to your business.

<p align="center"><a href="https://5nj1jy.share-na3.hsforms.com/2yd8JlvSuTUqDQDJviLN9_A" class="button primary" data-icon="unlock">Join Beta</a></p>

{% hint style="info" icon="circle-info" %}
This feature is currently in active development. You may encounter bugs, missing functionality, or things that don't work quite as expected. We're actively making improvements and would love your feedback if you run into anything!

Feel free to reach out to us at <product@paintscout.com>
{% endhint %}

## How to Access

{% stepper %}
{% step %}

### Get your API key

In PaintScout, navigate to Account Settings > API Keys.
{% endstep %}

{% step %}

### Create new key

Click **+ Create New API Key** to generate one.

<figure><img src="https://231248629-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPyUbJF1GXLjxdJqm89IQ%2Fuploads%2FEnsokAYCpQ8rUe1lnFQj%2FScreenshot%202026-06-19%20at%203.28.02%E2%80%AFPM.png?alt=media&amp;token=3b53cba7-559b-428c-ae4b-eaabfa5327ce" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Label your key

Give it a name that describes its purpose (e.g. "Zapier Integration" or "Custom App").
{% endstep %}

{% step %}

### Copy the API key

Click the copy icon to copy the key, then paste it into your integration.

<figure><img src="https://231248629-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPyUbJF1GXLjxdJqm89IQ%2Fuploads%2FMeWPCiWbNVGdx1qcZV5l%2FScreenshot%202026-06-19%20at%203.32.21%E2%80%AFPM.png?alt=media&amp;token=ddfd5f55-3f5a-43cd-8ae6-58dd2cb2280a" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

***

<details>

<summary><strong>Can I edit an existing API key?</strong></summary>

API keys cannot be edited once created. If you need to make a change, delete the existing key and create a new one with the updated label or permissions.

Although, you can edit the name/description of the key made.

</details>

<details>

<summary><strong>How do I view my API keys?</strong></summary>

Navigate to Account Settings > API Keys to see a list of all your active API keys, including their labels and creation dates.

</details>

<details>

<summary><strong>How do I delete an API key?</strong></summary>

In Account Settings > API Keys, click the three dots next to the key you want to remove and select **Delete**. Note that deleting a key is permanent and any integrations using it will stop working immediately. Make sure to update your integrations with a new key beforehand.

</details>

<details>

<summary><strong>How many API keys can I have?</strong></summary>

You can create multiple API keys, which is useful for keeping different integrations separate and organized.

</details>

<details>

<summary><strong>What should I do if my API key is compromised?</strong></summary>

Delete the key immediately from Account Settings > API Keys and generate a new one. Update all integrations with the new key as soon as possible.

</details>

<details>

<summary><strong>What can I access with the API?</strong></summary>

For a full list of available endpoints and what's possible, check out our [developer documentation](https://help.paintscout.com/developers)

</details>

***

## Thanks for Trying the Beta! <a href="#h_a1cb63cea7" id="h_a1cb63cea7"></a>

We're excited to have you trying out this new feature. Since this is actively in development, your feedback is incredibly valuable as we continue to improve.

If you have questions, run into issues, or just want to share your thoughts, please reach out anytime at <product@paintscout.com>

&#x20;&#x20;


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.paintscout.com/support/beta-guides/openapi-beta-guide.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.