Magidoc

Account
Interface

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

Fields

#

id

Non-null

The public id identifying the account (ie: 5v08jk63-w4g9nbpz-j7qmyder-p7ozax5g)

legacyId

Non-null

The internal database identifier of the collective (ie: 580)

slug

Non-null

The slug identifying the account (ie: babel)

type

Non-null

The type of the account (BOT/COLLECTIVE/EVENT/ORGANIZATION/INDIVIDUAL/VENDOR)

name

Public name

legalName

Private, legal name. Used for expense receipts, taxes, etc. Scope: "account".

description

longDescription

tags

website

twitterHandle

githubHandle

repositoryUrl

socialLinks

Non-null

currency

expensePolicy

isIncognito

Non-null

Defines if the contributors wants to be incognito (name not displayed)

imageUrl

hasImage

Non-null

Returns whether this account has a custom image

backgroundImageUrl

createdAt

The time of creation

updatedAt

The time of last update

isArchived

Non-null

Returns whether this account is archived

isFrozen

Non-null

Whether this account is frozen

isActive

Returns whether the account accepts financial contributions.

isHost

Non-null

Returns whether the account is setup to Host collectives.

isAdmin

Non-null

Returns true if the remote user is an admin of this account

parentAccount

members

Non-null

memberInvitations

Get pending member invitations for this account

memberOf

emails

Returns the emails of the account. Individuals only have one, but organizations can have multiple emails.

transactions

Non-null

orders

Non-null

expenses

Non-null

settings

Non-null

conversations

Non-null

conversationsTags

Returns conversation's tags for collective sorted by popularity

expensesTags

Returns expense tags for collective sorted by popularity

supportedExpenseTypes

Non-null

The list of expense types supported by this account

transferwise

payoutMethods

The list of payout methods that this account can use to get paid

paymentMethods

The list of payment methods that this account can use to pay for Orders

paymentMethodsWithPendingConfirmation

The list of payment methods for this account that are pending a client confirmation (3D Secure / SCA)

connectedAccounts

The list of connected accounts (Stripe, Twitter, etc ...)

oAuthApplications

The list of applications created by this account. Admin only. Scope: "applications".

location

The address associated to this account. This field is always public for collectives and events.

categories

[ String ]!
Non-null

Categories set by Open Collective to help moderation.

updates

Non-null

Updates published by the account. To see unpublished updates, you need to be an admin and have the scope "updates".

features

Non-null

Describes the features enabled and available for this account

virtualCards

Virtual Cards attached to the account. Admin only. Scope: "virtualCards".

virtualCardMerchants

Virtual Cards Merchants used by the account. Admin only. Scope: "virtualCards".

childrenAccounts

Non-null

policies

Non-null

Policies for the account. To see non-public policies you need to be admin and have the scope: "account".

activitySubscriptions

List of activities that the logged-in user is subscribed for this collective

permissions

Non-null

Logged-in user permissions on an account

feed

Implementations

#

Implemented by Host , Bot , Collective , Event , Individual , Organization , Vendor , Fund , Project .

Usages

#

References

#