Skip to content

Getting started

This guide walks you from no account to your first successful API call. Total time: about five minutes.

  1. Create a PhotoPick account. Sign up at app.photopick.cz. The API uses the same account as the web app.

  2. Create an API key. In the app, open Settings → API keys → New key. Give the key a descriptive name (your integration name is a good default).

  3. Pick the scopes you need. Scopes are granted at key-creation time and cannot be widened later. Start with the minimum — customer:read lets you verify the key works:

    ScopeGrants
    customer:readRead account + key metadata (/me, /customer)
    photos:readList and read photos
    photos:writeEdit photo metadata, tag assignments
    photos:deleteDelete photos
    tags:readList tags
    tags:writeCreate, rename, delete tags
  4. Copy the key. Keys are shown once. They look like pp_live_xxxxxxxxxxxxxxxx. Store it somewhere safe (your secret manager, .env, password manager).

  5. Call /me to verify.

    Terminal window
    curl https://api.photopick.cz/api/v1/me \
    -H "Authorization: Bearer pp_live_xxxxxxxxxxxxxxxx"

    A 200 OK returns key metadata: apiKeyId, customerId, name, scopes, rateLimit.

  • Authentication — header format, scope details, IP whitelist.
  • Errors — envelope shape and the full list of error codes.
  • curl examples — copy-paste recipes for the most common flows.