The API is accessed using a base URL that is specific to your account. In the examples provided in this documentation, we use the URL youraccountname.api-us1.com as a stand-in for your real account API URL. Your API URL can be found in your account on the My Settings page under the "Developer" tab. In addition, URL paths should begin with /api/3 to specify version 3 of the API. Generally, the URL will be in the form https://<your-account>.api-us1.com/api/3/<resource>. All API calls should be made over HTTPS.
🚧
Base URL Usage for 3rd Party Developers
If you are building an app or integration that requires the user to input their Base URL and API key it is important to always use the API URL found in the User's "Developer" tab. It is explicitly not a guarantee that api-us1.com is always a supported API Base URL for all current and future users. The Base URL in the "Developer" tab will always be the source of truth for that user. Allowing users to input just an account name instead of the full URL may result in invalid API URLs for some users, particularly users located outside of the United States.
Updated 8 months ago
Did this page help you?
Updated 8 months ago
Did this page help you?
Privacy Preference Center
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
Manage Cookie Preferences
Performance Cookies
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
Functional Cookies
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
Strictly Necessary Cookies
Always Active
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.
Targeting Cookies
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising.
We - and our partners - use cookies to deliver our services and to show you ads. By using our website, you agree to the use of cookies as described in our Cookie Policy (in English)