Skip to main content
GET
/
v1
/
end-users
/
{endUserId}
/
credentials
Get credentials status
curl --request GET \
  --url https://api.example.com/v1/end-users/{endUserId}/credentials
{
  "endUserId": "<string>",
  "platforms": {}
}

Path parameters

endUserId
string
required
The end-user identifier.

Response — 200 OK

endUserId
string
Echoed identifier.
platforms
object
Per-platform boolean flags indicating whether credentials are configured. Platforms not returned default to false.
{
  "twitter": true,
  "reddit": false,
  "tiktok": true,
  "youtube": false,
  "instagram": false
}
The actual secret values are never returned. If you need to verify the specific tokens in use, rotate them by uploading fresh ones via PUT .../credentials.

Example

curl "$API_BASE/end-users/alice/credentials" \
  -H "Authorization: Bearer $API_KEY"

Common use case

Before running a task that needs a specific platform, check if the end-user has credentials configured — bail with a friendly message to your own user if not:
Python
status = client.end_users(eu).credentials.get()
if not status.platforms.get("twitter"):
    raise YourAppError("Twitter login required. Ask the user to connect.")
result = client.tasks.run(end_user_id=eu, task="...")

Errors

CodeMeaning
400endUserId > 256 chars
401Missing Authorization header
403Revoked API key