Skip to content
Figur

List published photography directions

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

List only active, client-visible canonical Shots with preview images.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
X-Shopify-Hmac-Sha256
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response V1 List Shots V1 Shots Get
Array<object>
PublishedShotResponse

Client-safe published Shot, as listed by the picker.

The listing stays narrow — source assets are resolved only on the detail read (PublishedShotDetailResponse), so a list call never pays to presign references nobody has asked to see.

object
public_id
required
Public Id
string
display_name
required
Display Name
string
reference_preview_url
required
Reference Preview Url
string
shot_info
required
PublishedShotInfoResponse
object
camera
required
PublishedShotCameraFramingResponse
object
crop
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
lens
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
angle
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
lighting
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
presentation
required
PublishedShotPresentationResponse
object
pose
required
Pose
string
gaze
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
expression
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
hair
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
makeup
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
garment_presentation
required
Garment Presentation
string
shared
Shared

True when this Shot belongs to Figur’s shared library rather than to you. A listing returns both, and only your own can be archived.

boolean
source_kind
Any of:
string
Example
[
  {
    "shot_info": {
      "camera": {
        "crop": {
          "kind": "preset"
        },
        "lens": {
          "kind": "preset"
        },
        "angle": {
          "kind": "preset"
        },
        "lighting": {
          "kind": "preset"
        }
      },
      "presentation": {
        "gaze": {
          "kind": "preset"
        },
        "expression": {
          "kind": "preset"
        },
        "hair": {
          "kind": "preset"
        },
        "makeup": {
          "kind": "preset"
        }
      }
    },
    "shared": false
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}