List contacts

GET

https://core.shopimind.com/v1/contacts/all

Returns a paginated list of your contacts, sorted by creation date by default. Supports filters, order, limit, offset, and fields to refine the response.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

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

Query Parameters

fields

Subset of contact fields to return. Comma-separated string or repeated query parameter.

Type

array

Valid values

"id_shop_contact""id_customer_shop""id_shop_customer""contact_data_email""contact_data_sms""contact_data_push""contact_first_name""contact_last_name""contact_gender""contact_birthday""contact_lang""contact_country""contact_state""contact_latitude""contact_longitude""optin_data_email""optin_data_sms""unsub_data_email""unsub_data_sms""unsub_data_push""reject_data_email""reject_data_sms""reject_data_push""last_views_data_email""last_views_data_sms""last_views_data_push""last_views_data_embed""last_views_data_popin""last_clics_data_email""last_clics_data_sms""last_clics_data_push""last_clics_data_embed""last_clics_data_popin""last_sales_data_email""last_sales_data_sms""last_sales_data_push""last_sales_data_embed""last_sales_data_popin""last_sales_data_valid""perfect_timing_data_email""perfect_timing_data_sms""perfect_timing_data_push""can_receive_email""can_receive_sms""can_receive_push""is_registered""active""created_on_shop_at""created_at""updated_at"

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" }

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_shop_contact": 5678,

  

  

  

"id_customer_shop": "cust_001",

  

  

  

"contact_data_email": "customer@example.com",

  

  

  

"contact_first_name": "Marie",

  

  

  

"contact_last_name": "Dupont",

  

  

  

"contact_lang": "fr",

  

  

  

"is_subscribed_newsletter": true,

  

  

  

"created_at": "2024-01-15T08:00: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/contacts/all

Playground

Headers

spm-api-key*

Variables

Key

Value

fields

limit

offset

order

filters

Samples

List contacts Returns a paginated list of your contacts, sorted by creation date by default. Supports filters, order, limit, offset, and fields to refine the response. GET /v1/contacts/all listContacts Contacts spm-api-key [Authentication] Required API key. fields Subset of contact fields to return. Comma-separated string or repeated query parameter. limit Maximum number of records to return offset Number of records to skip order Sorting criteria, array of objects with field and type properties 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