Content Management Matrix Fields API
The Matrix Fields 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
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
bash
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"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
bash
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
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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.
json
{
"type": "eq",
"caseSensitive": true,
"field": "id",
"value": "11152959"
}
1
2
3
4
5
6
2
3
4
5
6
Request Example
bash
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"
}'
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
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": 1
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15