Host

Object

id

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

legacyId

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

slug

The slug identifying the account (ie: babel)

type

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

currency

expensePolicy

isIncognito

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

imageUrl

hasImage

Returns whether this account has a custom image

backgroundImageUrl

createdAt

The time of creation

updatedAt

The time of last update

isArchived

Returns whether this account is archived

isFrozen

Whether this account is frozen

isActive

Returns whether the account accepts financial contributions.

isHost

Returns whether the account is setup to Host collectives.

isAdmin

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

parentAccount

members

Get all members (admins, members, backers, followers)

memberInvitations

[AUTHENTICATED] Returns the pending invitations

memberOf

emails

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

transactions

orders

expenses

settings

conversations

conversationsTags

Returns conversation's tags for collective sorted by popularity

expensesTags

Returns expense tags for collective sorted by popularity

supportedExpenseTypes

The list of expense types supported by this account

transferwise

payoutMethods

The list of payout methods that this collective can use to get paid. In most cases, admin only and scope: "expenses".

paymentMethods

The list of payment methods that this collective can use to pay for Orders. Admin or Host only. Scope: "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 ...). Admin only. Scope: "connectedAccounts".

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

Categories set by Open Collective to help moderation.

stats

updates

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

features

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

policies

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

Logged-in user permissions on an account

feed

webhooks

totalFinancialContributors

Number of unique financial contributors.

tiers

contributors

All the persons and entities that contribute to this account

platformFeePercent

How much platform fees are charged for this account

platformContributionAvailable

Returns true if a custom contribution to Open Collective can be submitted for contributions made to this account

contributionPolicy

accountingCategories

List of accounting categories for this host

hostFeePercent

totalHostedCollectives

totalHostedAccounts

isOpenToApplications

termsUrl

plan

hostMetrics

hostMetricsTimeSeries

supportedPaymentMethods

The list of payment methods (Stripe, Paypal, manual bank transfer, etc ...) the Host can accept for its Collectives

bankAccount

paypalPreApproval

Paypal preapproval info. Returns null if PayPal account is not connected.

paypalClientId

If the host supports PayPal, this will contain the client ID to use in the frontend

supportedPayoutMethods

The list of payout methods this Host accepts for its expenses

stripe

Stripe connected account

hostApplications

Applications for this host

pendingApplications

Pending applications for this host

hostedVirtualCards

hostedVirtualCardMerchants

hostedVirtualCardCollectives

contributionStats

expenseStats

isTrustedHost

Returns whether the host is trusted or not

hasDisputedOrders

Returns whether the host has any Stripe disputed orders

hasInReviewOrders

Returns whether the host has any Stripe in review orders

hostedAccountAgreements

Returns agreements with Hosted Accounts

vendors

Returns a list of vendors that works with this host

potentialVendors

Returns a list of organizations that only transacted with this host and all its admins are also admins of this host.

hostedAccounts

Returns a list of accounts hosted by this host