Skip to main content
POST
Get list of expiring saved clips in organization

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request object for retrieving clips with progress information and filtering options.

pageSize
integer<int32> | null
default:100
required
int32

Page size

Required range: 1 <= x <= 200
deviceUuidFilters
(string<RUUID> | null)[] | null

Device uuids to filter clips by.

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

excludeAlertMonitoringClips
boolean | null
default:false

Filter to exclude clips created for alarm monitoring verification.

filterByPrivate
boolean | null
default:false

Filter to only include private clips in the result.

locationUuidFilters
(string<RUUID> | null)[] | null

Location uuids to filter clips by.

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

pageToken
string | null

Page token received from the previous search request.

Example:

"next_page_token_123"

searchFilter
string | null

Search filter for clips

Example:

"motion detected"

sortField
string | null

Field to sort clips by

Example:

"timestamp"

sortOrder
string | null

Sort order (asc or desc)

Example:

"desc"

timestampFilterField
string | null

Timestamp to filter clips by (either clip creation date or clip footage date).

timestampMsAfter
integer<int64> | null
int64

Timestamp to find clips after this time.

Example:

1640995200000

timestampMsBefore
integer<int64> | null
int64

Timestamp to find clips before this time

Example:

1641081600000

Response

200 - application/json

OK

Response object containing clips with progress information.

error
boolean | null
errorMsg
string | null
pageToken
string | null

Token to be supplied on the next search request to get the next page. If token is null, there is no more data available.

savedClips
object[] | null

List of saved clips with progress information

warningMsg
string | null
Last modified on August 9, 2026