Skip to main content
GET
/
v2
/
workspaces
List all workspaces
curl --request GET \
  --url https://api.topograph.co/v2/workspaces \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "name": "paris-office",
    "legalName": "Acme Paris SAS",
    "isDefault": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-api-key
string
header
required

Response

200 - application/json

List of workspaces for this account

​
id
string
required

Unique workspace identifier

​
name
string
required

Workspace name (alphanumeric, hyphens, underscores, max 64 chars)

Example:

"paris-office"

​
legalName
string
required

Legal entity name associated with this workspace

Example:

"Acme Paris SAS"

​
isDefault
boolean
required

Whether this is the default workspace for the account

​
createdAt
string<date-time>
​
updatedAt
string<date-time>