List custom-data definitions relevant to a contact

GET

https://core.shopimind.com/v1/contacts/{id_contact}/custom-data-definitions

Returns active custom-data definitions whose source entity is contacts and that have at least one record stored for this contact. Use listCustomDataRecords to retrieve the actual values.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

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

Path Parameters

id_contact*

Internal Shopimind contact identifier (id_shop_contact).

Type

number

Required

Responses

Successfully retrieved relevant custom data definitions.

Content-Type

application/json

{

  

"statusCode": 200,

  

"data": [

  

  

{

  

  

  

"id_definition": 12,

  

  

  

"name": "loyalty_profile",

  

  

  

"description": "Loyalty data",

  

  

  

"source_field": "id_contact"

  

  

}

  

]

}

GET

https://core.shopimind.com/v1/contacts/{id_contact}/custom-data-definitions

Playground

Headers

spm-api-key*

Variables

Key

Value

id_contact*

Samples

List custom-data definitions relevant to a contact Returns active custom-data definitions whose source entity is contacts and that have at least one record stored for this contact. Use listCustomDataRecords to retrieve the actual values. GET /v1/contacts/{id_contact}/custom-data-definitions listContactCustomDataDefinitions Contacts spm-api-key [Authentication] Required API key. id_contact Internal Shopimind contact identifier (id_shop_contact). Successfully retrieved relevant custom data definitions. Client error - Invalid request or authentication issues Server error - Internal processing failure