Workspaces

List Workspaces

GET
/v2.1/accounts/{accountId}/workspaces

Gets information about the Workspaces that have been created.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/workspaces"
{  "endPosition": "string",  "resultSetSize": "string",  "startPosition": "string",  "totalSetSize": "string",  "workspaces": [    {      "billableAccountId": "string",      "callerInformation": {        "accountId": "string",        "accountName": "string",        "activeSince": "string",        "created": "string",        "createdById": "string",        "email": "string",        "errorDetails": {          "errorCode": "string",          "message": "string"        },        "invitationEmailBlurb": "string",        "invitationEmailSubject": "string",        "lastModified": "string",        "lastModifiedById": "string",        "status": "string",        "type": "string",        "userId": "string",        "userName": "string",        "workspaceId": "string",        "workspaceUserBaseUrl": "string",        "workspaceUserId": "string",        "workspaceUserUri": "string"      },      "created": "string",      "createdByInformation": {        "accountId": "string",        "accountName": "string",        "activeSince": "string",        "created": "string",        "createdById": "string",        "email": "string",        "errorDetails": {          "errorCode": "string",          "message": "string"        },        "invitationEmailBlurb": "string",        "invitationEmailSubject": "string",        "lastModified": "string",        "lastModifiedById": "string",        "status": "string",        "type": "string",        "userId": "string",        "userName": "string",        "workspaceId": "string",        "workspaceUserBaseUrl": "string",        "workspaceUserId": "string",        "workspaceUserUri": "string"      },      "lastModified": "string",      "lastModifiedByInformation": {        "accountId": "string",        "accountName": "string",        "activeSince": "string",        "created": "string",        "createdById": "string",        "email": "string",        "errorDetails": {          "errorCode": "string",          "message": "string"        },        "invitationEmailBlurb": "string",        "invitationEmailSubject": "string",        "lastModified": "string",        "lastModifiedById": "string",        "status": "string",        "type": "string",        "userId": "string",        "userName": "string",        "workspaceId": "string",        "workspaceUserBaseUrl": "string",        "workspaceUserId": "string",        "workspaceUserUri": "string"      },      "settings": {        "commentsAllowed": "string"      },      "status": "string",      "workspaceBaseUrl": "string",      "workspaceDescription": "string",      "workspaceId": "string",      "workspaceName": "string",      "workspaceUri": "string"    }  ]}