Lister les listes et segments

GET

https://core.shopimind.com/v1/lists

Retourne une liste paginée de vos listes et segments de contacts, triée par date de création par défaut. Le type d'une ligne vaut list (statique, alimentée manuellement) ou segment (dynamique, alimentée par segmentation_config). Les compteurs (total_contacts, total_subscribers, total_unsubscribeds) sont en cohérence éventuelle avec l'ingestion des contacts. Les paramètres filters, order, limit, offset et fields permettent d'affiner la réponse.

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_shop_list": 12,

  

  

  

"name": "Subscribers FR",

  

  

  

"description": "French-speaking newsletter subscribers",

  

  

  

"contacts_count": 3421,

  

  

  

"is_active": true,

  

  

  

"created_at": "2024-01-05T09:00:00.000Z",

  

  

  

"updated_at": "2024-04-22T17:30: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

Playground

Headers

spm-api-key*

Variables

Key

Value

limit

offset

order

fields

filters

Samples

Lister les listes et segments Retourne une liste paginée de vos listes et segments de contacts, triée par date de création par défaut. Le type d'une ligne vaut list (statique, alimentée manuellement) ou segment (dynamique, alimentée par segmentation_config). Les compteurs (total_contacts, total_subscribers, total_unsubscribeds) sont en cohérence éventuelle avec l'ingestion des contacts. Les paramètres filters, order, limit, offset et fields permettent d'affiner la réponse. GET /v1/lists listLists Lists 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