Skip to content

Authentication

All API requests require an API key passed as a Bearer token in the Authorization header.

Terminal window
Authorization: Bearer ak_live_your_key_here
PrefixTypeCreated ByPurpose
ak_live_syncUserPartner data sync — push artworks, artists, events
ak_search_searchAdminThird-party read-only data access
  1. Log in to your Artland account
  2. Navigate to Account → API Keys (/account/api-keys)
  3. Click Generate New Key
  4. Give it a label (e.g., “Gallery CMS Sync”)
  5. Copy the key — it’s shown once

Your tier depends on your Artland subscription status:

User StatusKey TierScopesRate LimitDaily Reads
claimedread_only*:read, search:read30/min500/day
subscriberread_write*:read, *:write, search:read100/minUnlimited
sponsoredread_write*:read, *:write, search:read100/minUnlimited
pausedBlocked

Scopes control what operations your key can perform:

ScopeDescription
artworks:readList and view artworks
artworks:writeCreate and update artworks
artists:readList and view artists
artists:writeCreate and update artists (gallery keys only)
events:readList and view events
events:writeCreate, update, and delete events
profile:readView your entity profile
profile:writeUpdate your entity profile
search:readSearch across all entities

Use the /v1/me endpoint to check your key’s identity, scopes, and usage:

Terminal window
curl https://api.artland.com/v1/me \
-H "Authorization: Bearer ak_live_your_key_here"

Response:

{
"key_prefix": "ak_live_a1b2",
"label": "Gallery CMS Sync",
"tier": "read_write",
"scopes": ["artworks:write", "artists:write", "events:write", "profile:read"],
"entity": { "type": "gallery", "id": 1, "name": "Gagosian" },
"usage": { "reads_today": 12, "writes_today": 5, "daily_read_limit": null }
}
CodeMeaning
401Missing or invalid API key
403Insufficient scope or paused account
429Rate limit exceeded

See Errors for full details.