Getting started
Artbrain provides access to its REST API using the OpenAPI Specification 3 (OAS3).
Developer documentation can be accessed here.
Base URL
The base URL for the Artbrain API is https://api.artbrain.co/api/1.0
For private apps, use the format https://<PRIVATE_APP_SUBDOMAIN>.artbrain.co/api/1.0
Authentication
To make authenticated requests to the API, an API key must be used in the API-Key header. Please note there is a rate limit of 10 requests per second per API key. Never share your API key and ensure it is stored securely.
Header parameter name: API-Key
// Example Curl shell request using the API-Key header
curl --header "API-Key: <YOUR_API_KEY>" https://api.artbrain.co/api/1.0/...
API Key Creation
To create an API key (limited to 5 keys per account):
Access API Settings:
Log in to Artbrain using an account with "Owner" privileges.
From the avatar menu in the top right corner, select "Auction House Settings."
In the Auction House Settings, click on the API Keys tab.
Create an API Key:
Click the "New Key" button.
In the creation modal, provide a name for the key, then press "OK."
Use the API Key:
Copy the key using the
button under the "Key" column.Include this key in the
API-Keyheader for any API call.
Important: The previous method of using the Bearer <TOKEN> in the Authorization header is no longer supported. The /authenticate endpoint is no longer required for obtaining an access token. Deprecating March 31, 2025.
Developer documentation can be accessed here.
CLI Examples
Get Customer Data
To retrieve customer data, use the following cURL command:
curl --request GET \ --header "API-Key: <YOUR_API_KEY>" \ https://api.artbrain.co/api/1.0/customers/13
Replace <YOUR_API_KEY> with the API key you generated.
Update Customer Data
To update customer data, use the following cURL command:
curl --request PUT \ --header "Content-Type: application/json" \ --header "API-Key: <YOUR_API_KEY>" \ --data '{"data":{"lastName":"Thomas","phone":"+99-11-222-3333"}}' \ https://api.artbrain.co/api/1.0/customers/13Replace <YOUR_API_KEY> with your API key, and modify the data fields as needed.
Add a New Category to an Existing Customer
To add a new department and category to an existing customer, use the following cURL command:
curl --request PUT \ --header "Content-Type: application/json" \ --header "API-Key: <YOUR_API_KEY>" \ --data '{"data":{"departments":[{"name":"Books","categories":["Sci-Fi"]}]}}' \ https://api.artbrain.co/api/1.0/customers/13Replace <YOUR_API_KEY> with your API key. In this example, a "Books" department with a "Sci-Fi" category is added to the customer with ID=13.