Content Management Screen sections API
The Screen sections 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
Screen sections allow to visually group properties within a screen. Sections are used to display item fields in the grid and in the detail view.
The Sections API Swagger definition is available on our Product-Live API portal here.
General information
- Rate limit: 50 requests per minute
Get Screen Section by id
Request URL
Path parameters
Parameter | Type | Description |
---|---|---|
screenSectionId | string | A screen section 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 get the list of sections shared with you |
Request Body
None
Request Example
bash
curl -X 'GET' \
'GET https://api.product-live.com/v1/screen_sections/988857' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>' \
-H 'X-Context: 4013'
1
2
3
4
5
2
3
4
5
Response Example
json
{
"object": "screen_section",
"id": "988857",
"updatedAt": "2025-02-27T15:36:55.000Z",
"createdAt": "2025-02-27T15:36:55.000Z",
"position": 1,
"sectionId": "1995",
"screenId": "789"
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
List Scren Sections
Request URL
Path parameters
None
Request parameters
Parameter | Type | Description |
---|---|---|
screenId | integer | The screen id where to list screen sections |
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 | / |
X-Api-Key | string | Your account API key |
X-Context | number | The account id of your partner in order to get the list of sections shared with you |
Request Body
None
Request Example
bash
curl -X 'GET' \
'https://api.product-live.com/v1/screen_sections?screenId=789&page=0&size=1&sortOrder=DESC&sort=key' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>' \
-H 'X-Context: 4013'
1
2
3
4
5
2
3
4
5
Response example
json
{
"object": "list",
"data": [
{
"object": "screen_section",
"id": "988857",
"updatedAt": "2025-02-27T15:36:55.000Z",
"createdAt": "2025-02-27T15:36:55.000Z",
"position": 1,
"sectionId": "1995",
"screenId": "789"
}
],
"totalElements": 4
}
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
Find Screen Sections
Request URL
Path parameters
None
Request parameters
Parameter | Type | Description |
---|---|---|
screenId | integer | The table id where to search sections |
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 get the list of sections shared with you |
Request Body
See more details on the find request body in the dedicated page Find request.
json
{
"type": "search",
"caseSensitive": true,
"field": "sectionId",
"value": "1995"
}
1
2
3
4
5
6
2
3
4
5
6
Request Example
bash
curl -X 'POST' \
'https://api.product-live.com/v1/screen_sections/find?size=10&page=0' \
-H 'accept: */*' \
-H 'X-Api-Key: <REDACTED>' \
-H 'X-Context: 4013'
-d '{
"type": "search",
"caseSensitive": true,
"field": "sectionId",
"value": "1995"
}'
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": "screen_section",
"id": "988857",
"updatedAt": "2025-02-27T15:36:55.000Z",
"createdAt": "2025-02-27T15:36:55.000Z",
"position": 1,
"sectionId": "1995",
"screenId": "789"
}
],
"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