Skip to content
calternal docs

Search background images

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

Searches for the background images. It requires a signed-in User with the data scope. It can return 400 if the request is invalid, 401 if the session is missing or expired, 403 if access is denied, 404 if the requested item does not exist, 429 if the request limit is reached and 503 if the service is temporarily unavailable. Route: /api/v1/appearance/unsplash/search. Inputs: q, page. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
required
string
page
integer format: int32

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Unsplash search results without any remote image URL.

object
page
required
integer format: int32
results
required
Array<object>

One search result. The thumbnail URL points back to this server.

object
credit
required

Photographer and photo page credit from Unsplash.

object
name
required
string
photo_url
required
string
profile_url
required
string
description
string | null
id
required
string
thumbnail_url
required
string
total
required
integer format: int64
total_pages
required
integer format: int32
Examplegenerated
{
  "page": 1,
  "results": [
    {
      "credit": {
        "name": "example",
        "photo_url": "example",
        "profile_url": "example"
      },
      "description": "example",
      "id": "example",
      "thumbnail_url": "example"
    }
  ],
  "total": 1,
  "total_pages": 1
}

400

Section titled “400”
Media typeapplication/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:

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"
  }
}

404

Section titled “404”
Media typeapplication/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:

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"
  }
}

429

Section titled “429”
Media typeapplication/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:

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

Section titled “503”
Media typeapplication/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:

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"
  }
}