Get detailed information about a collective:
/:collectiveSlug.:format(json|csv)
E.g.: https://opencollective.com/webpack.json
Notes:
image
is the logo of the collective
all amounts are in the smaller unit of the currency (cents)
backersCount
includes both individual backers and organizations (sponsors)
yearlyIncome
is the projection of the annual budget based on previous donations and monthly pledges
Returns all members of the collectives (core contributors, contributors, backers, sponsors)
/:collectiveSlug/members.:format(json|csv)
You can also filter by member type (USER
or ORGANIZATION
):
/:collectiveSlug/members/:memberType(all|users|organizations).:format(json|csv)
E.g.
Parameters:
limit: number of members to return per call
offset: number of members to skip (for pagination)
Notes:
github
is verified via oauth but twitter
is not
email
returns null unless you make an authenticated call using the accessToken
of one of the admins of the collective
all amounts are in the smaller unit of the currency (cents)
type
can be USER
, ORGANIZATION
or COLLECTIVE
role
can be ADMIN
, MEMBER
, BACKER
, ATTENDEE
, FOLLOWER
tier
is the name of the tier
isActive
specifies if the backer has an active subscription
/:collectiveSlug/[all|users|organizations].:format(json|csv)?TierId=:TierId
You can find the TierId
by looking at the URL after clicking on a Tier Card on the collective page (e.g. TierId
for https://opencollective.com/webpack/order/266 is 266
).
Alternatively, you can also use the slug of a tier:
/:collectiveSlug/tiers/:tierSlug/[all|users|organizations].format(json|csv)
E.g.
/v1/collectives/:collectiveSlug/transactions?type=:type&limit=:limit&offset=:offset&dateFrom=:dateFrom&dateTo=:dateTo&type=:includeVirtualCards
Return All Transactions of a collective given its slug.
limit: number of members to return per call
offset: number of members to skip (for pagination)
type: filter transactions of type DEBIT
or CREDIT
dateFrom: the start date (format YYYY-MM-DD
) to be considered when returning the data
dateTo: the end date (format YYYY-MM-DD
) to be considered when returning the data
includeVirtualCards: a boolean that, if true, will include the transactions generated by all virtual cards issued by the specified collective
PS: For more details on how to have a Client ID/API Key, get in touch.
E.g.
Including Virtual Card transactions (transactions that used a virtual card that was issued by the collective): https://api.opencollective.com/v1/collectives/opencollectiveinc/transactions?api_key=YOUR_API_KEY&includeVirtualCards=true
NOT Including Virtual Cards: https://api.opencollective.com/v1/collectives/opencollectiveinc/transactions?api_key=YOUR_API_KEY
Using limit=20
, type=DEBIT
and offset=5
: https://api.opencollective.com/v1/collectives/opencollectiveinc/transactions?api_key=YOUR_API_KEY&includeVirtualCards=true&limit=20&type=DEBIT&offset=5
The output will be a json with a result property that will contain an array. here is an example: