1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. OrganizationSummaryWithRole

OrganizationSummaryWithRole

    OrganizationSummary is just the display information for an organization.

    Properties

    • name string required
      The name of the organization.
    • role enum optional
      The role of the user within this organization.
      Values: none, member, admin, potential-member, stack-collaborator, billing-manager
    • githubLogin string required
      The GitHub login associated with the organization.
    • avatarUrl string required
      The URL of the organization’s avatar image.
    • email string optional
      IMPORTANT: The email address of the user is only included on a few admin-only APIs. For nearly all APIs that return a UserInfo object, this will not be provided. considered sensitive information.