Powered By GitBook
Collectives

Get collective info

Get detailed information about a collective:
/:collectiveSlug.:format(json|csv)
1
{
2
"slug": "webpack",
3
"currency": "USD",
4
"image": "https://cl.ly/221T14472V23/icon-big_x6ot1e.png",
5
"balance": 7614777,
6
"yearlyIncome": 28499262,
7
"backersCount": 556,
8
"contributorsCount": 1098
9
}
Copied!
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

Get members

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.
1
[
2
{
3
"MemberId": 8198,
4
"createdAt": "2017-10-25 09:52",
5
"type": "USER",
6
"role": "BACKER",
7
"tier": "Backer",
8
"isActive": true,
9
"totalAmountDonated": 1000,
10
"currency": "USD",
11
"lastTransactionAt": "2018-02-01 10:53",
12
"lastTransactionAmount": 200,
13
"profile": "https://opencollective.com/ralph03",
14
"name": "Ralph03",
15
"company": null,
16
"description": "",
17
"image": "https://opencollective-production.s3-us-west-1.amazonaws.com/882e5a00-ce64-11e7-ae39-cb1f4eb45be3.jpg",
18
"email": null,
19
"twitter": null,
20
"github": "https://github.com/kazup01",
21
"website": null
22
},
23
...
24
]
Copied!
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, FUNDRAISER
    tier is the name of the tier
    isActive specifies if the backer has an active subscription

Get members per tier

/: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.
1
[
2
{
3
"MemberId": 5485,
4
"createdAt": "2017-07-07 16:44",
5
"type": "ORGANIZATION",
6
"role": "BACKER",
7
"tier": "Gold Sponsors",
8
"isActive": true,
9
"totalAmountDonated": 2600,
10
"currency": "USD",
11
"lastTransactionAt": "2018-02-01 20:23",
12
"lastTransactionAmount": 1000,
13
"profile": "https://opencollective.com/amp",
14
"name": "AMP Project",
15
"company": "",
16
"description": null,
17
"image": "https://opencollective-production.s3-us-west-1.amazonaws.com/68ed8b70-ebf2-11e6-9958-cb7e79408c56.png",
18
"email": null,
19
"twitter": "https://twitter.com/amphtml",
20
"github": null,
21
"website": "https://www.ampproject.org/"
22
},
23
{
24
"MemberId": 8263,
25
"createdAt": "2017-10-26 23:08",
26
"type": "ORGANIZATION",
27
"role": "BACKER",
28
"tier": "Gold Sponsors",
29
"isActive": true,
30
"totalAmountDonated": 5000,
31
"currency": "USD",
32
"lastTransactionAt": "2018-02-02 00:08",
33
"lastTransactionAmount": 1000,
34
"profile": "https://opencollective.com/fbopensource",
35
"name": "Facebook Open Source",
36
"company": null,
37
"description": "Facebook Open Source Team",
38
"image": "http://res.cloudinary.com/opencollective/image/upload/v1508519428/S9gk78AS_400x400_fulq2l.jpg",
39
"email": null,
40
"twitter": "https://twitter.com/fbOpenSource",
41
"github": null,
42
"website": "https://code.facebook.com/projects/"
43
}
44
]
Copied!

Get transactions from collective

/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.

Parameters

    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

Curl command

1
curl "https://api.opencollective.com/v1/collectives/opencollective-company/transactions" \
2
-H "Content-Type: application/json"\
3
-H "Client-Id: ${ClientId}"
Copied!
PS: For more details on how to have a Client ID/API Key, get in touch.
E.g.

Output

The output will be a json with a result property that will contain an array. here is an example:
1
{
2
"result": [
3
{
4
"id": 9047,
5
"uuid": null,
6
"type": "CREDIT",
7
"amount": 500,
8
"currency": "USD",
9
"hostCurrency": "USD",
10
"hostCurrencyFxRate": 1,
11
"hostFeeInHostCurrency": -25,
12
"platformFeeInHostCurrency": -25,
13
"paymentProcessorFeeInHostCurrency": -45,
14
"netAmountInCollectiveCurrency": 405,
15
"createdAt": "Sun Apr 30 2017 22:33:49 GMT-0400 (Eastern Daylight Time)",
16
"updatedAt": "Thu Mar 08 2018 15:24:33 GMT-0500 (Eastern Standard Time)",
17
"host": {
18
"id": 8686,
19
"slug": "opencollectiveinc"
20
},
21
"createdByUser": {
22
"id": 3605,
23
"email": null
24
},
25
"fromCollective": {
26
"id": 4505,
27
"slug": "christinabowen"
28
},
29
"collective": {
30
"id": 1,
31
"slug": "opencollective-company"
32
},
33
"paymentMethod": {
34
"id": 2198
35
}
36
},
37
{
38
"id": 7698,
39
"uuid": null,
40
"type": "CREDIT",
41
"amount": 500,
42
"currency": "USD",
43
"hostCurrency": "USD",
44
"hostCurrencyFxRate": 1,
45
"hostFeeInHostCurrency": -25,
46
"platformFeeInHostCurrency": -25,
47
"paymentProcessorFeeInHostCurrency": -45,
48
"netAmountInCollectiveCurrency": 405,
49
"createdAt": "Fri Mar 31 2017 22:25:57 GMT-0400 (Eastern Daylight Time)",
50
"updatedAt": "Thu Mar 08 2018 15:23:18 GMT-0500 (Eastern Standard Time)",
51
"host": {
52
"id": 8686,
53
"slug": "opencollectiveinc"
54
},
55
"createdByUser": {
56
"id": 3605,
57
"email": null
58
},
59
"fromCollective": {
60
"id": 4505,
61
"slug": "christinabowen"
62
},
63
"collective": {
64
"id": 1,
65
"slug": "opencollective-company"
66
},
67
"paymentMethod": {
68
"id": 2198
69
}
70
}
71
]
72
}
Copied!
Last modified 1yr ago