Quickstart

In this guide, we will briefly introduce you to making requests to and getting responses from the ola.cv API endpoints. The ola.cv API is mostly RESTful and organized by the resources your account own or have access to, with very few exceptions.

HTTP Methods

All usual HTTP verbs such as POST, GET, PUT and DELETE are supported by our API endpoints, and the allowed method for each endpoint would be indicated on the appropriate sections.

Making Requests

Sample API calls are provided next to each method using cURL, so you can just insert your specific parameters, and you can get up and running from your command line or terminal.

You can also use HTTP clients such as Postman, if you are not so familiar or comfortable with cURL or the terminal.

You can also just point your AI agents and tools such as Claude, Codex, Cursor, OpenCode, Gemini, GitHub Copilot or Windsurf to the whole documentation or to specific resources and they can make requests on your behalf using your API token(s).

Getting Responses

Both request body data and response data are formatted as JSON. Responses will always be returned with the content type application/json, and will generally be in the following format:

Example response

{
  "message": "[string]",
  "data": {
    "id": "442723857177096192"
    // ...
  }
}

Example Response

Name
response.message
Description
This is a summary of the response and its status e.g. when trying to retrieve a list of your contacts, message might say "Contacts retrieved successfully." In the event of an error, the message key will contain a description of the error.
Name
response.data
Description
This contains the results of your request. It can either be an object, or an array depending on the request made, e.g. a request to retrieve a single contact will return a object in the data key, while the key would be an array of contacts if a collection is requested.
Name
response.errors
Description
This contains the errors of bad and unprocessable requests, such as when your request inputs cannot be validated, or you are not authorized to make such requests. It is object with keys for each error encountered.
Name
response.meta
Description
The meta key is used to provide additional context for the contents of the data key.

Example response

{
  "message": "Domain registered successfully.",
  "data": {
    "id": "442723857177096192",
    "domain": "domain.cv",
    "auto_renew": true,
    "registered_at": "2026-05-06T16:26:31.000000Z",
    "expires_at": "2027-05-06T16:26:32.000000Z",
    "created_at": "2026-05-06T16:26:32.000000Z",
    "updated_at": "2026-05-06T16:26:32.000000Z"
  }
}