Goldmine
Account Groups

List account groups

POST
/contracts.v1.Contracts/ListAccountGroups

Returns a paged list of account groups. Each page carries hydrated entities, so no follow-up GetAccountGroups is needed.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/contracts.v1.Contracts/ListAccountGroups" \  -H "Content-Type: application/json" \  -d '{    "limit": 100,    "cursor": ""  }'

{
  "accountGroups": [],
  "nextCursor": ""
}

{
  "code": "invalid_argument",
  "message": "The request was malformed, such as a missing required field or an unparseable cursor."
}
{
  "code": "unauthenticated",
  "message": "The request lacks a valid API key in the Authorization header."
}
{
  "code": "permission_denied",
  "message": "The API key is not allowed to perform this action on this workspace."
}
{
  "code": "resource_exhausted",
  "message": "The request was rate limited. Slow down and retry later."
}
{
  "code": "internal",
  "message": "An internal server error occurred."
}

GetAccountGroups

Returns the account groups matching the given IDs within a workspace, alongside the IDs that did not resolve. Soft-deleted account groups are treated as not found.

UpdateAccountGroup

Renames an account group or replaces its full membership. A non-empty members list replaces the group's accounts; an omitted or empty list leaves the membership unchanged.