Skip to main content

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

    Search for organisations by name. Must not exceed 500 characters or 512 bytes.

    usaGroupExempt boolean

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

    page integer

    Possible values: >= 1

    Page number, for pagination.

    Default value: 1
    pageSize integer

    How many items per page, for pagination.

    Default value: 25

Responses​

Successfully retrieved a page of organisations

Schema

    data

    object[]

  • Array [

  • idstring
    Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    namestring
    Example: Green world
    displayNamestringnullable
    Example: Green world
    descriptionstring
    Example: Environmental nonprofit supporting various types of wildlife across the northern and southern regions of the eastern southern hemisphere and australasia
    countryCodestring
    Example: AUS

    milestones

    object[]

  • Array [

  • idstring
    Example: milestone_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    amountinteger
    Example: 1000
    rewardstring
    Example: This is a reward
    currencyCodestring
    organisationIdstring
  • ]

  • categories

    object[]

  • Array [

  • idstring
    Example: category_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    namestring
    Example: Environmental
    imageUrlstringnullable
    Example: categories/3.png
    createdAtdate-time
    Example: 2020-10-13T17:46:54.000Z
  • ]

  • typestringdeprecated

    Possible values: [nonprofit]

    logourlnullable
    imagesurl[]
    registrystring
    Example: registry_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    registryIdstring
    Example: 12-3456789
    websitestringnullable
    Example: https://example.com
    websitesstring[]
    addressstringnullable
    Example: 221b Baker Street, Westminster, London, NW1 6XE
    addressLine1stringnullable
    Example: 221b Baker Street
    addressLine2stringnullable
    Example: Westminster
    citystringnullable
    Example: London
    statestringnullable
    postcodestringnullable
    Example: NW1 6XE
    registrationDatedate-timenullable
    currencyCodestringnullable
    Example: AUD
    trusteesstringnullable
    claimedAtdate-timenullable
    createdAtdate-time

    countrySpecificProperties

    object

    deprecated

    usaGroupExemptbooleannullabledeprecated

    USA-specific group exempt

    isBranchParentboolean

    Whether this organisation is a parent of a branch

    Example: false
  • ]

  • totalResultsinteger
    Example: 33
    pageNumberinteger
    Example: 1
    pageSizeinteger
    Example: 25

    _links

    object

    currentstring
    Example: https://.../v1/...?query=climate&page=4
    firststring
    Example: https://.../v1/...?query=climate&page=1
    laststring
    Example: https://.../v1/...?query=climate&page=9
    prevstring
    Example: https://.../v1/...?query=climate&page=3
    nextstring
    Example: https://.../v1/...?query=climate&page=5
    exhaustiveTotalResultsboolean

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

    objectstring
    Example: organisation