Pearsana Docs

Appearance

Ping (Auth Check) ​

Test authentication and connectivity with the Pearsana Partner API.

Endpoint ​

http
GET /ping

Authentication ​

Required Scope: pearsana-partner/ping

Headers ​

http
Authorization: Bearer YOUR_ACCESS_TOKEN

Request ​

No parameters required.

Response ​

Status Code: 200 OK

json
{
	"status": "ok",
	"message": "Authorized",
	"clientId": "3ieqbnqrjeocomi19jsb6cccf2",
	"scopes": ["pearsana-partner/ping"]
}

Response Fields ​

FieldTypeDescription
statusstringAlways "ok" for successful requests
messagestringHuman-readable status message
clientIdstringOAuth client ID from your JWT token
scopesarrayList of scopes granted to your access token

Error Responses ​

401 Unauthorized ​

Missing or invalid authentication token.

json
{
	"error": {
		"code": "UNAUTHORIZED",
		"message": "Authentication required.",
		"requestId": "abc-123-def"
	}
}

403 Insufficient Scope ​

Valid token but missing the pearsana-partner/ping scope.

json
{
	"error": {
		"code": "INSUFFICIENT_SCOPE",
		"message": "Insufficient OAuth scopes for this operation.",
		"details": {
			"requiredScopes": ["pearsana-partner/ping"],
			"providedScopes": []
		},
		"requestId": "abc-123-def"
	}
}

Example Request ​

bash
curl https://sandbox.api.pearsana.com/ping \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Use Cases ​

  • Test authentication — verify your OAuth credentials are working
  • Scope verification — check which scopes your token has
  • Client ID confirmation — verify which client your token belongs to
  • Integration testing — validate authentication setup before making production calls