Skip to main content
GET
/
v1
/
clients
List Clients
curl --request GET \
  --url https://api.oviond.com/v1/clients \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "cliAbc123",
      "account_id": "ov:26AbCdEfGhIjKlMnOp",
      "name": "Acme Website",
      "website": "<string>",
      "timezone": "<string>",
      "currency": {
        "code": "USD",
        "symbol": "$",
        "iso": "US"
      },
      "screenshot": "<string>",
      "logo_url": "<string>",
      "favicon_url": "<string>",
      "folders": [
        "<string>"
      ],
      "created_at": "<string>",
      "updated_at": "<string>",
      "is_deleted": true,
      "deleted_at": "<string>"
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer | null
default:0
Required range: x >= 0
Example:

0

​
limit
integer
default:20
Required range: 1 <= x <= 100
Example:

20

​
search
string
Example:

"acme"

​
folder_id
string
Example:

"folderXyz"

​
sort_by
string
default:updated_at
Example:

"updated_at"

​
order
enum<string>
default:desc
Available options:
asc,
desc
Example:

"desc"

Response

200 - application/json

Paginated client list

​
success
enum<boolean>
required
Available options:
true
​
data
object[]
required
​
meta
object
required