Get location image​

GET
/locations/{locationId}/images/{imageId}

Returns metadata for one image associated with the location. Use the download endpoint to retrieve the file itself.

Use cases

  • Inspect the image category before changing or removing the image.

Related endpoints

  • GET /locations/{locationId}/images — list image metadata.
  • PATCH /locations/{locationId}/images/{imageId} — change its category.
  • GET /locations/{locationId}/images/{imageId}/download — retrieve its bytes.

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-02"
Pattern
^\d{4}-\d{2}-\d{2}$
organization-id*

Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.

Type
string
Required
Example"3b241101-e2bb-4255-8caf-4136c566a962"
Min Length
1
Max Length
40

Path Parameters

locationId*

ID returned by POST /locations or GET /locations. It scopes location updates and image operations to one site.

Type
string
Required
Example"2ABCDEFGHJKLMNPQRSTU"
Min Length
1
Max Length
40
imageId*

ID returned in the image-id response header or images[]. Pair it with locationId to retrieve or update that image.

Type
string
Required
Example"image-7f3a9c"
Min Length
1
Max Length
40

Responses​

success.location.image.get

application/json

Playground​

Authorization
Headers
Variables
Key
Value

Samples​