Content Management Users API

The Users 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 user is the user account assigned to someone. You can only retrieve users on your company account.

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

General information

• Rate limit: 50 requests per minute

Get User by id

Request URL

Path parameters

Parameter	Type	Description
userId	string	A user id

Request parameters

None

Request headers

Header	Type	Value
accept	string	application/json
X-Api-Key	string	Your account API key

Request Body

None

Request Example

curl

curl -X 'GET' \
  'GET https://api.product-live.com/v1/users/5443' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'

typescript SDK

Response example

{
    "object": "user",
    "id": "5443",
    "createdAt": "2021-09-15T13:14:41.000Z",
    "updatedAt": "2024-02-07T10:54:15.000Z",
    "firstName": "John",
    "lastName": "Doe",
    "email": "John.Doe@retailx.com",
    "status": "ACTIVE",
    "role": "EDITOR"
}

List Users

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
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

Request Body

None

Request Example

curl

curl -X 'GET' \
  'https://api.product-live.com/v1/users?size=1&page=0' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'

typescript SDK

Response example

{
    "object": "list",
    "data": [
        {
            "object": "user",
            "id": "5443",
            "createdAt": "2021-09-15T13:14:41.000Z",
            "updatedAt": "2024-02-07T10:54:15.000Z",
            "firstName": "John",
            "lastName": "Doe",
            "email": "John.Doe@retailx.com",
            "status": "ACTIVE",
            "role": "EDITOR"
        }
    ],
    "totalElements": 1
}

Find Users

Request URL

Path parameters

None

Request parameters

Parameter	Type	Description
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

Request Body

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

Single parameter research

{
    "type": "search",
    "caseSensitive": false,
    "field": "lastName",
    "value": "doe"
}

Multiple parameters research

{
  "type": "and",
  "queries": [
        {
        "type": "search",
        "caseSensitive": false,
        "field": "lastName",
        "value": "doe"
    },
    {
        "type": "eq",
        "caseSensitive": true,
        "field": "status",
        "value": "ACTIVE"
    }
  ]
}

Response Example

curl -X 'POST' \
  'https://api.product-live.com/v1/users/find?size=2&page=0' \
  -H 'accept: */*' \
  -H 'X-Api-Key: <REDACTED>'
  -d '{
  "type": "and",
  "queries": [
        {
        "type": "search",
        "caseSensitive": false,
        "field": "lastName",
        "value": "doe"
    },
    {
        "type": "eq",
        "caseSensitive": true,
        "field": "status",
        "value": "ACTIVE"
    }
  ]
}'

Response example

{
    "object": "list",
    "data": [
        {
            "object": "user",
            "id": "5443",
            "createdAt": "2021-09-15T13:14:41.000Z",
            "updatedAt": "2024-02-07T10:54:15.000Z",
            "firstName": "John",
            "lastName": "Doe",
            "email": "John.Doe@retailx.com",
            "status": "ACTIVE",
            "role": "EDITOR"
        },
        {
            "object": "user",
            "id": "5443",
            "createdAt": "2020-03-10T17:33:12.000Z",
            "updatedAt": "2023-11-17T10:10:07.000Z",
            "firstName": "Jane",
            "lastName": "Doe",
            "email": "Jane.Doe@retailx.com",
            "status": "ACTIVE",
            "role": "EDITOR"
        }
    ],
    "totalElements": 1
}