API

Get custom properties values linked to a spot member

GET /v1/spotMembers/{spotMemberId}/customPropertiesValues

Get custom properties values linked to a spot member

Path parameters

  • spotMemberId string Required

    The id of the spotMember

Query parameters

  • page integer | null

    The page number in a paginated set of results

  • limit integer | null

    The limit of results to be returned per page

Responses

  • 200 application/json

    Custom properties value returned successfully

    Hide response attributes Show response attributes object
    • items array[object] Required

      The items found

      Hide items attributes Show items attributes object
      • customPropertyId string Required

        The id of the custom property

      • customPropertyLabel string Required

        The label of the custom property

      • customPropertySlug string Required

        The slug of the custom property

      • customPropertyDescription string Required

        The description of the custom property

      • customPropertyType string Required

        The type of the custom property

        Values are Text, Boolean, Number, SingleSelect, MultipleSelect, or Date.

      • possibleValues array[string] | null Required

        The possible values of the custom property

      • value string | number | boolean | array[string] Required

        The values of the custom property

        One of:
        string-1 string number-2 number boolean-3 boolean array-4 array[string]
    • total integer Required

      The total number of items found
GET /v1/spotMembers/{spotMemberId}/customPropertiesValues 
curl \
 --request GET 'https://openapi.meltingspot.io/v1/spotMembers/{spotMemberId}/customPropertiesValues'
Response examples (200) 
{
  "items": [
    {
      "customPropertyId": "string",
      "customPropertyLabel": "string",
      "customPropertySlug": "string",
      "customPropertyDescription": "string",
      "customPropertyType": "Text",
      "possibleValues": [
        "string"
      ],
      "value": "string"
    }
  ],
  "total": 42
}