Skip to content

Getting Started

This guide will walk you through making your first successful API call in under 5 minutes.

Step 1: Get Your API Key

Before you can use the API, you need an API key.

  1. Log in to your People Cloud client account.
  2. Navigate to the Settings > API Keys page in the portal.
  3. Generate a new key and copy it to a secure location. This key must be included in the Authorization header of every request.

Step 2: Make Your First API Call

Use the following curl command in your terminal to confirm your key is working. Replace YOUR_API_KEY_HERE with the key you just generated.

curl -X GET https://api.sbox2.peoplecloudpro.com/api/v1/auth \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Expected success response (example):

{
  "status": "ok",
  "message": "Authenticated, API key valid"
}

If you receive HTTP 200 with the JSON above, authentication succeeded and the API is reachable. If you receive 401, the token is invalid; 403 indicates insufficient permissions.