Skip to content

API Reference / Memberships

List memberships in the caller's own workspace

Lists memberships in the caller's own active workspace, optionally narrowed to a single user. There is no workspace_id request field. The result always means the caller's own workspace. Results are paginated. Pass the returned cursor to fetch the next page.

POST/accounts.v1.Accounts/ListMemberships

Request body

application/jsonRequired

Request for one page of the memberships in the caller's workspace, optionally narrowed by user and status.

cursor?string

Opaque cursor from a previous ListMembershipsResponse.next_cursor. Empty for the first page. Send the same filter with every page.

descending?boolean

True orders the page descending. False orders it ascending.

filter?MembershipFilter

Optional filters applied before pagination.

Show attributes
query?string

Optional case-insensitive literal substring of the member's display name or email, matched server side. Absent or empty matches every membership.

userId?string

Optional filter: only memberships for this user.

Format"byte" base64

limit?integer

Maximum number of memberships to return, up to 100. Zero uses the default of 100. A larger value is rejected with invalid_argument.

Format"int32"

sortField?string

Field to order the page by, creation time or last update time. Unspecified orders by creation time.

Value in"MEMBERSHIP_SORT_FIELD_CREATED_AT""MEMBERSHIP_SORT_FIELD_UPDATED_AT""MEMBERSHIP_SORT_FIELD_LAST_ACTIVE_AT"

statuses?array<string>

Optional status set, the grouping dimension CountMemberships breaks down by. Empty includes every status.

Value in"MEMBERSHIP_STATUS_INVITED""MEMBERSHIP_STATUS_ACCEPTED"

Response body

application/json

Success

memberships?array<Membership>

The memberships on this page, in the requested order.

Show attributes
createdAt?string

When the membership was created, which for a member is when they were invited.

Format"date-time"

expiresAt?string

When a pending invitation stops being acceptable. Unset once accepted and for an owner.

Format"date-time"

id?string

Opaque 16-byte identifier of the membership, assigned when the invitation is created. Base64-encoded in JSON.

Format"byte" base64

invitedBy?string

Opaque 16-byte identifier of the user who sent the invitation. Unset for the workspace owner and for invitations sent before the inviter was recorded.

Format"byte" base64

lastActiveAt?string

When the member last used the workspace while signed in, to the minute. Unset for a member who has not used it since activity was recorded.

Format"date-time"

policies?array<string>

Names of the policies a member holds: any of "trading", "steam", "proxies", "analytics" and "csfloat". Empty means a read-only member. Not used for an owner or an administrator, who hold every operational permission by role.

role?string

Owner for the one person who holds the workspace (its creator until ownership is transferred), administrator for someone who runs it with the owner but cannot delete it, hand it over or change roles, or member for everyone else.

Value in"MEMBERSHIP_ROLE_OWNER""MEMBERSHIP_ROLE_MEMBER""MEMBERSHIP_ROLE_ADMINISTRATOR"

status?string

Invited until the invited user accepts, then accepted.

Value in"MEMBERSHIP_STATUS_INVITED""MEMBERSHIP_STATUS_ACCEPTED"

updatedAt?string

When the membership was last changed, such as accepted or given new policies.

Format"date-time"

userId?string

Opaque 16-byte identifier of the member user, base64-encoded in JSON.

Format"byte" base64

workspaceId?string

Opaque 16-byte identifier of the workspace, base64-encoded in JSON.

Format"byte" base64

nextCursor?string

Cursor to pass as cursor to fetch the next page. Empty when this is the last page.

curl -X POST "https://api.goldmine.to/accounts.v1.Accounts/ListMemberships" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 50
  }'
{
  "membershipIds": [
    "VniQq83vEjRWeBI0VniQqw==",
    "ICEiIyQlJicoKSorLC0uLw=="
  ],
  "nextCursor": "eyJvZmZzZXQiOjUwfQ=="
}