GET/v1/me/workspaces

For almost everybody this is one environment: their own. Our own staff can act in every propfirm, so for them it is the platform first and then the firms, by name. Which firms depends on the app the token was issued to: for mail, each firm whose mail is set up to send and to receive, and for admin, every firm, whatever its status and whether it has mail or not.

Which one a request acts in is the Propper-Workspace header, see acting in another environment.

Request

curl https://api.proppertrading.com/v1/me/workspaces \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f"

Response

{
    "data": [
        {
            "object": "workspace",
            "id": "platform",
            "name": "Propper",
            "platform": true,
            "url": "https://proppertrading.com",
            "branding": null,
            "maintenance": false,
            "home": true
        },
        {
            "object": "workspace",
            "id": "acmefunded",
            "name": "Acme Funded",
            "platform": false,
            "url": "https://acmefunded.com",
            "branding": {
                "logo_url": "https://acmefunded.com/storage/logo.webp",
                "logo_dark_url": null,
                "icon_url": null,
                "primary_color": "#3b82f6",
                "primary_color_dark": "#60a5fa",
                "primary_foreground": "#ffffff",
                "primary_foreground_dark": "#0b1530"
            },
            "maintenance": false,
            "home": false
        }
    ],
    "meta": {
        "request_id": "req_01kz4bkr1aj1gv63d8fv3133ey",
        "has_more": false,
        "next_cursor": null
    }
}

Each row has the shape of resolving an environment, plus one field.

Field	Description
`id`	What the `Propper-Workspace` header takes
`home`	The environment the account belongs to, which a request without the header acts in

Not paginated: the list is short, and a switcher wants all of it at once.

List environments

Request

Response