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

countryCode string

Filter search by three-letter ISO country code

registryId string

Filter search using an organisation’s ID within their registry. Useful with usaGroupExempt param

category[] string[]

Only return Organisations in the given Categories

notCategory[] string[]

Do not return Organisations in the given Categories

tags[] string[]

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.

notTags[] string[]

Do not return Organisations with the specified tags. To fetch organisations with tag X AND NOT with Y use the following ?tags[]=X&notTags[]=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&notTags[]=Y

type[] string[]

Possible values: [nonprofit]

Restrict search to a single type of organisation.

query string

Possible values: <= 500 characters

usaGroupExempt boolean

Filter search by USA-specific group exempt. Recommended to use with registryId param

page integer

Possible values: >= 1

Default value: 1

Page number, for pagination.

pageSize integer

Default value: 25

How many items per page, for pagination.

Responses

200

Successfully retrieved a page of organisations

application/json

Schema

Schema

data object[]
Array [
id string
name string
displayName stringnullable
description string
countryCode string
milestones object[]
Array [
id string
amount integer
reward string
currencyCode string
organisationId string
]
categories object[]
Array [
id string
name string
imageUrl stringnullable
createdAt date-time
]
type stringdeprecated
Possible values: [nonprofit]
logo urlnullable
images url[]
registry string
registryId string
website stringnullable
websites string[]
address stringnullable
addressLine1 stringnullable
addressLine2 stringnullable
city stringnullable
state stringnullable
postcode stringnullable
registrationDate date-timenullable
currencyCode stringnullable
trustees stringnullable
claimedAt date-timenullable
createdAt date-time
countrySpecificProperties object
usaGroupExempt booleannullable
USA-specific group exempt
isBranchParent boolean
Whether this organisation is a parent of a branch
]
totalResults integer
pageNumber integer
pageSize integer
_links object
current string
first string
last string
prev string
next string
exhaustiveTotalResults boolean

whether the totalResults are exhaustive (true) or approximate (false)

object string

Example (from schema)

{
  "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"
}

400

Error validating inputs

application/json

Schema

Schema

error object
code string
title string
message string
reasons string[]

Example (from schema)

{
  "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"
    ]
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

{
  "error": {
    "code": "forbidden",
    "title": "Forbidden",
    "message": "Access is denied due to missing scope permissions"
  }
}

Loading...