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.

Join Beta

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 [e-mail]

How to Access

1

Get your API key

In PaintScout, navigate to Account Settings > API Keys.

2

Create new key

Click + Create New API Key to generate one.

3

Label your key

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

4

Copy the API key

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

---

Can I edit an existing API key?

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.

How do I view my API keys?

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

How do I delete an API key?

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.

How many API keys can I have?

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

What should I do if my API key is compromised?

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.

What can I access with the API?

For a full list of available endpoints and what's possible, check out our developer documentation

---

Thanks for Trying the Beta!

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 [e-mail]