INTERFACE

Account

Account interface shared by all kind of accounts (Bot, Collective, Event, User, Organization)

link GraphQL Schema definition

  • interface Account {
  • # The public id identifying the account (ie: 5v08jk63-w4g9nbpz-j7qmyder-p7ozax5g)
  • id: String
  • # The internal database identifier of the collective (ie: 580)
  • legacyId: Int @deprecated( reason: "2020-01-01: should only be used during the transition to GraphQL API v2." )
  • # The slug identifying the account (ie: babel)
  • slug: String
  • # The type of the account (BOT/COLLECTIVE/EVENT/ORGANIZATION/INDIVIDUAL)
  • type: AccountType
  • name: String
  • description: String
  • longDescription: String
  • tags: [String]
  • website: String
  • twitterHandle: String
  • githubHandle: String
  • currency: String
  • expensePolicy: String
  • # Defines if the contributors wants to be incognito (name not displayed)
  • isIncognito: Boolean!
  • # Arguments
  • # height: [Not documented]
  • # format: [Not documented]
  • imageUrl(height: Int, format: ImageFormat): String
  • # Arguments
  • # height: [Not documented]
  • # format: [Not documented]
  • backgroundImageUrl(height: Int, format: ImageFormat): String
  • # The time of creation
  • createdAt: DateTime
  • # The time of last update
  • updatedAt: DateTime
  • # Returns whether this account is archived
  • isArchived: Boolean
  • # Returns whether the account accepts financial contributions.
  • isActive: Boolean
  • # Returns whether the account is setup to Host collectives.
  • isHost: Boolean
  • # Returns true if the remote user is an admin of this account
  • isAdmin: Boolean!
  • # Arguments
  • # limit: [Not documented]
  • # offset: [Not documented]
  • # role: [Not documented]
  • # accountType: Type of accounts
  • # (BOT/COLLECTIVE/EVENT/ORGANIZATION/INDIVIDUAL)
  • members(limit: Int, offset: Int, role: [MemberRole], accountType: [AccountType]): MemberCollection
  • # Arguments
  • # limit: [Not documented]
  • # offset: [Not documented]
  • # role: [Not documented]
  • # isApproved: Filter on (un)approved collectives
  • # isArchived: Filter on archived collectives
  • # accountType: Type of accounts
  • # (BOT/COLLECTIVE/EVENT/ORGANIZATION/INDIVIDUAL)
  • # account: Specific account to query the membership of.
  • # orderBy: [Not documented]
  • memberOf(
  • limit: Int,
  • offset: Int,
  • role: [MemberRole],
  • isApproved: Boolean,
  • isArchived: Boolean,
  • accountType: [AccountType],
  • account: AccountReferenceInput,
  • orderBy: ChronologicalOrderInput!
  • ): MemberOfCollection
  • # Arguments
  • # limit: [Not documented]
  • # offset: [Not documented]
  • # type: Type of transaction (DEBIT/CREDIT)
  • # orderBy: [Not documented]
  • # includeIncognitoTransactions: If the account is a user and this
  • # field is true, contributions from the incognito profile will be included too
  • # (admins only)
  • transactions(
  • limit: Int,
  • offset: Int,
  • type: TransactionType,
  • orderBy: ChronologicalOrderInput,
  • includeIncognitoTransactions: Boolean!
  • ): TransactionCollection
  • # Arguments
  • # limit: [Not documented]
  • # offset: [Not documented]
  • # filter: [Not documented]
  • # status: [Not documented]
  • # tierSlug: [Not documented]
  • # onlySubscriptions: Only returns orders that have an
  • # subscription (monthly/yearly)
  • # orderBy: [Not documented]
  • orders(
  • limit: Int,
  • offset: Int,
  • filter: AccountOrdersFilter,
  • status: [OrderStatus],
  • tierSlug: String,
  • onlySubscriptions: Boolean,
  • orderBy: ChronologicalOrderInput
  • ): OrderCollection!
  • settings: JSON!
  • # Arguments
  • # limit: [Not documented]
  • # offset: [Not documented]
  • # tag: Only return conversations matching this tag
  • conversations(limit: Int, offset: Int, tag: String): ConversationCollection
  • # Returns conversation's tags for collective sorted by popularity
  • #
  • # Arguments
  • # limit: [Not documented]
  • conversationsTags(limit: Int): [TagStat]
  • # Returns expense tags for collective sorted by popularity
  • #
  • # Arguments
  • # limit: [Not documented]
  • expensesTags(limit: Int): [TagStat]
  • transferwise: TransferWise
  • # The list of payout methods that this account can use to get paid
  • payoutMethods: [PayoutMethod]
  • # The list of payment methods that this account can use to pay for Orders
  • #
  • # Arguments
  • # types: Filter on given types (creditcard, virtualcard...)
  • # includeExpired: Wether to include expired payment methods.
  • # Payment methods expired since more than 6 months will never be returned.
  • paymentMethods(types: [String], includeExpired: Boolean): [PaymentMethod]
  • # The list of connected accounts (Stripe, Twitter, etc ...)
  • connectedAccounts: [ConnectedAccount]
  • # The address associated to this account. This field is always public for
  • # collectives and events.
  • location: Location
  • # Categories set by Open Collective to help moderation.
  • categories: [String]!
  • stats: AccountStats
  • # Arguments
  • # limit: The number of results to fetch (default 10, max 1000)
  • # offset: The offset to use to fetch
  • # onlyPublishedUpdates: [Not documented]
  • updates(limit: Int, offset: Int, onlyPublishedUpdates: Boolean): UpdateCollection!
  • # Describes the features enabled and available for this collective
  • features: CollectiveFeatures!
  • }