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": "a54be36f-1c35-46dc-91e2-b3bc8327875b",
      "type": "deleted_records",
      "attributes": {
        "created_at": "2022-01-12T17:18:38Z",
        "deletable_id": "6fc2197c-6f5b-4ccf-93ac-6d204069986f",
        "deletable_type": "Contact",
        "deleted_at": "2022-01-11T00:00:00Z",
        "deleted_from_id": "c8c7a949-4126-48b5-bfa8-5c20ded08b6e",
        "deleted_from_type": "AccountList",
        "updated_at": "2022-01-12T17:18:38Z",
        "updated_in_db_at": "2022-01-12T17:18:38Z"
      },
      "relationships": {
        "deletable": {
          "data": {
            "id": "6fc2197c-6f5b-4ccf-93ac-6d204069986f",
            "type": "contacts"
          }
        },
        "deleted_from": {
          "data": {
            "id": "c8c7a949-4126-48b5-bfa8-5c20ded08b6e",
            "type": "account_lists"
          }
        },
        "deleted_by": {
          "data": {
            "id": "968a8fca-8ea1-42c8-a487-8da61d8a0e6c",
            "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