List contacts in a list or segment

GET

https://core.shopimind.com/v1/lists/{id_list}/contacts

Returns a paginated list of contacts that currently belong to the specified list or segment, sorted by membership date by default. Membership for segments reflects the latest computation (see keep_updated on updateList). 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}$"

Path Parameters

id_list*

List identifier

Type

number

Required

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

  

  

  

"id_customer_shop": "cust_001",

  

  

  

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

  

  

  

"contact_first_name": "Marie",

  

  

  

"added_to_list_at": "2024-02-10T11:20: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/lists/{id_list}/contacts

Playground

Headers

spm-api-key*

Variables

Key

Value

id_list*

limit

offset

order

fields

filters

Samples

List contacts in a list or segment Returns a paginated list of contacts that currently belong to the specified list or segment, sorted by membership date by default. Membership for segments reflects the latest computation (see keep_updated on updateList). Supports filters, order, limit, offset, and fields to refine the response. GET /v1/lists/{id_list}/contacts listListContacts Lists spm-api-key [Authentication] Required API key. id_list List identifier 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