List users

Call GET /v1/users first. It returns the list of users in your organisation that are visible to your API key.

Request

curl --request GET \
  --url "$REPORTING_API_BASE_URL/v1/users" \
  --header "Authorization: Bearer $SKYLAR_REPORTING_API_KEY"

Success response

{
  "data": [
    {
      "user_id": "user-123",
      "email": "[email protected]",
      "display_name": "Alex Active",
      "org_role": "member",
      "org_status": "active",
      "team_ids": ["team-alpha"]
    }
  ]
}

What to do with the response

  • Pick the user_id values you need to report on.
  • Use those IDs in the per-user sessions and assessments routes.
  • Treat nullable fields such as email or display_name as optional in your client.