Search Organisations
GET/v1/organisations
Search for nonprofits. The Organisations search API provides up to 1,000 results for each search that are accessible by pagination. The boolean field exhaustiveTotalResults
indicates whether the totalResults are exhaustive (true) or approximate (false).
Request​
Query Parameters
Filter search by three-letter ISO country code
Filter search using an organisation’s ID within their registry. Useful with usaGroupExempt param
Only return Organisations in the given Categories
Do not return Organisations in the given Categories
Only return Organisations with the specified tags. To fetch organisations with tag X AND Y use the following ?tags[]=X&tags[]=Y
. To fetch organisations with tag X OR Y use the following ?tags[]=X,Y
.
Do not return Organisations with the specified tags. To fetch organisations with tag X AND NOT with Y use the following ?tags[]=X¬Tags[]=Y
. To fetch organisations with not include tag X OR Y use the following ?notTags[]=X,Y
. To fetch organisations with not include tag X AND Y use the following ?notTags[]=X¬Tags[]=Y
Possible values: [nonprofit
]
Restrict search to a single type of organisation.
Possible values: <= 500 characters
Filter search by USA-specific group exempt. Recommended to use with registryId param
Possible values: >= 1
Default value: 1
Page number, for pagination.
Default value: 25
How many items per page, for pagination.
Responses​
- 200
- 400
- 401
- 403
Successfully retrieved a page of organisations
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- Array [
- ]
- ]
data object[]
milestones object[]
categories object[]
Possible values: [nonprofit
]
countrySpecificProperties object
USA-specific group exempt
Whether this organisation is a parent of a branch
_links object
whether the totalResults are exhaustive (true) or approximate (false)
{
"data": [
{
"id": "organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "Green world",
"displayName": "Green world",
"description": "Environmental nonprofit supporting various types of wildlife across the northern and southern regions of the eastern southern hemisphere and australasia",
"countryCode": "AUS",
"milestones": [
{
"id": "milestone_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"amount": 1000,
"reward": "This is a reward",
"currencyCode": "string",
"organisationId": "string"
}
],
"categories": [
{
"id": "category_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "Environmental",
"imageUrl": "categories/3.png",
"createdAt": "2020-10-13T17:46:54.000Z"
}
],
"logo": "string",
"images": [
"string"
],
"registry": "registry_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"registryId": "12-3456789",
"website": "https://example.com",
"websites": [
"https://example.com"
],
"address": "221b Baker Street, Westminster, London, NW1 6XE",
"addressLine1": "221b Baker Street",
"addressLine2": "Westminster",
"city": "London",
"state": "string",
"postcode": "NW1 6XE",
"registrationDate": "2024-03-08T11:45:00.812Z",
"currencyCode": "AUD",
"trustees": "string",
"claimedAt": "2024-03-08T11:45:00.812Z",
"createdAt": "2024-03-08T11:45:00.812Z",
"countrySpecificProperties": {
"usaGroupExempt": true
},
"isBranchParent": false
}
],
"totalResults": 33,
"pageNumber": 1,
"pageSize": 25,
"_links": {
"current": "https://.../v1/...?query=climate&page=4",
"first": "https://.../v1/...?query=climate&page=1",
"last": "https://.../v1/...?query=climate&page=9",
"prev": "https://.../v1/...?query=climate&page=3",
"next": "https://.../v1/...?query=climate&page=5"
},
"exhaustiveTotalResults": true,
"object": "organisation"
}
Error validating inputs
- application/json
- Schema
- Example (from schema)
Schema
error object
{
"error": {
"code": "bad_request",
"title": "Bad request",
"message": "One or more of the inputs were invalid",
"reasons": [
"pageSize must be greater than or equal to 0"
]
}
}
Unauthorized
Forbidden (scope)
- application/json
- Schema
- Example (from schema)
Schema
error object
{
"error": {
"code": "forbidden",
"title": "Forbidden",
"message": "Access is denied due to missing scope permissions"
}
}