On This Page

Retrieve a List of the Groups in a Portfolio

You can retrieve a list of organization groups associated to a portfolio or merchant account. The list provides summary information for each group, including metadata and member count.

Endpoints

Production:

GET https://api.cybersource.com/groups

Test:

GET https://apitest.cybersource.com/groups

Required Field for Retrieving a List of Groups

organizationId: The unique identifier of the organization that will own this group.

REST Example: Retrieve a List of Groups

Request

GET /groups/{organizationId}

Response to a Successful Request

{
  "organizationId": "myorg123",
  "count": 2,
  "_embedded": {
    "groups": [
      {
        "id": "grp_1001",
        "name": "Marketing Campaign Merchants",
        "description": "Q2 2024 Marketing Campaign Merchants",
        "members": [
          "merchant002",
          "merchant003",
          "merchant004"
        ],
        "metadata": {
          "createdTime": "2024-01-10T12:00:00Z",
          "lastUpdatedTime": "2024-04-10T18:45:12Z"
        },
        "_links": {
          "self": {
            "href": "/group-management/v1/groups/grp_1001"
          }
        }
      },
      {
        "id": "grp_1002",
        "name": "High Value Merchants",
        "description": "Top revenue merchants",
        "members": [
          "merchant010",
          "merchant011"
        ],
        "metadata": {
          "createdTime": "2024-02-05T09:30:00Z",
          "lastUpdatedTime": "2024-03-20T15:22:40Z"
        },
        "_links": {
          "self": {
            "href": "/group-management/v1/groups/grp_1002"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "/group-management/v1/groups/myorg123"
    }
  }