Get a background image thumbnail

GET

/api/v1/appearance/unsplash/images/{photo_id}

const url = 'https://example.com/api/v1/appearance/unsplash/images/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/appearance/unsplash/images/example \
  --header 'Authorization: Bearer <token>'

Returns a background image thumbnail. It requires a signed-in User with the data scope. It can return 401 if the session is missing or expired, 403 if access is denied, 404 if the requested item does not exist and 503 if the service is temporarily unavailable. Route: /api/v1/appearance/unsplash/images/{photo_id}. Inputs: photo_id. Safe reads can use bounded retries.

Authorizations

installationBearer
browserSession

Parameters

Path Parameters

photo_id

required

string

Responses

200

Unsplash thumbnail proxied by the server

application/octet-stream

404

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}

503

application/json

The standard API error response: { "error": { ... } }.

object

error

required

Error details.

object

code

required

Stable machine-readable code.

string

Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable

details

One of:

object
null

Optional field or operation details.

object

key

additional properties

string

message

required

Safe text for logs or a user-facing error message.

string

Example

{
  "error": {
    "code": "bad_request"
  }
}