Get User List

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

• Method: GET

• URL: https://<PA_RM_END_POINT>/rm/1.0/user/{organisationId}

  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.

• Headers:

  • Content-Type: application/json
  • Authorization: Bearer ACCESS_TOKEN

• Query Parameters:

  • 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.

• Response Codes:

  • 200 OK

    Successful request. The response body will include an array of user profiles, along with pagination information:

    {
        "users": [
            {
                "id": "GUID",
                "username": "email@address.com",
                "firstname": "First",
                "lastname": "Last",
                "mobile": "0123456789",
                "email": "email@address.com"
            },
            {
                // Additional user objects
            }
        ],
        "page": 1,
        "limit": 10,
        "total": 50
    }

  • Non-200 Responses

    If an error occurs (e.g., bad request, unauthorized access), the server will respond with an appropriate non-200 status code and include an error message in the response body:

    {
        "error": "Error message"
    }
    note

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