DROP Management

Get List of DROP Records

Use this API to retrieve a list of DROP records by the specified filter criteria. The response will include details such as the DROP record identifier, created date, and DSAR request ID.

post/api/drop-manager/v1/drops

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/drop-manager/v1/drops
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: DSAR_READ, DSAR_WRITE

Query parameters

pageinteger

Results page to be retrieved (0..N)

sizeinteger

Number of records per page

sort'dateCreated,asc' | 'dateCreated,desc' | 'dateUpdated,asc' | 'dateUpdated,desc'

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.

Request body

Example request

{
  "filterCriteria": [
    {
      "attributeKey": "status",
      "operator": "EQ"
    }
  ]
}

Response

OK

totalElementsinteger
totalPagesinteger
sizeinteger
numberinteger
firstboolean
lastboolean
numberOfElementsinteger
emptyboolean

Example response

{
  "content": [
    {
      "id": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
      "dropId": "A7kP2xQ9Lm4R",
      "hash": "abc123hash",
      "hashType": "Phone",
      "dateCreated": "2024-01-01T00:00:00.000+00:00",
      "dateUpdated": "2024-01-15T12:30:00.000+00:00",
      "dataType": "Email",
      "dsarRequestId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad",
      "batchName": "20260420_1041_PHONE.csv",
      "source": "Production",
      "status": "PENDING"
    }
  ]
}

Changes

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