Skip to content

API Reference / Steam account groups

List account groups

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

POST/contracts.v1.Contracts/ListAccountGroups

Request body

application/jsonRequired

Request for one page of the account groups in the caller's workspace, with optional filtering and ordering.

cursor?string

Opaque pagination cursor from a previous ListAccountGroupsResponse. Empty for the first page.

descending?boolean

Order descending instead of ascending.

filter?AccountGroupFilter

Optional filters applied before pagination. Keep unchanged when continuing with a cursor.

Show attributes
accountNames?array<string>

Exact Steam account names, OR within the field: a group matches when at least one of them is a member, so a page of accounts reads every account's groups in one call. At most 100 names. Empty includes every group.

query?string

Literal case-insensitive substring to match against group name or member username. Omitted or empty matches all groups.

limit?integer

Maximum number of account groups to return. Server caps this at a service-defined upper bound.

Format"int32"

sortField?string

Field to order the page by. Unspecified orders by creation time.

Value in"ACCOUNT_GROUP_SORT_FIELD_CREATED_AT""ACCOUNT_GROUP_SORT_FIELD_UPDATED_AT""ACCOUNT_GROUP_SORT_FIELD_NAME"

Response body

application/json

Success

accountGroups?array<AccountGroup>

Full account groups for this page. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetAccountGroups.

Show attributes
createdAt?string

When the account group was created.

Format"date-time"

deletedAt?string

When the account group was soft-deleted, if it has been.

Format"date-time"

id?string

Opaque 16-byte account group identifier, base64-encoded in JSON.

Format"byte" base64

members?array<string>

Steam account names that belong to the group.

name?string

Human-readable account group name.

updatedAt?string

When the account group was last modified.

Format"date-time"

workspaceId?string

Workspace the account group belongs to.

Format"byte" base64

nextCursor?string

Cursor to pass to fetch the next page. Empty when there are no more results.

curl -X POST "https://api.goldmine.to/contracts.v1.Contracts/ListAccountGroups" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 100,
    "cursor": ""
  }'
{
  "accountGroups": [],
  "nextCursor": ""
}