Records Management

Fetch a paginated list of contacts for a marketing list

Retrieves a paginated list of records for the specified object type. Supports filtering parameters.

get/api/list/{listId}/contacts

Request

  • Base URL: https://api.reallysimplesystems.com
  • URL: https://api.reallysimplesystems.com/api/list/{listId}/contacts
  • Auth: HTTP bearer

Response

Successful response containing the paginated list of contacts

Example response

{
  "data": {
    "metadata": {
      "url": "http://api.example.com/list/{listId}/contacts",
      "object_type": "list",
      "total_count": 100,
      "has_more": true
    },
    "list": [
      {
        "metadata": {
          "url": "http://api.example.com/api/contact/1",
          "list_url": "http://api.example.com/api/contacts",
          "parent": "http://api.example.com/api/account/1",
          "object_type": "record",
          "record_type": "contact"
        },
        "record": {
          "id": 1,
          "first": "First Name",
          "last": "Last Name",
          "email": "example@api.com"
        }
      }
    ],
    "links": {
      "first": "http://api.example.com/api/list/1/contacts?page=1",
      "last": "http://api.example.com/api/list/1/contacts?page=5",
      "prev": null,
      "next": "http://api.example.com/api/list/1/contacts?page=2"
    },
    "meta": {
      "current_page": 1,
      "from": 1,
      "last_page": 5,
      "path": "http://api.example.com/api/list/1/contacts",
      "per_page": 20,
      "to": 20,
      "total": 100
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.