Get Users

The Get User API is designed to retrieve a list of user profiles from our platform for an Organisation.

warning

Always ensure that sensitive users data is handled securely and in compliance with data protection regulations.

API Endpoint

Method: GET

URL: https://<PA_RM_END_POINT>/retail-media/users/{organisationId}

Request Header

Name	Value
Content-Type	application/json
Authorization	Bearer ACCESS_TOKEN

Request Query Parameters

Parameter	Type	Description
page	integer	The page number of the user list. Defaults to 1 if not specified.
limit	integer	The number of users to return per page. Defaults to 10 but can be set as needed up to a maximum of 100.

info

organisationId is the ID of the Retailer/Supplier's organisation whose users you want to retrieve. If no organisationId is provided, the API will return a list of all users across all organisations that are active for the connected application.

Response Payload

Success Response

• Status Code: 200 OK
• Payload: Returns list of users associated with the organisation in JSON format

{
  "users": [
    {
      "id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
      "organisationId": "xxxxxxxxxxxxxxxxxxxxxxxxx",
      "username": "username",
      "firstname": "FirstName",
      "lastname": "LastName",
      "mobile": "Mobile",
      "email": "abc@gmail.com"
    }
  ],
  "totalItems": 12,
  "totalPages": 1,
  "currentPage": 1,
  "pageSize": 20,
  "hasPreviousPage": false,
  "hasNextPage": false
}

Response Parameters

Parameter	Type	Description
users	Array of Object	Array of users.
totalItems	integer	Total number of users available for the given organisation.
totalPages	integer	Total number of pages available for the given organisation.
currentPage	integer	Current page number for the list of users.
pageSize	integer	Number of users returned per page.
hasPreviousPage	boolean	Indicates if previous page is available.
hasNextPage	boolean	Indicates if next page is available.

User Object

Parameter	Type	Description
id	string	Unique identifier for the user.
organisationId	string	Unique identifier of the organisation for the user.
username	string	Username of the user.
firstname	string	First name of the user.
lastname	string	Last name of the user.
mobile	string	Mobile number of the user.
email	string	Email address of the user.

Error Response

If an error occurs, the API will return an appropriate status code along with an error message.

• Sample Error Response (400 Bad Request):

{
  "errors": [
    "Error message 1",
    "Error message 2"
  ],
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "xxxxxxxxxxxxxxxxxxx"
}

Example Usage (JavaScript)

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "BEARER YOUR_ACCESS_TOKEN");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect:'follow'
};

fetch("https://<PA_RM_END_POINT>/retail-media/users/{organisationId}", requestOptions)
  .then(response => response.json())
  .then(result=> { 
    console.log(result);
  })
  .catch(error => console.log('error', error));