Content Management Matrix Fields API

Introduction

The matrix defines which fields are common to all items and which fields are specific to categories for each classifications.

A matrix field represents if a field is common to all items or specific to which categories.

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

General information

• Rate limit: 50 requests per minute

Get Matrix Field by id

Request URL

Path parameters

Parameter	Type	Description
matrixFieldId	string	A matrix field 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 matrix fields

Request Body

None

Request Example

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

**Response Example**

```json
{
    "object": "matrix-field",
    "id": "11152959",
    "updatedAt": "2025-01-06T14:39:15.000Z",
    "createdAt": "2025-01-06T14:39:15.000Z",
    "tableId": "1470",
    "fieldId": "2330458",
    "status": "ACTIVE"
}

List Matrix Fields

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
tableId	string	A table 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 matrix fields

Request Body

None

Request Example

curl -X 'GET' \
  'https://api.product-live.com/v1/matrix-fields?tableId=1470size=1&page=0&sort=id&sortOrder=ASC' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: <REDACTED>' \
  -H 'X-Context: 4013'

**Response example**

```json
{
    "object": "list",
    "data": [
        {
            "object": "matrix-field",
            "id": "11152959",
            "updatedAt": "2025-01-06T14:39:15.000Z",
            "createdAt": "2025-01-06T14:39:15.000Z",
            "tableId": "1470",
            "fieldId": "2330458",
            "status": "ACTIVE"
        }
    ],
    "totalElements": 79
}

Find Matrix Fields

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
tableId	string	A table 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 matrix fields

Request Body

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

{
    "type": "eq",
    "caseSensitive": true,
    "field": "id",
    "value": "11152959"
}

Request Example

curl -X 'POST' \
  'https://api.product-live.com/v1/matrix-fields/find?tableId=1470size=1&page=0&sort=id&sortOrder=ASC' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>' \
  -H 'X-Context: 4013'
  -d '{
    "type": "eq",
    "caseSensitive": true,
    "field": "id",
    "value": "11152959"
}'

Response example

{
    "object": "list",
    "data": [
        {
            "object": "matrix-field",
            "id": "11152959",
            "updatedAt": "2025-01-06T14:39:15.000Z",
            "createdAt": "2025-01-06T14:39:15.000Z",
            "tableId": "1470",
            "fieldId": "2330458",
            "status": "ACTIVE"
        }
    ],
    "totalElements": 1
}