Skip to content
calternal docs

Search Photos

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

Requires a signed-in User. It returns Photos that match the text query and any camera, lens, place, date, ISO or aperture filters. It returns 400 when a filter or the result limit is invalid. Route: /api/v1/photos/search. Inputs: q, camera, lens, place, date, iso, aperture, limit. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string
camera
string
lens
string
place
string
date
string
iso
integer format: int64
aperture
number format: double
limit
integer

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
results
required
Array<object>
object
aperture
number | null format: double
camera
string | null
capture_day
required
string
capture_seconds
required
integer format: int64
href
required
string
iso
integer | null format: int64
item_id
required
string
latitude
number | null format: double
lens
string | null
longitude
number | null format: double
owner_id
required
string
path
required
string
place_name
string | null
score
number | null format: float
thumbnail_url
required
string
title
required
string
Examplegenerated
{
  "results": [
    {
      "aperture": 1,
      "camera": "example",
      "capture_day": "example",
      "capture_seconds": 1,
      "href": "example",
      "iso": 1,
      "item_id": "example",
      "latitude": 1,
      "lens": "example",
      "longitude": 1,
      "owner_id": "example",
      "path": "example",
      "place_name": "example",
      "score": 1,
      "thumbnail_url": "example",
      "title": "example"
    }
  ]
}

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

401

Section titled “401”
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"
  }
}