Make your first API request in about five minutes.

Before you begin

• You can sign in to ConnectUs SSP.
• You have generated a Sandbox Token under Account Settings → API Integrations.
• You have a tool that can send HTTPS requests.

Your first request

We will ask ConnectUs for the projects available to your account. This is a safe read-only request and a good authentication test.

curl --request GET \
  --url "https://workspace-stage.connectuscorp.com/api/v2/client/projects" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_SANDBOX_TOKEN"

A successful response is JSON and contains a data array plus pagination metadata:

{
  "data": [
    {
      "id": 101,
      "name": "Project Alpha",
      "description": "Example project",
      "status": "active",
      "default_kit_id": 42
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1
  }
}

Understanding the URL

https://workspace-stage.connectuscorp.com/api/v2 + /client/projects
└──────────── API base URL ────────────┘   └── endpoint ──┘

All endpoints documented on this portal are client endpoints. They begin with /client after the /api/v2 base URL.

Use the same request in JavaScript

const response = await fetch(
  "https://workspace-stage.connectuscorp.com/api/v2/client/projects",
  {
    headers: {
      "Accept": "application/json",
      "Authorization": "Bearer YOUR_SANDBOX_TOKEN"
    }
  }
);

const data = await response.json();
console.log(data);

Or in PHP

$response = Http::withToken($token)
    ->acceptJson()
    ->get('https://workspace-stage.connectuscorp.com/api/v2/client/projects');

$data = $response->json();

What should I do next?