Retrieve a list or segment

GET

https://core.shopimind.com/v1/lists/{id_shop_list}

Retrieves the details of an existing list or segment. Pass fields[]=segmentation_config and/or fields[]=keep_updated to include segmentation details (segment-only fields).

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

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

Path Parameters

id_shop_list*

List identifier

Type

number

Required

Query Parameters

fields

Optional segment-only fields to include in the response. Pass segmentation_config and/or keep_updated.

Type

array

Valid values

"segmentation_config""keep_updated"

Responses

Resource successfully retrieved.

Content-Type

application/json

{

  

"statusCode": 200,

  

"data": {

  

  

"id_shop_list": 12,

  

  

"name": "Subscribers FR",

  

  

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

  

  

"type": "list",

  

  

"total_contacts": 3421,

  

  

"total_subscribers": 3200,

  

  

"total_unsubscribeds": 221,

  

  

"active": 1,

  

  

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

  

  

"updated_at": "2024-04-22T17:30:00.000Z"

  

}

}

GET

https://core.shopimind.com/v1/lists/{id_shop_list}

Playground

Headers

spm-api-key*

Variables

Key

Value

id_shop_list*

fields

Samples

Retrieve a list or segment Retrieves the details of an existing list or segment. Pass fields[]=segmentation_config and/or fields[]=keep_updated to include segmentation details (segment-only fields). GET /v1/lists/{id_shop_list} getList Lists spm-api-key [Authentication] Required API key. id_shop_list List identifier fields Optional segment-only fields to include in the response. Pass segmentation_config and/or keep_updated. Resource successfully retrieved. Client error - Invalid request or authentication issues Server error - Internal processing failure