Skip to main content

Make your first API call

Start after dashboard setup. This request lists the workspaces your developer account can access and verifies your credentials before you create or modify resources.

This is an optional management API test. You can run it without an app. It returns text in your terminal; it does not open a login screen. If you want to try the browser login experience, use Manual test without an application instead.

1. Create a developer access token​

In the dashboard, open Settings → General → Developer Access Tokens (open settings). Create a token named First API call, choose a short expiry, and select Read workspace data (read_workspaces). Copy the token when shown; it is displayed only once.

This token is different from an entry on the workspace API tokens screen. Use it in the X-Developer-Token header.

2. Send the request​

Open Terminal on macOS/Linux or Command Prompt on Windows. Paste curl --version (Windows: curl.exe --version) and press Enter. You should see curl's version information. If the command is not found, use curl's downloads page to find a package for your system, or use a computer where curl is available before continuing.

Replace YOUR_DEVELOPER_TOKEN with the full token you just copied, keeping the surrounding quotes. The placeholder is text to replace, not a shell variable. Run the command in a terminal; no .env file or running application is needed. Windows examples use Command Prompt (CMD), not PowerShell.

Copy the entire command from the tab for your system and press Enter. Paste it into the terminal, not the browser's address bar or developer console. The macOS/Linux command spans several lines; keep the trailing \ characters when copying it.

curl -i "https://api.syauth.com/e/v1/developer/workspaces/" \
  -H "X-Developer-Token: YOUR_DEVELOPER_TOKEN" \
  -H 'Accept: application/json'

No JSON body is required. Expect HTTP 200, with separate arrays for workspaces you own and workspaces you have joined:

{
  "owned_workspaces": [],
  "member_workspaces": []
}

The -i option prints HTTP headers before the JSON body. Look for HTTP 200 and then read the JSON below the headers.

If you created a workspace, its object appears in owned_workspaces with fields including id, name, and owner_id. Find the workspace by its name, then copy that object's id as YOUR_WORKSPACE_ID for later requests. If you joined a workspace, look in member_workspaces. Empty arrays are a successful response from an account with no accessible workspaces; create one in Workspaces or accept an invitation, then repeat this request.

This request checks developer management access. It does not sign in an application user or return an OAuth access token. The read-only token created above is sufficient for this page; the management walkthrough lists the additional scopes needed for creating resources.

You have completed this test when the response shows HTTP 200 and the workspace lists. Save the intended workspace's ID if you will run management requests next. There is no second browser step for this request.

3. If it fails​

ResultWhat to check
401Use a developer access token in X-Developer-Token; check expiry/revocation.
403Read the body. Verify read_workspaces, active plan, and account access.
404Use the API hostname and /e/v1/developer/workspaces/ exactly.
503Service verification is temporarily unavailable; retry later and report persistent failures.
HTML instead of JSONCheck that you called the API URL, not a dashboard page.

Keep the status and sanitized response when requesting support. Never send the token itself. Continue with management automation or hosted sign-in.