Workspaces List

API Explorer: /workspaces

To return a list of the workspaces, an accountId is required. The sample code returns a list of workspaces within accountId of 123456. Use the actual ID value for the account to return the list of the workspaces in your account.

If you do not know the accountId of the account, use view the accountId glossary section for the details on where to find this value.

Workspaces List

curl 'https://a.blazemeter.com/api/v4/workspaces?accountId=123456' \
    --user 'api_key_id:api_key_secret'

Workspace List Parameters

Parameters

  • accountId integer

    required

    The accountId you are wanting to get the list of workspaces from

  • enabled boolean

    Denotes whether the response will contain only enabled (if set to true) workspaces or only disabled (if set to false) workspaces

  • textFilter string

    Filters the returned workspace list to any workspace names that match the given string


Also see: Pagination and Sorting

Workspaces List Response Attributes

To see a breakdown of the attributes, please see The Workspace Object section.

Response200 OK 

{
    "limit": 10,
    "skip": 0,
    "total": 2,
    "hidden": 0,
    "api_version": 4,
    "error": null,
    "result": [
        {
            "id": 234567,
            "name": "Another Workspace",
            "userId": 123456,
            "created": 1544563474,
            "updated": 1544563474,
            "enabled": true,
            "dedicatedIpsEnabled": true,
            "privateLocationsEnabled": true,
            "owner": {
                "id": 123456,
                "email": "my.user@myDomain.com",
                "displayName": "My User"
            },
            "membersCount": 1,
            "allowance": {
                "amount": 17568,
                "type": "credits"
            },
            "accountId": 123456
        },
        {
            "id": 123456,
            "name": "Default workspace",
            "userId": 123456,
            "created": 1488987561,
            "updated": 1572904019,
            "enabled": true,
            "dedicatedIpsEnabled": true,
            "privateLocationsEnabled": true,
            "owner": {
                "id": 123456,
                "email": "my.user@myDomain.com",
                "displayName": "My User"
            },
            "membersCount": 6,
            "allowance": {
                "amount": 17568,
                "type": "credits"
            },
            "accountId": 123456
        }
    ],
    "request_id": "5dc5bb21cda8d"
}