Groups

Get group information

Changed on Sep 29, 2026

Retrieves information about the specified group, including its groupId and the list of its child tracked sources.

get/v1/groups/{groupId}

Request

Base URL
/ (relative, and the document was published on a file host, not at the API’s origin)
Auth
HTTP basic
TypeScript
https://skmtc.dev/btcpayserver/apis/nbxplorer-api/docs/v1/groups/:groupId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

groupIdstring required

The unique identifier for the group.

Response

Group information retrieved successfully.

trackedSourcestring required

The tracked source identifier for the group, formatted as 'GROUP:{groupId}'. Used to reference the group within NBXplorer.

groupIdstring required

The unique identifier of the group.

Example response

{
  "trackedSource": "GROUP:6N23bHztah546P6xQT",
  "groupId": "6N23bHztah546P6xQT",
  "children": [
    {
      "trackedSource": "DERIVATIONSCHEME:tpubDC6xFicnheK85vUNGjegu4HuJGg8nPi...",
      "cryptoCode": "BTC"
    }
  ]
}

Changes

Sep 29, 202652231f42c765 Revision changes
- info
  the response property became required for the status
- info
  the response property became required for the status
Nov 25, 2024cfaf4efd4ea8 Revision changes
- breaking
  the response's property type changed from integer to string for status
- breaking
  removed the required property from the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (5 revisions)