{"info":{"_postman_id":"80c92276-17cd-4ee5-98d1-9bb49c69fd3b","name":"Splento Universal API v3.7","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"12661550","collectionId":"80c92276-17cd-4ee5-98d1-9bb49c69fd3b","publishedId":"2s93CRLsBG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2EDBE3"},"publishDate":"2023-03-02T17:03:17.000Z"},"item":[{"name":"Introduction","item":[],"id":"3f5299a8-858e-43fc-bd49-42f55847b4a4","description":"

The Splento API is your universal API for commissioning and handling visual content.

\n

For example, you can use the Splento API for the following:

\n
    \n
  1. On-demand photography: Commission photoshoots with Splento network photographers across 90% of the English-speaking world.
    2. \n
  2. Editing services: Commission photo editing services according to pre-defined specifications, with two different types of service available:
      \n
    1. Fully automated: Our fastest editing service, producing near-instant results.
      2. \n
    2. Human-augmented editing services: Our most premium editing service, backed by the world's best professional photo editors.
      3. \n
    \n
    3. \n
  3. Image handling: Retrieve and handle images from photoshoots and editing jobs.
    4. \n
\n

In future releases, you will also be able to use the Splento API for the following:

\n
    \n
  1. On-demand videography: Commission video shoots with Splento network videographers.
    2. \n
  2. Referrals: Refer your customers to recommended on-demand photography or videography products.
    3. \n
  3. Asset distribution: Trigger sharing of images or videos, or push assets to third-party destinations.
    4. \n
  4. Prints: Use images to order various customised print products.
    5. \n
  5. Stock photography: Retrieve stock photos according to pre-defined specifications.
    6. \n
\n

The Splento API is available only to Splento For Enterprise customers. If you do not currently have a Splento for Enterprise account and are interesting in setting one up, contact our support team support@splento.com

\n

We have code examples in Shell, displayed in the panel on the right. We will have language bindings for JavaScript very soon.

\n","event":[{"listen":"prerequest","script":{"id":"27e528d1-b3a6-4a74-93fe-f92fc21280cf","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e57f796d-b0cb-4327-980b-e76caa076ed0","type":"text/javascript","exec":[""]}}],"_postman_id":"3f5299a8-858e-43fc-bd49-42f55847b4a4"},{"name":"Environment","item":[],"id":"6d0a6b76-beb1-4fb5-a313-75249e1f3a8b","description":"
\n

Illustrative Production request:

\n
\n
curl \"https://api.splento.com/v3/endpoint\" \\\n  -H ...\n  -H ...\n\n
\n

Illustrative Sandbox (testing) request:

\n
\n
curl \"https://sandbox.splento.com/v3/endpoint\" \\\n  -H ...\n  -H ...\n\n

We provide both a Production environment for real-world use and a Sandbox environment for testing purposes.

\n

For Production use, use the base URL https://api.splento.com/v3 as in the examples throughout the documentation.

\n

For Sandbox use, substitute the base URL for https://api.splento.com/v3.

\n

Sandbox endpoints return dummy data, not data from your account. For Sandbox endpoints with a write action (e.g. create endpoints), changes made via those endpoints will not be reflected in subsequent Sandbox requests.

\n","_postman_id":"6d0a6b76-beb1-4fb5-a313-75249e1f3a8b"},{"name":"Authentication","item":[],"id":"80fce1a5-532e-45a9-ae64-b4f7f0f76ad0","description":"
\"/example-endpoint\" \\\n  -H \"Authorization: Bearer zkTvDUe5jJBJFcjc6ckwapEwax8Kbs7h3nv2SHXSgh5qGhHP22ggsu4fbdZgf25z\"\n\n
\n

Replace the example key above with your API key. This fake key is used in all of the following request examples.

\n
\n

Splento uses API keys to allow access to the API. You can access or regenerate your API key from your dedicated Splento manager. Each user has a single unique active API key. Regenerating your API key will deactivate your previous key. Deleting a user will deactivate their API key.

\n

An API key needs to be included in all API requests in a header of this format:

\n

Authorization: Bearer api_key

\n

You must replace api_key with your user API key.

\n","_postman_id":"80fce1a5-532e-45a9-ae64-b4f7f0f76ad0"},{"name":"Coverage","item":[{"name":"Get Coverage","id":"02b9b2ef-2233-47bc-bb37-6134333a00ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.splento.com/v3/coverage?latidude=Number&longitude=Number&address=String&shoottype=String&creator_id=String","description":"

This endpoint returns Splento coverage status (boolean) for a given location and shoot type. Coverage status is independent of specific dates or times.

\n

*One of the following is required: address; or latitude and longitude. If both are provided, only latitude and longitude will be used

\n","urlObject":{"path":["coverage"],"host":["https://api.splento.com/v3"],"query":[{"description":{"content":"

Latitude of the shoot location.

\n","type":"text/plain"},"key":"latidude","value":"Number"},{"description":{"content":"

Longitude of the shoot location.

\n","type":"text/plain"},"key":"longitude","value":"Number"},{"description":{"content":"

Address of the shoot location. Must be a Google Maps valid address.

\n","type":"text/plain"},"key":"address","value":"String"},{"description":{"content":"

Name of the shoot type (see Shoot types endpoints), e.g. \"event\".

\n","type":"text/plain"},"key":"shoottype","value":"String"},{"description":{"content":"

The identifier of the creator. You can use this parameter to check if a specific creator has coverage for your desired location

\n","type":"text/plain"},"key":"creator_id","value":"String"}],"variable":[]}},"response":[{"id":"a11c4dfd-4d2b-4ed7-b7ce-ad2008401158","name":"Get Coverage","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.splento.com/v3/coverage?latidude=Number&longitude=Number&address=String&shoottype=String&creator_id=String","host":["https://api.splento.com/v3"],"path":["coverage"],"query":[{"key":"latidude","value":"Number","description":"Latitude of the shoot location."},{"key":"longitude","value":"Number","description":"Longitude of the shoot location."},{"key":"address","value":"String","description":"Address of the shoot location. Must be a Google Maps valid address."},{"key":"shoottype","value":"String","description":"Name of the shoot type (see Shoot types endpoints), e.g. \"event\"."},{"key":"creator_id","value":"String","description":"The identifier of the creator. You can use this parameter to check if a specific creator has coverage for your desired location"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"latitude\": 37.8077,\n \"longitude\": -122.477,\n \"shoottype\": \"event\",\n \"coverage\": false\n}"}],"_postman_id":"02b9b2ef-2233-47bc-bb37-6134333a00ff"}],"id":"7103dacd-2ace-4b8e-b184-dfcfd4d6c32a","_postman_id":"7103dacd-2ace-4b8e-b184-dfcfd4d6c32a","description":""},{"name":"Availability","item":[{"name":"Get Availability","id":"120430ec-cfd3-41c8-9400-630a90ae5663","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.splento.com/v3/availability?latitude=Number&longitude=Number&address=String&shoottype=String&duration=Integer&date=Date (ISO)&creator_id=String","description":"

This endpoint returns time availability (i.e. available shoot start times) for a combination of location, date, shoot type and duration.

\n

All available times within the range of the local date will be returned. However, the format of the returned times is always in UTC for simplicity.

\n

*One of the following is required: address; or latitude and longitude. If both are provided, only latitude and longitude will be used

\n","urlObject":{"path":["availability"],"host":["https://api.splento.com/v3"],"query":[{"description":{"content":"

Latitude of the shoot location.

\n","type":"text/plain"},"key":"latitude","value":"Number"},{"description":{"content":"

Longitude of the shoot location.

\n","type":"text/plain"},"key":"longitude","value":"Number"},{"description":{"content":"

Address of the shoot location. Must be a Google Maps valid address.

\n","type":"text/plain"},"key":"address","value":"String"},{"description":{"content":"

Name of the shoot type (see Shoot types endpoints), e.g. \"event\".

\n","type":"text/plain"},"key":"shoottype","value":"String"},{"description":{"content":"

Length of the shoot in minutes.

\n","type":"text/plain"},"key":"duration","value":"Integer"},{"description":{"content":"

Date for which you want to check time availability.

\n","type":"text/plain"},"key":"date","value":"Date (ISO)"},{"description":{"content":"

The identifier of the creator. You can use this to get the availability of a specific Splento creator.

\n","type":"text/plain"},"key":"creator_id","value":"String"}],"variable":[]}},"response":[{"id":"7f3ac7df-865e-4bbe-bda1-63e816ee458a","name":"Get Availability","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.splento.com/v3/availability?latitude=Number&longitude=Number&address=String&shoottype=String&duration=Integer&date=Date (ISO)&creator_id=String","host":["https://api.splento.com/v3"],"path":["availability"],"query":[{"key":"latitude","value":"Number","description":"Latitude of the shoot location."},{"key":"longitude","value":"Number","description":"Longitude of the shoot location."},{"key":"address","value":"String","description":"Address of the shoot location. Must be a Google Maps valid address."},{"key":"shoottype","value":"String","description":"Name of the shoot type (see Shoot types endpoints), e.g. \"event\"."},{"key":"duration","value":"Integer","description":"Length of the shoot in minutes."},{"key":"date","value":"Date (ISO)","description":"Date for which you want to check time availability."},{"key":"creator_id","value":"String","description":"The identifier of the creator. You can use this to get the availability of a specific Snappr creator."}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"latitude\": 37.8077,\n \"longitude\": -122.477,\n \"shoottype\": \"event\",\n \"duration\": 120,\n \"date\": \"2022-12-01\",\n \"timezone\": \"Europe/London\",\n \"available_times\": [\n \"2018-12-01T07:30:00Z\",\n \"2018-12-01T09:30:00Z\",\n \"2018-12-01T15:00:00Z\",\n \"2018-12-01T15:30:00Z\"\n ]\n}"}],"_postman_id":"120430ec-cfd3-41c8-9400-630a90ae5663"}],"id":"d0ae8264-0450-428d-98e6-89be93180d64","_postman_id":"d0ae8264-0450-428d-98e6-89be93180d64","description":""},{"name":"Bookings","item":[{"name":"Create New Booking","id":"7ff1e7cb-de6b-45ab-bc59-e5786924af7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"String","description":"

Custom shoot title.

\n","type":"text"},{"key":"latitude","value":"String","description":"

Latitude of the shoot location.

\n","type":"text"},{"key":"longitude","value":"String","description":"

Longitude of the shoot location.

\n","type":"text"},{"key":"address","value":"String","description":"

Address of the shoot location. Must be a Google Maps valid address.

\n","type":"text"},{"key":"shoottype","value":"String","description":"

Name of the shoot type (see Shoot types endpoints), e.g. \"event\".

\n","type":"text"},{"key":"start_at","value":"Datetime (ISO)","description":"

Start time of the shoot in UTC. If this is set to null, then Splento will automatically seek this information from the end-customer

\n","type":"text"},{"key":"duration","value":"Integer","description":"

Length of the shoot in minutes.

\n","type":"text"},{"key":"location_notes","value":"String","description":"

Details to help the photographer find the specific location and contact person at the time of the shoot.

\n","type":"text"},{"key":"style_notes","value":"String","description":"

Instructions, stylistic preferences and other special requests.

\n","type":"text"},{"key":"customer_firstname","value":"String","description":"

First name of your end-customer.

\n","type":"text"},{"key":"customer_surname","value":"String","description":"

Last name of your end-customer.

\n","type":"text"},{"key":"customer_email","value":"String","description":"

Valid email address of your end-customer.

\n","type":"text"},{"key":"customer_mobilephone","value":"String","description":"

Valid mobile phone number of your end-customer.

\n","type":"text"},{"key":"customer_company","value":"String","description":"

Name of your end-customer's company.

\n","type":"text"},{"key":"internal_id","value":"String","description":"

ID for your internal systems. Useful for matching a booking with your internal data.

\n","type":"text"},{"key":"creator_id","value":"String","description":"

The identifier of the creator. You can use this to assign this booking to a specific Splento creator.

\n","type":"text"}]},"url":"https://api.splento.com/v3/bookings","description":"

This endpoint creates a new photoshoot booking.

\n

Broadly, there are two main ways to create a new photoshoot booking, and examples are provided for each:

\n
    \n
  1. Provide all shoot details including the start date and time for the shoot (start_at). With this option, Splento will not seek any input on shoot details from your end-customer, they will simply be notified if the booking is placed successfully.
    2. \n
  2. Provide all shoot details except the start date and time for the shoot (start_at set to null). This will trigger an automatic process to collect the start date and time from your end-customer using the contact details (email and/or mobile phone) provided. End-customers will be able to select from all available dates and times for the shoot location, using a Splento UI.
    3. \n
\n

If start_at is set to null the system assumes you want the end-customer to pick the start date and time, the response will include a scheduling_url that can be used by the end-customer to pick an appropiate date and time

\n

Always check availability before trying to create a new booking with start_at defined. If you try to make a booking at for combination of location, date/time and shoot type for which there are no available photographers, you will receive a 400 error (see Errors section).

\n

*One of the following is required: address; or latitude and longitude. If both are provided, only latitude and longitude will be used

\n","urlObject":{"path":["bookings"],"host":["https://api.splento.com/v3"],"query":[],"variable":[]}},"response":[{"id":"5105e7d8-b03f-4d0b-b2cf-2eb3092b9ebc","name":"Create New Booking","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.splento.com/v3/bookings?title=String&latitude=Number&longitude=Number&address=String&shoottype=String&start_at=Datetime (ISO)&duration=Integer&location_notes=String&style_notes=String&customer_firstname=String&customer_surname=String&customer_email=String&customer_mobilephone=String&customer_company=String&internal_id=String&creator_id=String","host":["https://api.splento.com/v3"],"path":["bookings"],"query":[{"key":"title","value":"String","description":"Custom shoot title."},{"key":"latitude","value":"Number","description":"Latitude of the shoot location."},{"key":"longitude","value":"Number","description":"Longitude of the shoot location."},{"key":"address","value":"String","description":"Address of the shoot location. Must be a Google Maps valid address."},{"key":"shoottype","value":"String","description":"Name of the shoot type (see Shoot types endpoints), e.g. \"event\"."},{"key":"start_at","value":"Datetime (ISO)","description":"Start time of the shoot in UTC. If this is set to null, then Splento will automatically seek this information from the end-customer."},{"key":"duration","value":"Integer","description":"Length of the shoot in minutes."},{"key":"location_notes","value":"String","description":"Details to help the photographer find the specific location and contact person at the time of the shoot."},{"key":"style_notes","value":"String","description":"Instructions, stylistic preferences and other special requests."},{"key":"customer_firstname","value":"String","description":"First name of your end-customer."},{"key":"customer_surname","value":"String","description":"Last name of your end-customer."},{"key":"customer_email","value":"String","description":"Valid email address of your end-customer."},{"key":"customer_mobilephone","value":"String","description":"Valid mobile phone number of your end-customer."},{"key":"customer_company","value":"String","description":"Name of your end-customer's company."},{"key":"internal_id","value":"String","description":"ID for your internal systems. Useful for matching a booking with your internal data."},{"key":"creator_id","value":"String","description":"The identifier of the creator. You can use this to assign this booking to a specific Snappr creator."}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"uid\": \"0ccefa53-b346-4d3e-8dcb-79a914289928\",\n \"title\": \"Tintagel House\",\n \"status\": \"paid\",\n \"credits\": 249,\n \"latitude\": 51.48877,\n \"longitude\": -0.12352,\n \"shoottype\": \"event\",\n \"start_at\": \"2022-12-01T07:30:00Z\",\n \"duration\": 120,\n \"location_notes\": \"Location is Tintagel House - ask reception at main entrance on arrival\",\n \"style_notes\": \"Shots of as many members of crowd as possible; shallow depth of field where possible\",\n \"customer_firstname\": \"John\",\n \"customer_surname\": \"Macdonald\",\n \"customer_email\": \"test@splento.com\",\n \"customer_mobilephone\": \"+442081231838\",\n \"customer_company\": \"Splento Ltd\",\n \"creator_name\": \"Gemma G.\",\n \"creator_id\": \"69a66cb2-dcb2-4803-9d23-f7894e443e68\",\n \"creator_profile_image_url\": \"https://s3-eu-west-1.amazonaws.com/download.splento.com/portfolios/36/avatar.jpg\",\n \"created_at\": \"2018-09-01T09:12:00Z\",\n \"updated_at\": \"2018-09-01T09:12:00Z\"\n}"}],"_postman_id":"7ff1e7cb-de6b-45ab-bc59-e5786924af7d"},{"name":"Get All Bookings","id":"6c9cb1f6-9939-4d30-9cc7-f50d334ba021","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.splento.com/v3/bokings?limit=Integer&offset=Integer","description":"

This endpoint retrieves all bookings.

\n

The API does not currently support booking filters (e.g. filtering by a certain status), but this is planned for an upcoming release.

\n","urlObject":{"path":["bokings"],"host":["https://api.splento.com/v3"],"query":[{"description":{"content":"

Maximum number of bookings to be returned (maximum of 100). Defaults to 100.

\n","type":"text/plain"},"key":"limit","value":"Integer"},{"description":{"content":"

Offset used for pagination if there are more bookings than the limit (or more than 100 bookings if there is no limit). Defaults to 0.

\n","type":"text/plain"},"key":"offset","value":"Integer"}],"variable":[]}},"response":[{"id":"6a15ca1b-ecec-4491-a1ad-08d3566cd6e6","name":"Get All Bookings","originalRequest":{"method":"GET","header":[],"url":"https://api.splento.com/v3/bokings"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"uid\": \"0ccefa53-b346-4d3e-8dcb-79a914289928\",\n \"title\": \"Tintagel Houset\",\n \"status\": \"paid\",\n \"credits\": 249,\n \"latitude\": 51.48877,\n \"longitude\": -0.12352,\n \"shoottype\": \"event\",\n \"start_at\": \"2022-12-01T07:30:00Z\",\n \"duration\": 120,\n \"location_notes\": \"Location is Tintagel House - ask reception at main entrance on arrival\",\n \"style_notes\": \"Shots of as many members of crowd as possible; shallow depth of field where possible\",\n \"customer_firstname\": \"John\",\n \"customer_surname\": \"Macdonald\",\n \"customer_email\": \"test@splento.com\",\n \"customer_mobilephone\": \"+442081231838\",\n \"customer_company\": \"Splento.com\",\n \"internal_id\": \"123-ABC\",\n \"creator_name\": \"Gemma G.\",\n \"creator_id\": \"69a66cb2-dcb2-4803-9d23-f7894e443e68\",\n \"creator_profile_image_url\": \"https://s3-eu-west-1.amazonaws.com/download.splento.com/portfolios/36/avatar.jpg\",\n \"created_at\": \"2022-09-01T09:12:00Z\",\n \"updated_at\": \"2022-09-01T09:12:00Z\"\n },\n {\n \"uid\": \"48b095fd-7fc0-41dc-b632-9b032e0a65e6\",\n \"title\": \"Family Shoot\",\n \"status\": \"paid\",\n \"credits\": 349,\n \"latitude\": 51.48877,\n \"longitude\": -0.12352,\n \"shoottype\": \"family\",\n \"start_at\": \"2022-12-01T07:30:00Z\",\n \"duration\": 180,\n \"location_notes\": \"Meet near the park entance\",\n \"style_notes\": \"Variety of group shots of the family with different backgrounds\",\n \"customer_firstname\": \"John\",\n \"customer_surname\": \"Macdonald\",\n \"customer_email\": \"testing@splento.com\",\n \"customer_mobilephone\": \"+442081231838\",\n \"customer_company\": null,\n \"creator_name\": \"Margot R.\",\n \"creator_id\": \"69a66cb2-dcb2-4803-9d23-f7894e443e68\",\n \"creator_profile_image_url\": \"https://s3-eu-west-1.amazonaws.com/download.splento.com/portfolios/36/avatar.jpg\",\n \"created_at\": \"2022-09-01T08:34:00Z\",\n \"updated_at\": \"2022-09-01T08:34:00Z\"\n }\n ],\n \"count\": 2,\n \"limit\": 100,\n \"offset\": 0,\n \"total\": 2\n}"}],"_postman_id":"6c9cb1f6-9939-4d30-9cc7-f50d334ba021"},{"name":"Get Single Booking","id":"4c903126-0049-4efe-a970-abc8f165fae6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.splento.com/v3/bookings/[booking_uid]","description":"

This endpoint retrieves a specific booking using the ID of the booking.

\n","urlObject":{"path":["bookings","[booking_uid]"],"host":["https://api.splento.com/v3"],"query":[],"variable":[]}},"response":[{"id":"b4780a20-17ce-4484-96bd-ccf2e3626f39","name":"Get Single Booking","originalRequest":{"method":"GET","header":[],"url":"https://api.splento.com/v3/bookings/[booking_uid]"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"uid\": \"0ccefa53-b346-4d3e-8dcb-79a914289928\",\n \"title\": \"Tintagel House\",\n \"status\": \"paid\",\n \"credits\": 249,\n \"latitude\": 51.48877,\n \"longitude\": -0.12352,\n \"shoottype\": \"event\",\n \"start_at\": \"2022-12-01T07:30:00Z\",\n \"duration\": 120,\n \"location_notes\": \"Location is Tintagel House - ask reception at main entrance on arrival\",\n \"style_notes\": \"Shots of as many members of crowd as possible; shallow depth of field where possible\",\n \"customer_firstname\": \"John\",\n \"customer_surname\": \"Macdonald\",\n \"customer_email\": \"test@splento.com\",\n \"customer_mobilephone\": \"+442081231838\",\n \"customer_company\": \"Splento Ltd\",\n \"internal_id\": \"123-ABC\",\n \"creator_name\": \"Gemma G.\",\n \"creator_id\": \"69a66cb2-dcb2-4803-9d23-f7894e443e68\",\n \"creator_profile_image_url\": \"https://s3-eu-west-1.amazonaws.com/download.splento.com/portfolios/36/avatar.jpg\",\n \"created_at\": \"2022-09-01T09:12:00Z\",\n \"updated_at\": \"2022-09-01T09:12:00Z\"\n}"}],"_postman_id":"4c903126-0049-4efe-a970-abc8f165fae6"}],"id":"32cfad47-24d8-404f-9400-04aeb957fb05","_postman_id":"32cfad47-24d8-404f-9400-04aeb957fb05","description":""},{"name":"Editing Jobs","item":[{"name":"Create New Editing Job","id":"67a1670c-f272-4e84-a0f8-38198f0958b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"String","description":"

Custom editing job title.

\n","type":"text"},{"key":"type","value":"String","description":"

Name of the editing job type (see Editing job types endpoints), e.g. \"event\".

\n","type":"text"},{"key":"images","value":"Array of Image objects","description":"

Array of source images. If it is set to null then Splento will automatically seek this information from a third party uploader.

\n","type":"text"},{"key":"uploader_firstname","value":"String","description":"

First name of third party uploader.

\n","type":"text"},{"key":"uploader_surname","value":"String","description":"

Last name of third party uploader.

\n","type":"text"},{"key":"uploader_mobilephone","value":"String","description":"

Valid mobile phone number of third party uploader.

\n","type":"text"},{"key":"uploader_company","value":"String","description":"

Name of third party uploader's company.

\n","type":"text"},{"key":"internal_id","value":"String","description":"

ID for your internal systems. Useful for matching an editing job with your internal data.

\n","type":"text"},{"key":"preset_id","value":"String","description":"

ID of your preset. New presets need to be created in the GUI.

\n","type":"text"}]},"url":"https://api.splento.com/v3/editing-jobs","description":"

This endpoint creates a new editing job.

\n

Broadly, there are two main ways to create a new editing job, and examples are provided for each:

\n
    \n
  1. Provide all editing job details including the source images (images).
    2. \n
  2. Provide all editing job details except the source images (images set to null). This will trigger an automatic process to collect the images from your third party uploader using the contact details (email and/or mobile phone) provided.
    3. \n
\n

If images is set to null the system assumes you want a third party uploader to upload the images.

\n","urlObject":{"path":["editing-jobs"],"host":["https://api.splento.com/v3"],"query":[],"variable":[]}},"response":[{"id":"03ec6527-a3a7-4734-91c8-12524021a134","name":"Create New Editing Job","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"String","description":"Custom editing job title.","type":"text"},{"key":"type","value":"String","description":"Name of the editing job type (see Editing job types endpoints), e.g. \"event\".","type":"text"},{"key":"images","value":"Array of Image objects","description":"Array of source images. If it is set to null then Snappr will automatically seek this information from a third party uploader.","type":"text"},{"key":"uploader_firstname","value":"String","description":"First name of third party uploader.","type":"text"},{"key":"uploader_surname","value":"String","description":"Last name of third party uploader.","type":"text"},{"key":"uploader_mobilephone","value":"String","description":"Valid mobile phone number of third party uploader.","type":"text"},{"key":"uploader_company","value":"String","description":"Name of third party uploader's company.","type":"text"},{"key":"internal_id","value":"String","description":"ID for your internal systems. Useful for matching an editing job with your internal data.","type":"text"},{"key":"preset_id","value":"String","description":"ID of your preset. New presets need to be created in the GUI.","type":"text"}]},"url":"https://api.splento.com/v3/editing-jobs"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"uid\": \"0ccefa53-b346-4d3e-8dcb-79a914289928\",\n \"title\": \"Restaurant gallery\",\n \"status\": \"pending_upload\",\n \"type\": \"food\",\n \"preset_id\": \"1ea37f86-c82d-4267-8773-9a13fd4f1337\",\n \"uploader_firstname\": \"John\",\n \"uploader_surname\": \"Macdonald\",\n \"uploader_email\": \"test@splento.com\",\n \"uploader_mobilephone\": \"+442081231838\",\n \"uploader_company\": \"Splento Ltd\",\n \"internal_id\": \"123-ABC\",\n \"created_at\": \"2022-09-01T09:12:00Z\",\n \"updated_at\": \"2022-09-01T09:12:00Z\"\n}"}],"_postman_id":"67a1670c-f272-4e84-a0f8-38198f0958b9"},{"name":"Get All Editing Jobs","id":"804e8a22-d76c-450a-84da-78e193788462","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.splento.com/v3/editing-jobs?limit=Integer&offset=Integer","description":"

This endpoint retrieves all editing jobs.

\n

The API does not currently support editing job filters (e.g. filtering by a certain status), but this is planned for an upcoming release.

\n","urlObject":{"path":["editing-jobs"],"host":["https://api.splento.com/v3"],"query":[{"description":{"content":"

Maximum number of editing jobs to be returned (maximum of 100). Defaults to 100.

\n","type":"text/plain"},"key":"limit","value":"Integer"},{"description":{"content":"

Offset used for pagination if there are more editing jobs than the limit (or more than 100 editing jobs if there is no limit). Defaults to 0.

\n","type":"text/plain"},"key":"offset","value":"Integer"}],"variable":[]}},"response":[{"id":"c752c380-b59e-4a61-aac7-8cf879e718f7","name":"Get All Editing Jobs","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.splento.com/v3/editing-jobs?limit=Integer&offset=Integer","host":["https://api.splento.com/v3"],"path":["editing-jobs"],"query":[{"key":"limit","value":"Integer","description":"Maximum number of editing jobs to be returned (maximum of 100). Defaults to 100."},{"key":"offset","value":"Integer","description":"Offset used for pagination if there are more editing jobs than the limit (or more than 100 editing jobs if there is no limit). Defaults to 0."}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"uid\": \"0ccefa53-b346-4d3e-8dcb-79a914289928\",\n \"title\": \"Restaurant gallery\",\n \"status\": \"paid\",\n \"credits\": 9,\n \"type\": \"food photography\",\n \"uploader_firstname\": \"John\",\n \"uploader_surname\": \"Macdonald\",\n \"uploader_email\": \"test@splento.com\",\n \"uploader_mobilephone\": \"+442081231838\",\n \"uploader_company\": \"Splento Ltd\",\n \"internal_id\": \"123-ABC\",\n \"created_at\": \"2022-09-01T09:12:00Z\",\n \"updated_at\": \"2022-09-01T09:12:00Z\"\n },\n {\n \"uid\": \"48b095fd-7fc0-41dc-b632-9b032e0a65e6\",\n \"title\": \"Headshots\",\n \"status\": \"completed\",\n \"credits\": 11,\n \"type\": \"headshots\",\n \"created_at\": \"2022-09-01T08:34:00Z\",\n \"updated_at\": \"2022-09-01T08:34:00Z\"\n }\n ],\n \"count\": 2,\n \"limit\": 100,\n \"offset\": 0,\n \"total\": 2\n}"}],"_postman_id":"804e8a22-d76c-450a-84da-78e193788462"},{"name":"Get Single Editing Job","id":"52b6b611-7c0d-41e2-b40c-43b354a6d70d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.splento.com/v3/editing-jobs/[editing_job_uid]","description":"

This endpoint retrieves a specific editing job using the ID of the editing job.

\n","urlObject":{"path":["editing-jobs","[editing_job_uid]"],"host":["https://api.splento.com/v3"],"query":[],"variable":[]}},"response":[{"id":"262064f2-578f-4cc5-84a2-a74435b17142","name":"Get Single Editing Job","originalRequest":{"method":"GET","header":[],"url":"{URL}/editing-jobs/[editing_job_uid]"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"uid\": \"0ccefa53-b346-4d3e-8dcb-79a914289928\",\n \"title\": \"Restaurant gallery\",\n \"status\": \"paid\",\n \"credits\": 9,\n \"type\": \"food photography\",\n \"uploader_firstname\": \"John\",\n \"uploader_surname\": \"Macdonald\",\n \"uploader_email\": \"test@splento.com\",\n \"uploader_mobilephone\": \"+442081231838\",\n \"uploader_company\": \"Splento Ltd\",\n \"internal_id\": \"123-ABC\",\n \"created_at\": \"2022-09-01T09:12:00Z\",\n \"updated_at\": \"2022-09-01T09:12:00Z\"\n}"}],"_postman_id":"52b6b611-7c0d-41e2-b40c-43b354a6d70d"}],"id":"19351f7c-e159-469b-90e7-43f768bd19db","_postman_id":"19351f7c-e159-469b-90e7-43f768bd19db","description":""},{"name":"Presets","item":[{"name":"Get All Presets","id":"444817da-3bcb-4361-a1c9-9f7afc09f46a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.splento.com/v3/presets?limit=Integer&offset=Integer","description":"

This endpoint retrieves all the presets.

\n","urlObject":{"path":["presets"],"host":["https://api.splento.com/v3"],"query":[{"description":{"content":"

Maximum number of presets to be returned (maximum of 10000). Defaults to 1000.

\n","type":"text/plain"},"key":"limit","value":"Integer"},{"description":{"content":"

Offset used for pagination if there are more presets than the limit (or more than 1000 presets if there is no limit). Defaults to 0.

\n","type":"text/plain"},"key":"offset","value":"Integer"}],"variable":[]}},"response":[{"id":"e8d60394-6292-46c1-a8e4-efc69e1c09c3","name":"Get All Presets","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.splento.com/v3/presets?limit=Integer&offset=Integer","host":["https://api.splento.com/v3"],"path":["presets"],"query":[{"key":"limit","value":"Integer","description":"Maximum number of presets to be returned (maximum of 10000). Defaults to 1000."},{"key":"offset","value":"Integer","description":"Offset used for pagination if there are more presets than the limit (or more than 1000 presets if there is no limit). Defaults to 0."}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"uid\": \"ed10cf86-97f9-4ce6-af6f-a01dfe891114\",\n \"name\": \"Restaurant menu\",\n \"description\": \"In-depth improvements on photos taken by restaurant owners.\"\n },\n {\n \"uid\": \"ee9be5f8-84a8-4592-88a0-1781d0c39d0a\",\n \"name\": \"Liquor store\"\n }\n ],\n \"count\": 2,\n \"limit\": 1000,\n \"offset\": 0,\n \"total\": 2\n}"}],"_postman_id":"444817da-3bcb-4361-a1c9-9f7afc09f46a"}],"id":"0dbc7def-cb4e-437d-9288-6fd4ae6862ed","_postman_id":"0dbc7def-cb4e-437d-9288-6fd4ae6862ed","description":""},{"name":"Images","item":[{"name":"Get All Images For a Booking","id":"d82724ec-9f88-41cc-804f-64197c48114d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.splento.com/v3/bookings/[booking_uid]/images?limit=Integer&offset=Integer","description":"

This endpoint retrieves all the images of a specific booking.

\n","urlObject":{"path":["bookings","[booking_uid]","images"],"host":["https://api.splento.com/v3"],"query":[{"description":{"content":"

Maximum number of images to be returned (maximum of 10000). Defaults to 1000.

\n","type":"text/plain"},"key":"limit","value":"Integer"},{"description":{"content":"

Offset used for pagination if there are more images than the limit (or more than 1000 images if there is no limit). Defaults to 0

\n","type":"text/plain"},"key":"offset","value":"Integer"}],"variable":[]}},"response":[{"id":"87196484-959d-45eb-b860-991f104049e2","name":"Get All Images For a Booking","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.splento.com/v3/bookings/[booking_uid]/images?limit=Integer&offset=Integer","protocol":"https","host":["api","splento","com"],"path":["v3","bookings","[booking_uid]","images"],"query":[{"key":"limit","value":"Integer","description":"Maximum number of images to be returned (maximum of 10000). Defaults to 1000."},{"key":"offset","value":"Integer","description":"Offset used for pagination if there are more images than the limit (or more than 1000 images if there is no limit). Defaults to 0"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"uid\": \"ed10cf86-97f9-4ce6-af6f-a01dfe891114\",\n \"file_name\": \"ZD 001.JPG\",\n \"url_original\": \"https://dl-cf.splento.com/rp/50829/p/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\",\n \"url_thumb\": \"https://dl-cf.splento.com/rp/50829/pss/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\"\n },\n {\n \"uid\": \"ee9be5f8-84a8-4592-88a0-1781d0c39d0a\",\n \"file_name\": \"ZD 002.JPG\",\n \"url_original\": \"https://dl-cf.splento.com/rp/50829/p/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\",\n \"url_thumb\": \"https://dl-cf.splento.com/rp/50829/pss/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\"\n },\n {\n \"uid\": \"6b6eae3e-ebfb-4776-8a20-2b8087f76418\",\n \"file_name\": \"ZD 003.JPG\",\n \"url_original\": \"https://dl-cf.splento.com/rp/50829/p/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\",\n \"url_thumb\": \"https://dl-cf.splento.com/rp/50829/pss/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\"\n }\n ],\n \"count\": 3,\n \"limit\": 1000,\n \"offset\": 0,\n \"total\": 3\n}"}],"_postman_id":"d82724ec-9f88-41cc-804f-64197c48114d"},{"name":"Get All Images For an Editing Job","id":"ebd669d2-d8ef-4429-b074-59e735c65c7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.splento.com/v3/editing-jobs/[editing_job_uid]/images?limit=Integer&offset=Integer","description":"

This endpoint retrieves all the images of a specific editing job.

\n","urlObject":{"path":["editing-jobs","[editing_job_uid]","images"],"host":["https://api.splento.com/v3"],"query":[{"description":{"content":"

Maximum number of images to be returned (maximum of 10000). Defaults to 1000.

\n","type":"text/plain"},"key":"limit","value":"Integer"},{"description":{"content":"

Offset used for pagination if there are more images than the limit (or more than 1000 images if there is no limit). Defaults to 0.

\n","type":"text/plain"},"key":"offset","value":"Integer"}],"variable":[]}},"response":[{"id":"3f5bf05a-a20a-4666-a845-b530c6dbb66f","name":"Get All Images For an Editing Job","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.splento.com/v3/editing-jobs/[editing_job_uid]/images?limit=Integer&offset=Integer","host":["https://api.splento.com/v3"],"path":["editing-jobs","[editing_job_uid]","images"],"query":[{"key":"limit","value":"Integer","description":"Maximum number of images to be returned (maximum of 10000). Defaults to 1000."},{"key":"offset","value":"Integer","description":"Offset used for pagination if there are more images than the limit (or more than 1000 images if there is no limit). Defaults to 0."}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"uid\": \"ed10cf86-97f9-4ce6-af6f-a01dfe891114\",\n \"source\": {\n \"file_name\": \"ZD 001.JPG\",\n \"url_original\": \"https://dl-cf.splento.com/rp/50829/p/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\",\n \"url_thumb\": \"https://dl-cf.splento.com/rp/50829/pss/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\"\n },\n \"final\": {\n \"file_name\": \"ZD 001.JPG\",\n \"url_original\": \"https://dl-cf.splento.com/rp/50829/p/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\",\n \"url_thumb\": \"https://dl-cf.splento.com/rp/50829/pss/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\"\n }\n },\n {\n \"uid\": \"ee9be5f8-84a8-4592-88a0-1781d0c39d0a\",\n \"source\": {\n \"file_name\": \"ZD 002.JPG\",\n \"url_original\": \"https://dl-cf.splento.com/rp/50829/p/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\",\n \"url_thumb\": \"https://dl-cf.splento.com/rp/50829/pss/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\"\n },\n \"final\": {\n \"file_name\": \"ZD 002.JPG\",\n \"url_original\": \"https://dl-cf.splento.com/rp/50829/p/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\",\n \"url_thumb\": \"https://dl-cf.splento.com/rp/50829/pss/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\"\n }\n },\n {\n \"uid\": \"6b6eae3e-ebfb-4776-8a20-2b8087f76418\",\n \"source\": {\n \"file_name\": \"ZD 003.JPG\",\n \"url_original\": \"https://dl-cf.splento.com/rp/50829/p/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\",\n \"url_thumb\": \"https://dl-cf.splento.com/rp/50829/pss/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\"\"\n },\n \"final\": {\n \"file_name\": \"ZD 003.JPG\",\n \"url_original\": \"https://dl-cf.splento.com/rp/50829/p/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\",\n \"url_thumb\": \"https://dl-cf.splento.com/rp/50829/pss/_no_wmo_1e8pbpc341oum1hscnns8i15901k.jpg\"\n }\n }\n ],\n \"count\": 3,\n \"limit\": 1000,\n \"offset\": 0,\n \"total\": 3\n}"}],"_postman_id":"ebd669d2-d8ef-4429-b074-59e735c65c7f"}],"id":"16caff0a-bfd7-4384-998a-1e8e6cf451c2","_postman_id":"16caff0a-bfd7-4384-998a-1e8e6cf451c2","description":""},{"name":"Shoot Types","item":[{"name":"Get All Shoot Types","id":"75936cde-eaef-4d7e-8f78-85e11aa8eccd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.splento.com/v3/shoottypes","description":"

This endpoint returns all available Splento shoot types.

\n","urlObject":{"path":["shoottypes"],"host":["https://api.splento.com/v3"],"query":[],"variable":[]}},"response":[{"id":"f4711856-4e78-4c27-ae6a-74ede0c37d17","name":"Get All Shoot Types","originalRequest":{"method":"GET","header":[],"url":"https://api.splento.com/v3/shoottypes"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"name\": \"food photography\",\n \"display_name\": \"Food Photography\"\n },\n {\n \"name\": \"property photography\",\n \"display_name\": \"Property Photography\"\n },\n ...\n ],\n \"count\": 10,\n \"limit\": 100,\n \"offset\": 0,\n \"total\": 10\n}"}],"_postman_id":"75936cde-eaef-4d7e-8f78-85e11aa8eccd"}],"id":"774436d4-7d55-4533-89fc-973e99004c70","_postman_id":"774436d4-7d55-4533-89fc-973e99004c70","description":""},{"name":"Editing Job Types","item":[{"name":"Get All Editing Job Types","id":"88ac7f77-8fdd-46c9-af40-dd46792f3e46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.splento.com/v3/editing-job-types","description":"

This endpoint returns all available Splento editing job types.

\n","urlObject":{"path":["editing-job-types"],"host":["https://api.splento.com/v3"],"query":[],"variable":[]}},"response":[{"id":"ac6401f4-d995-4209-aa6e-7092f378387e","name":"Get All Editing Job Types","originalRequest":{"method":"GET","header":[],"url":"https://api.splento.com/v3/editing-job-types"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"name\": \"food photography\",\n \"display_name\": \"Food Photography\"\n },\n {\n \"name\": \"property photography\",\n \"display_name\": \"Property Photography\"\n },\n ...\n ],\n \"count\": 10,\n \"limit\": 100,\n \"offset\": 0,\n \"total\": 10\n}"}],"_postman_id":"88ac7f77-8fdd-46c9-af40-dd46792f3e46"}],"id":"26360c1f-0e2f-4e90-96f3-bc765d173c77","_postman_id":"26360c1f-0e2f-4e90-96f3-bc765d173c77","description":""},{"name":"Custom Webhooks","item":[],"id":"106080c3-bfa7-482a-b202-fd2490c84179","description":"
\n

Example JSON payload sent to webhook URL as POST:

\n
\n
{\n  \"type\": \"update\",\n  \"booking\": {\n    \"uid\": \"0ccefa53-b346-4d3e-8dcb-79a914289928\",\n    \"title\": \"Tintagel House\",\n    \"status\": \"paid\",\n    \"credits\": 249,\n    \"latitude\": 51.48877,\n    \"longitude\": -0.12352,\n    \"shoottype\": \"event\",\n    \"start_at\": \"2022-12-01T07:30:00Z\",\n    \"duration\": 120,\n    \"location_notes\": \"Location is Tintagel House - ask reception at main entrance on arrival\",\n    \"style_notes\": \"Shots of as many members of crowd as possible; shallow depth of field where possible\",\n    \"customer_firstname\": \"John\",\n    \"customer_surname\": \"Macdonald\",\n    \"customer_email\": \"test@splento.com\",\n    \"customer_mobilephone\": \"+442081231838\",\n    \"customer_company\": \"Splento Ltd\",\n    \"internal_id\": \"123-ABC\",\n    \"creator_name\": \"Gemma G.\",\n    \"creator_id\": \"69a66cb2-dcb2-4803-9d23-f7894e443e68\",\n    \"created_at\": \"2018-09-01T09:12:00Z\",\n    \"updated_at\": \"2018-09-01T09:12:00Z\"\n  }\n}\n\n

You can set a custom webhook URL in the Splento Photography Portal GUI. If the custom webhook URL is set, we will POST to that URL every time a booking is created or updated.

\n","_postman_id":"106080c3-bfa7-482a-b202-fd2490c84179"},{"name":"Errors","item":[],"id":"927acfb7-07bf-4d9b-b78d-76244e3f6e85","description":"

The Splento API uses the following error codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StatusNameDescription
400SyntaxErrorRequest body has incorrect formatting. Most likely invalid JSON.
400InvalidAPIVersionRequested an invalid API version.
400UnsupportedVersionRequested an API version that is unsupported by the requested route.
400NotImplementedRequested a feature that is not currently implemented.
400ValidationErrorValidation failure. See 'Problems' field in response.
400ConflictRequest has a conflict with existing data.
400NotAvailableRequested resource is not available in your region or for the requested date/time.
400NoCoverageThere is no coverage by Splento on the requested latitude/longitude for the shoottype.
401UnauthorizedProvided access token is invalid or does not have access to requested resource.
402InsufficientCreditsThe account does not have a sufficient credit balance to perform the request. Add more credits in the GUI.
404NotFoundRequested resource not found.
429RateLimitThe rate limit of the provided access_token has been reached. Please have your application respect the X-RateLimit-Remaining header that is included on API responses.
500ServerErrorThere was an issue with our server. Try again later.
400UnknownErrorAn error occurred that is not a server error and is not described here.
\n
","_postman_id":"927acfb7-07bf-4d9b-b78d-76244e3f6e85"}],"event":[{"listen":"prerequest","script":{"id":"d8ba4573-39b0-4ef7-97db-a209e44ab72f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3d709c07-01bd-44cf-a130-17fa1d5e1c35","type":"text/javascript","exec":[""]}}],"variable":[{"key":"URL","value":"https://api.splento.com/v3"}]}