v1

latestOpenAPI 3.0.02026-07-175989869.3 KB

Watermarks

List all watermarks

List all watermarks associated with your workspace.

get/watermarks

Query parameters

sortBystring

Allowed: createdAt. You can search by the time watermark were created at.

sortOrderstring

Allowed: asc, desc. asc is ascending and sorts from A to Z. desc is descending and sorts from Z to A.

currentPageinteger

Choose the number of search results to return per page. Minimum value: 1

pageSizeinteger

Results per page. Allowed values 1-100, default is 25.

Response

Success

Example response

{
  "pagination": {
    "itemsTotal": 123,
    "pagesTotal": 7,
    "pageSize": 20,
    "currentPage": 3,
    "currentPageItems": 20,
    "links": {
      "first": {
        "rel": "first",
        "uri": "/videos/search?currentPage=1&pageSize=20"
      },
      "previous": {
        "rel": "previous",
        "uri": "/videos/search?currentPage=2&pageSize=20"
      },
      "next": {
        "rel": "next",
        "uri": "/videos/search?currentPage=4&pageSize=20"
      },
      "last": {
        "rel": "last",
        "uri": "/videos/search?currentPage=6&pageSize=20"
      }
    }
  },
  "data": [
    {
      "watermarkId": "watermark_1BWr2L5MTQwxGkuxKjzh6i",
      "createdAt": "2019-06-24T11:45:01Z"
    },
    {
      "watermarkId": "watermark_1BWr2L5MTQwxGkuxKjzh6i",
      "createdAt": "2019-06-24T11:45:01Z"
    }
  ]
}