v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB
team

Retrieve user details

Retrieve user details based on the provided team ID. The endpoint returns information such as user ID, email, first name, and last name for all users in the team. You can also fetch detail of a single user. To fetch details for an individual user, include their user ID to limit the response to that specific user.

get/v2/team/users-details

Query parameters

teamIdstring required

The unique identifier for the team whose user details you want to retrieve.

retailerTeamIdstring

The unique identifier for a retailer-managed team. As a retailer, you can retrieve details about the teams in your namespace by providing the retailerTeamId. When you include this parameter, the API returns user details for the specified team associated with the provided retailerTeamId. Ensure you authenticate the request using the retailer's authentication bearer token.

offsetstring

The number of records to skip before starting to return results. Must be a non-negative integer.

limitstring

The maximum number of records to return in a single response. Must be a positive integer.

userIdstring

The user ID of the user whose details you want to retrieve.

Response

The team object for requested id.

Example response

{
  "users": [
    {
      "id": "user-456",
      "email": "john.doe@example.com",
      "namespace": "marketing",
      "firstName": "John",
      "lastName": "Doe",
      "logoId": "77e7d042-96b1-480a-8c65-d3f94e21244a",
      "roleIds": [
        "ROLE_TYPES_SUPPLIER_FULL",
        "ROLE_TYPES_RETAILER_REPORT_VIEW"
      ]
    }
  ]
}