workspaces

Lists all User's Workspaces

User has to be a member of the Workspaces

get/workspaces

Request

  • Base URL: https://api.elastic.io/v2
  • URL: https://api.elastic.io/v2/workspaces
  • Auth: HTTP basic

Query parameters

contract_idstring required

Contract identifier

page[size]integer

Amount of items per page

page[number]integer

Number of page you want to display

Response

OK

Example response

{
  "data": [
    {
      "id": "5b4f337bff4304610483ba67",
      "links": {
        "self": "/v2/workspaces/5b4f337bff4304610483ba67"
      },
      "attributes": {
        "name": "Workspace Name",
        "flow_stats_enabled_default": true
      },
      "relationships": {
        "contract": {
          "data": {
            "id": "5b4f337bff4304610483ba67"
          },
          "links": {
            "self": "/v2/contracts/5b4f337bff4304610483ba67"
          }
        },
        "members": {
          "data": [
            {
              "id": "5b4f337bff4304610483ba67"
            }
          ],
          "links": {
            "self": "/v2/workspaces/5b4f337bff4304610483ba67/members"
          }
        }
      }
    }
  ],
  "meta": {
    "total": 6,
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  },
  "links": {
    "self": "/v2/workspaces"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.