Content Management Field Values API

The Field Values API is in phase and is not yet available to users. You can contact the Product-Live team at contact@product-live.com if you want more details and get an early access.

Introduction

A Field Value designates an option of a single select, a multiple select or a category of a classification.

The Field Values API Swagger definition is available on our Product-Live API portal here.

General information

• Rate limit: 50 requests per minute

Get Field Value by id

Request URL

Path parameters

Parameter	Type	Description
fieldValueId	string	A field value id

Request parameters

None

Request headers

Header	Type	Value
accept	string	application/json
X-Api-Key	string	Your account API key
X-Context	number	The account id of your partner in order to search its shared table field values

Request Body

None

Request Example

curl

curl -X 'GET' \
  'GET https://api.product-live.com/v1/field_values/24653136' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>' \
  -H 'X-Context: 4013'

Response Example

{
    "object": "field_value",
    "id": "24653136",
    "metadata": {},
    "title": "Headset",
    "status": "ACTIVE",
    "color": "NONE",
    "key": "HEADSET",
    "createdAt": "2025-01-06T14:39:15.000Z",
    "updatedAt": "2025-01-06T14:39:15.000Z",
    "tableId": "1470",
    "fieldId": "2330462"
}

List Field Values

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
fieldId	string	A field Id
page	integer	Optional The page number to retrieve. Default value if missing : 0
size	integer	Optional The number of items per page. Default value if missing : 10

Request headers

Header	Type	Value
accept	string	application/json
X-Api-Key	string	Your account API key
X-Context	number	The account id of your partner in order to search its shared table field values

Request Body

None

Request Example

curl

curl -X 'GET' \
  'https://api.product-live.com/v1/field_values?fieldId=2330462&page=0&size=1' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: <REDACTED>' \
  -H 'X-Context: 4013'

Response example

{
    "object": "list",
    "data": [
        {
            "object": "field_value",
            "id": "24653136",
            "metadata": {},
            "title": "Headset",
            "status": "ACTIVE",
            "color": "NONE",
            "key": "HEADSET",
            "createdAt": "2025-01-06T14:39:15.000Z",
            "updatedAt": "2025-01-06T14:39:15.000Z",
            "tableId": "1470",
            "fieldId": "2330462"
        }
    ],
    "totalElements": 7
}

Find Field Values

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
fieldId	string	A field Id
page	integer	Optional The page number to retrieve. Default value if missing : 0
size	integer	Optional The number of items per page. Default value if missing : 10
sort	string	Optional The field property to use to sort results
sortOrder	string	Optional The sort direction: ASC or DESC

Request headers

Header	Type	Value
accept	string	application/json
X-Api-Key	string	Your account API key
X-Context	number	The account id of your partner in order to search its shared table field values

Request Body

See more details on the find request body in the dedicated page Find request.

Single parameter research

{
    "type": "search",
    "caseSensitive": true,
    "field": "title",
    "value": "Headset"
}

Multiple parameters research

{
  "type": "and",
  "queries": [
    {
        "type": "search",
        "caseSensitive": true,
        "field": "title",
        "value": "Headset"
    },
    {
        "type": "greaterOrEqual",
        "caseSensitive": true,
        "field": "createdAt",
        "value": "2025-01-06T14:39:15.000Z"
    }
  ]
}

Request Example

curl -X 'POST' \
  'https://api.product-live.com/v1/field_values/find?fieldId=2330462&page=0&size=10&sort=id&sortOrder=ASC' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>' \
  -H 'X-Context: 4013'
  -d '{
  "type": "and",
  "queries": [
        {
        "type": "search",
        "caseSensitive": true,
        "field": "title",
        "value": "Headset"
    },
    {
        "type": "greaterOrEqual",
        "caseSensitive": true,
        "field": "createdAt",
        "value": "2025-01-06T14:39:15.000Z"
    }
  ]
}'

Response example

{
    "object": "list",
    "data": [
        {
            "object": "field_value",
            "id": "24653136",
            "metadata": {},
            "title": "Headset",
            "status": "ACTIVE",
            "color": "NONE",
            "key": "HEADSET",
            "createdAt": "2025-01-06T14:39:15.000Z",
            "updatedAt": "2025-01-06T14:39:15.000Z",
            "tableId": "1470",
            "fieldId": "2330462"
        }
    ],
    "totalElements": 7
}