Skip to content

Requests & Responses ​

Base URL ​

All endpoints are under:

https://api.youvico.com/api

Headers ​

HeaderValue
AuthorizationBearer YOUR_API_KEY
Content-Typeapplication/json, for requests with a body

Request body ​

The API accepts and returns JSON.

  • List endpoints with pagination use the QUERY method and take their inputs in the body. Send {} when you have none.
  • To point at another resource, send an object with its id:
json
{
  "folder": { "id": "DX1234567890ABCD" }
}

Response body ​

A response with a result wraps it in data:

json
{
  "data": {
    "id": "bdbff5de-96d7-468f-9db0-85fe28bd6b62",
    "name": "Launch Campaign"
  }
}
  • Paginated lists also return a page object. See Pagination.
  • Requests that return nothing, such as updates and deletes, respond with 204 No Content.
  • Failed requests return an error object. See Errors.

Timestamps ​

Timestamps are UTC strings in the YYYY-MM-DD HH:mm:ss[.ffffff] format, such as 2026-04-10 05:11:44.482913.

Field types ​

Field lists in the API reference use this notation:

NotationMeaning
stringAlways a value of that type
string?A value of that type, or null

Request fields marked required must be sent. Other request fields can be left out.