This documentation is for developers wanting to build custom software with our programming interface. If you are looking for product support, please go back to the main documentation.

​
Welcome

Welcome to the Profile API documentation! We are excited to see what you build. Here at Profile, we work hard to make our API as easy to use as possible. If you have any questions, please Contact Us.

OpenAPI Specification

Our documentation is generated from an OpenAPI specification. You can view the full specification file in our GitHub repository.

​
Getting Started

The first place to start using our API is to sign in, generate your API keys, and hit the test endpoints. You can do this by going to the Account Settings page and clicking on the “Generate API Keys” button. This will generate a new API key pair that you can use to authenticate your requests. You can also regenerate your API key at any time if you feel that it has been compromised.
1

Check Account Permissions

If you are not the account owner, contact your administrator and make sure you have manager permissions.
2

Generate API Keys

Go to the Account Settings page and generate an API key pair for your desired region.
3

Test Authentication

Use your API keys and the test endpoints to get authentication working.