Alta API Documentation

All list endpoints return a paginated list object. Use the next and previous cursors to navigate through pages. See Pagination for details on how to use cursor-based pagination.

Fields

object[]

required

The array of objects for the current page. The type of objects depends on the endpoint (e.g. Campaign, Prospect).

boolean

required

Whether there are more results available beyond this page.

string

Cursor to fetch the next page. Pass this as cursor in your next request.

string

Cursor to fetch the previous page. Pass this as cursor in your next request.

Example

{
  "data": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "objectType": "campaign",
      "name": "Q1 Outbound",
      "status": "active",
      "isArchived": false,
      "createdAt": "2024-01-10T08:00:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "hasMore": true,
  "next": "eyJpZCI6ImQyOTBmMWVlLTZjNTQtNGIwMS05MGU2LWQ3MDE3NDhmMDg1MSJ9"
}

Used in

All list endpoints return this wrapper:

List campaigns
List prospects
List companies
List persons
List email messages
List LinkedIn messages
List calls
List reps
List communication opt-outs

Getting started

Endpoints

Objects & Definitions

Paginated list

Fields

Example

Used in

​Fields

​Example

​Used in

Fields

Example

Used in