v1

latestOpenAPI 3.0.02026-07-26392662.9 KB

Workspaces

Get the user's workspaces

get/v1/workspaces

Query parameters

pageinteger

Example:1

The page number for pagination

sizeinteger

Example:10

The number of organisations per page (1-1000)

Response

List of workspaces

current_pageinteger

last_pageinteger

per_pageinteger

totalinteger

next_page_urlstring nullable

prev_page_urlstring nullable

first_page_urlstring nullable

last_page_urlstring nullable

pathstring nullable

frominteger nullable

tointeger nullable

successboolean

Example response

{
  "current_page": 1,
  "last_page": 10,
  "per_page": 15,
  "total": 150,
  "next_page_url": "https://api.example.com/v1/workspaces?page=2",
  "first_page_url": "https://api.example.com/v1/workspaces?page=1",
  "last_page_url": "https://api.example.com/v1/workspaces?page=10",
  "path": "https://api.example.com/v1/workspaces",
  "from": 1,
  "to": 15,
  "data": [
    {
      "name": "ACME Inc.",
      "url": "https://acme.com",
      "tracking_script_id": "s123456789",
      "tracking_script_snippet": "<script>...</script>",
      "available_tags": [
        "marketing",
        "design"
      ]
    }
  ],
  "success": true
}