List contact consent history

GET

https://core.shopimind.com/v1/contact-consent-history

Returns a paginated list of GDPR consent history entries, sorted by creation date by default. Each entry records a change of consent state for a channel (email, sms, push). Supports filters (e.g. id_contact, channel, event_type), order, limit, offset, and fields to refine the response. Records are immutable.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

"^[a-zA-Z0-9-]{20,64}$"

Query Parameters

limit

Maximum number of records to return

Type

number

Example10

offset

Number of records to skip

Type

number

Example0

order

Sorting criteria, array of objects with field and type properties

Type

array

Examples

{ "field": "created_at", "type": "desc" }

fields

Fields to include in the response, comma-separated or array

Examples

"id,name,created_at"

filters

Filter criteria, array of objects with field, operator and values properties.

Available operators: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, LESS_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, IN, NOT_IN, LIKE, BETWEEN, NOT_BETWEEN

Type

array

Examples

{ "field": "status", "operator": "EQUALS", "values": "active" }

Responses

Paginated listing response.

Content-Type

application/json

{

  

"statusCode": 200,

  

"data": [

  

  

{

  

  

  

"id": 1234,

  

  

  

"id_shop_contact": 5678,

  

  

  

"consent_type": "newsletter",

  

  

  

"source": "form",

  

  

  

"value": true,

  

  

  

"occurred_at": "2024-04-30T18:25:00.000Z"

  

  

}

  

],

  

"meta": {

  

  

"pagination": {

  

  

  

"total_items": 100,

  

  

  

"items_per_page": 10,

  

  

  

"total_pages": 10,

  

  

  

"current_page": 1,

  

  

  

"offset": 0,

  

  

  

"has_previous_page": false,

  

  

  

"has_next_page": true,

  

  

  

"next_page": 2,

  

  

  

"previous_page": 0

  

  

},

  

  

"generated_at": "2024-05-06T14:32:11.000Z"

  

}

}

GET

https://core.shopimind.com/v1/contact-consent-history

Playground

Headers

spm-api-key*

Variables

Key

Value

limit

offset

order

fields

filters

Samples

List contact consent history Returns a paginated list of GDPR consent history entries, sorted by creation date by default. Each entry records a change of consent state for a channel (email, sms, push). Supports filters (e.g. id_contact, channel, event_type), order, limit, offset, and fields to refine the response. Records are immutable. GET /v1/contact-consent-history listContactConsentHistory Contact Consent History spm-api-key [Authentication] Required API key. limit Maximum number of records to return offset Number of records to skip order Sorting criteria, array of objects with field and type properties fields Fields to include in the response, comma-separated or array filters Filter criteria, array of objects with field, operator and values properties. Available operators: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, LESS_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, IN, NOT_IN, LIKE, BETWEEN, NOT_BETWEEN Paginated listing response. Client error - Invalid request or authentication issues Server error - Internal processing failure