Deleted Records

Deleted Records Documentation

Deleted Record [LIST]

Deleted Record [LIST]

Request

Endpoint

GET /api/v2/deleted_records
Content-Type: application/vnd.api+json

Body

Parameters

Filters

account_list_id

Type string

Description Filter by account_list_id

Required No

since_date

Type date

Description Filter by deleted_at date

Required No

types

Type string

Description Filter by deletable_type; Comma separated titlecase value e.g Contact,Activity

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "a4b78a18-5525-48f9-a3bf-da2600cdf8f7",
      "type": "deleted_records",
      "attributes": {
        "created_at": "2021-11-23T14:38:29Z",
        "deletable_id": "f42693e3-86fc-4fd1-889f-1025f4ac9235",
        "deletable_type": "Contact",
        "deleted_at": "2021-11-22T00:00:00Z",
        "deleted_from_id": "53956e5b-b150-4077-95a2-55fe35f74a5f",
        "deleted_from_type": "AccountList",
        "updated_at": "2021-11-23T14:38:29Z",
        "updated_in_db_at": "2021-11-23T14:38:29Z"
      },
      "relationships": {
        "deletable": {
          "data": {
            "id": "f42693e3-86fc-4fd1-889f-1025f4ac9235",
            "type": "contacts"
          }
        },
        "deleted_from": {
          "data": {
            "id": "53956e5b-b150-4077-95a2-55fe35f74a5f",
            "type": "account_lists"
          }
        },
        "deleted_by": {
          "data": {
            "id": "b7177697-2deb-44af-bb07-832796961f42",
            "type": "people"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_count": 1,
      "total_pages": 1
    },
    "sort": null,
    "filter": {
    }
  }
}

Fields

data

Type [Deleted Record]

Description An array of Deleted Record Objects