Skip to main content
GET
/
v1
/
workspaces
Get the user's workspaces
curl --request GET \
  --url https://api.snitcher.com/v1/workspaces \
  --header 'Authorization: Bearer <token>'
{
  "current_page": 1,
  "last_page": 10,
  "per_page": 15,
  "total": 150,
  "next_page_url": "https://api.example.com/v1/workspaces?page=2",
  "prev_page_url": null,
  "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": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "ACME Inc.",
      "url": "https://acme.com",
      "tracking_script_id": "s123456789",
      "tracking_script_snippet": "<script>...</script>",
      "available_tags": [
        "marketing",
        "design"
      ],
      "status": "active",
      "usage_limit": "1000"
    }
  ],
  "success": true
}

Authorizations

​
Authorization
string
header
required

Enter your personal access token (PAT) to authenticate

Query Parameters

​
page
integer

The page number for pagination

Example:

1

​
size
integer

The number of organisations per page (1-1000)

Required range: 1 <= x <= 1000
Example:

10

Response

List of workspaces

​
current_page
integer
Example:

1

​
last_page
integer
Example:

10

​
per_page
integer
Example:

15

​
total
integer
Example:

150

​
next_page_url
string | null
Example:

"https://api.example.com/v1/workspaces?page=2"

​
prev_page_url
string | null
Example:

null

​
first_page_url
string | null
Example:

"https://api.example.com/v1/workspaces?page=1"

​
last_page_url
string | null
Example:

"https://api.example.com/v1/workspaces?page=10"

​
path
string | null
Example:

"https://api.example.com/v1/workspaces"

​
from
integer | null
Example:

1

​
to
integer | null
Example:

15

​
data
object[]
​
success
boolean
Example:

true