List live photos
URL
GET https://api.complycube.com/v1/livePhotos?clientId=:id
This endpoint allows you to list all existing live photos for a given client. The live photos are returned sorted by creation date, with the most recent live photos appearing first.
Headers
Name
Type
Description
Authorization*
string
The API live or test key.
Query parameters
Name
Type
Description
clientId*
string
The ID of the client.
<pagination>
string
The number of items to return and the number of pages to offset.
<filtering>
string
Filter the results.
Example request
curl -X GET https://api.complycube.com/v1/livePhotos?clientId={:clientId} \
-H 'Authorization: <YOUR_API_KEY>'const { ComplyCube } = require("@complycube/api");
const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });
const livePhotos = await complycube.livePhoto.list("CLIENT_ID");from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')
photo_list = cc_api.livephotos.list('CLIENT_ID')use ComplyCube\ComplyCubeClient;
$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');
$result = $ccapi->livephotos()->list('CLIENT_ID');using ComplyCube.Net;
using ComplyCube.Net.Resources.LivePhotos;
var livePhotoApi = new LivePhotoApi(new ComplyCubeClient("<YOUR_API_KEY>"));
var livePhotos = await livePhotoApi.ListAsync("CLIENT_ID");Example responses
{
"page": 1,
"pageSize": 100,
"totalItems": 1,
"pages": 1,
"items": [
{
"id": "5eb1b5f231778a0008d1c3f6",
"clientId": "5eb1276d96be4a0008713af5",
"downloadLink": "/livePhotos/5eb1b5f231778a0008d1c3f6/download",
"contentType": "images/jpg",
"performLivenessCheck": true,
"size": 44896,
"createdAt": "2020-01-01T14:06:44.756Z",
"updatedAt": "2020-01-01T14:06:44.756Z"
}
]
}{
"type": "invalid_request",
"message": "The query parameter 'clientId' is required"
}Last updated
Was this helpful?