Profile

Retrieve a page of profile previews with server-side filtering and sorting to optimize querying profiles. Only the properties of ProfilePreview can be filtered and sorted.

Changed on

This is an experimental endpoint, may change in the future without any notice.

post/profiles/search

Request

Request body

globalFilterstring nullable

Value matched against every filterable column.

Response

OK.

totalCountinteger required

Total number of rows after filtering.

pageCountinteger required

Total number of pages.

pageIndexinteger required

Zero-based index of the current page.

pageSizeinteger required

Number of rows per page.

Example response

{
  "items": [
    {
      "id": "a7cafbbe-6bc0-4575-8c6e-f1adf391f180",
      "name": "mystic-turtle",
      "tags": [
        "facebook",
        "instagram"
      ],
      "proxy": {
        "extra": {
          "host": "127.0.0.1",
          "port": 9951,
          "id": "username",
          "secret": "password"
        }
      },
      "createdAt": "2020-05-02T03:10:32.2452701+10:00",
      "device": {
        "type": "desktop",
        "name": "Samsung SM-A705FN"
      },
      "os": {
        "family": "windows",
        "version": "10.15.4",
        "platform": "64"
      },
      "browser": {
        "product": "chrome",
        "major": 81,
        "version": "81.0.4044"
      },
      "language": "en-US,en",
      "folderId": "c7aafbbe-b6c0-5475-c66e-1fadf39180f1"
    }
  ]
}

Changes