Retrieve paginated list of videos

get

https://api.pixop.com/api/v1/videos

Retrieves a paginated list of videos associated with the provided API key.

Query Params

pageNumber

int32

≥ 0

Defaults to 0

Specifies the current page number, starting at 0.

pageSize

int32

1 to 100

Defaults to 10

Specifies the number of items per page.

sortDirection

string

enum

Defaults to ASC

Specifies the sort direction for the results:

ASC: ascending order.
DESC: descending order.

Allowed:

sortBy

string

enum

Defaults to createdAt

Specifies the field to sort the results by.

Allowed:

teamId

uuid

Filters results by the specified team ID.

projectId

uuid

Filters results by the specified project ID. Includes only videos with the given project ID.

masterVideoId

uuid

Filters results to include only videos derived from the specified masterVideoId.

clipId

uuid

Filters results to include only videos whose clipId matches the specified value.

clipMode

string

enum

Defaults to INCLUDE

Filters results based on the clip mode:

INCLUDE: Includes clips in the result.
EXCLUDE: Excludes clips from the result.
ONLY: Only returns clips in the result.

Allowed:

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Successfully retrieved the paginated list of video items.

400Invalid request. Inspect the details of the error for more information.

401Authentication failed. Missing or invalid X-API-Key or basic authentication credentials.

403Access denied. You do not have the necessary permissions to access this resource.

404The requested resource could not be found.

429Too Many Requests. The rate limit for this resource has been exceeded.

500An unexpected error occurred on the server.