Cloud API — 5-minute quickstart

1

Create your account

Sign up at probeya.com/register. Your organization gets a unique subdomain: your-org.probeya.com.

2

Generate an API key

Go to Settings > API Keys > Create API Key. Name it (e.g., “dev-testing”) and copy the key immediately — it will not be shown again.

Your key looks like: probeya_sk_live_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6

Store your API key securely. Never commit it to version control. Use environment variables.

3

Make your first request

List all workspaces in your organization:

export PROBEYA_KEY="probeya_sk_live_..."

curl https://acme.probeya.com/api/v1/workspaces \
  -H "Authorization: Bearer $PROBEYA_KEY" \
  -H "Content-Type: application/json"

{
  "workspaces": [
    {
      "id": "clx_ws_hq",
      "name": "HQ Operations",
      "slug": "hq-operations",
      "projectCount": 4
    },
    {
      "id": "clx_ws_site_b",
      "name": "Site Braine-l'Alleud",
      "slug": "site-braine",
      "projectCount": 7
    }
  ]
}
4

Query a board

Get all items on a production board with their KPI data:

curl https://acme.probeya.com/api/v1/boards/clx_board_packaging \
  -H "Authorization: Bearer $PROBEYA_KEY"

{
  "board": {
    "id": "clx_board_packaging",
    "name": "Packaging Line 3 — SQCDP",
    "groups": [
      {
        "name": "Safety",
        "items": [
          { "id": "clx_item_1", "name": "Near-miss report: forklift zone B", "status": "open" }
        ]
      }
    ],
    "columns": [
      { "id": "clx_col_status", "name": "Status", "type": "status" },
      { "id": "clx_col_priority", "name": "Priority", "type": "label" },
      { "id": "clx_col_assignee", "name": "Owner", "type": "person" }
    ]
  }
}
5

Create an action item

curl -X POST https://acme.probeya.com/api/v1/actions \
  -H "Authorization: Bearer $PROBEYA_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "boardId": "clx_board_packaging",
    "title": "Replace worn conveyor belt segment 4B",
    "priority": "high",
    "category": "D",
    "dueDate": "2026-04-20",
    "description": "Visual inspection during gemba walk revealed 3cm tear"
  }'

{
  "id": "clx_act_new",
  "title": "Replace worn conveyor belt segment 4B",
  "status": "open",
  "tierLevel": 1,
  "createdAt": "2026-04-13T10:30:00.000Z"
}

You now have a working integration. Next steps:

Core Concepts

Understand the data model

API Reference

Explore all endpoints

​
What to build next

Webhooks

React to events in real time

MCP Server

Connect AI assistants to your data

Authentication

Understand auth flows and tokens

Was this page helpful?

IntroductionCore Concepts