Skip to content

API Reference / Workspaces

List the caller's workspaces

Returns every workspace the caller holds an accepted membership in, regardless of which workspace is currently active. There is no workspace_id or user_id request field. The result always means the caller's own workspaces.

POST/accounts.v1.Accounts/ListWorkspaces

Request body

application/jsonRequired

Request for one page of every workspace the caller has an accepted membership in, whichever workspace is current.

cursor?string

Opaque pagination cursor from a previous ListWorkspacesResponse's next_cursor. The client must not parse or construct one. Empty for the first page. An empty next_cursor on the response signals the last page.

descending?boolean

Order descending instead of ascending.

filter?WorkspaceFilter

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

Show attributes
query?string

Optional case-insensitive literal substring of the workspace name, matched server side. Administrator reads also match the owner's name and email. Absent or empty matches every workspace.

stops?array<string>

Administrator reads only. Matches a workspace in any of the listed stop states, read from the stops contracts records. Empty does not restrict.

Value in"WORKSPACE_STOP_STATE_NONE""WORKSPACE_STOP_STATE_BUYING_STOPPED""WORKSPACE_STOP_STATE_SELLING_STOPPED""WORKSPACE_STOP_STATE_STOPPED_BY_SUPPORT""WORKSPACE_STOP_STATE_STOPPED_BY_WORKSPACE"

limit?integer

Maximum number of workspaces 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"WORKSPACE_SORT_FIELD_CREATED_AT""WORKSPACE_SORT_FIELD_NAME""WORKSPACE_SORT_FIELD_MEMBER_COUNT"

Response body

application/json

Success

memberships?array<Membership>

The caller's own accepted membership in each workspace on the page, one per workspace, matched by workspace_id. Carries the caller's role and policies there.

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.

workspaces?array<Workspace>

The workspaces on this page, in the requested order, each with its member count.

Show attributes
createdAt?string

When the workspace was created.

Format"date-time"

deletedAt?string

When the workspace was soft-deleted. Unset for active workspaces.

Format"date-time"

description?string

Free-form workspace description set by the workspace owner.

getStartedCompletedAt?string

When the workspace completed Get started: the first time it had proxies, accounts, a connected market and a contract all at once. Unset until then. Once set it is never cleared.

Format"date-time"

hardDeleteAt?string

When a soft-deleted workspace and everything in it is removed permanently. Unset for active workspaces.

Format"date-time"

id?string

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

Format"byte" base64

memberCount?integer

Number of accepted memberships in the workspace, computed server-side at read time. Read-only: any value sent by a client is ignored.

Format"int32"

name?string

Human-readable workspace name.

owner?ActorSummary

The workspace owner resolved for display at read time. Set only on administrator reads. Unset when the workspace has no accepted owner.

Show attributes
avatarUrl?string

The user's avatar image URL. Unset for an API key or a user with no avatar.

displayName?string

The user's name or the API key's name at read time. Empty when the actor no longer exists.

id?string

Opaque 16-byte identifier of the user or API key, base64-encoded in JSON.

Format"byte" base64

subjectType?string

How the actor authenticated: a user session or an API key.

Value in"SUBJECT_TYPE_SESSION""SUBJECT_TYPE_API_KEY""SUBJECT_TYPE_SERVICE"

ownerEmail?string

The workspace owner's email. Set only on administrator reads.

updatedAt?string

When the workspace was last modified.

Format"date-time"

curl -X POST "https://api.goldmine.to/accounts.v1.Accounts/ListWorkspaces" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "workspaces": [
    {
      "id": "AAECAwQFBgcICQoLDA0ODw==",
      "name": "Acme Trading",
      "description": "Primary trading workspace.",
      "createdAt": "2026-01-15T10:00:00Z",
      "updatedAt": "2026-03-02T14:22:30Z"
    },
    {
      "id": "9HrBC1jMQ3KlZw4CssPUeQ==",
      "name": "Redline Flips",
      "createdAt": "2026-06-29T12:00:00Z",
      "updatedAt": "2026-06-29T12:00:00Z"
    }
  ]
}