Shoot

Each Tenant is allowed a collection of Shoots.

These act as a grouping of 360 media, typically corresponding to a photoshoot session.

PreviousTenant NextMedia

Last updated 1 year ago

Was this helpful?

Get Shoot

Get an individual shoot by id

get

/api/tenant/{tenantId}/shoot/{shootId}

Authorizations

Path parameters

shootIdstringrequired

Unique shoot id

Example: 683606ee-9788-4d88-adb8-77119de4c6a2

tenantIdstringrequired

Unique tenant id

Example: f700d27e-64ed-4571-ae2e-8c948c1c296e

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.orb360.tech/api/tenant/{tenantId}/shoot/{shootId}'

200

401

404

{
  "shoot": {
    "id": "683606ee-9788-4d88-adb8-77119de4c6a2",
    "version": 123,
    "createdBy": "auth0|dd5e21fb23efe45d1761ddce",
    "name": "Black Cat",
    "tenant": "fdb67f2e-219d-4771-b14f-a2ddc24b812b",
    "dateCreated": 1594988393066,
    "dateUpdated": 1594988393066,
    "published": true,
    "mediaNameFormat": "{tag:StyleNumber}",
    "mediaTagKeys": [
      "StyleNumber"
    ],
    "integrations": {
      "findByTag": {
        "enabled-apiKey": true,
        "enabled-public": true
      },
      "findById": {
        "enabled-apiKey": true,
        "enabled-public": true
      }
    },
    "generatedMediaPresets": {
      "360_V2": {
        "jpg": null,
        "gif": null,
        "mp4": null
      },
      "SINGLE_IMAGE": {
        "jpg": null
      },
      "VIDEO": {
        "m3u8": null
      }
    }
  }
}

success

List Shoots

List available Shoots within the requested Tenant

get

/api/tenant/{tenantId}/shoot