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 [

  • id string
    Example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    name string
    Example: Green world
    displayName stringnullable
    Example: Green world
    description string
    Example: Environmental nonprofit supporting various types of wildlife across the northern and southern regions of the eastern southern hemisphere and australasia
    countryCode string
    Example: AUS

    milestones

    object[]

  • Array [

  • id string
    Example: milestone_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    amount integer
    Example: 1000
    reward string
    Example: This is a reward
    currencyCode string
    organisationId string
  • ]

  • categories

    object[]

  • Array [

  • id string
    Example: category_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    name string
    Example: Environmental
    imageUrl stringnullable
    Example: categories/3.png
    createdAt date-time
    Example: 2020-10-13T17:46:54.000Z
  • ]

  • type stringdeprecated

    Possible values: [nonprofit]

    logo urlnullable
    images url[]
    registry string
    Example: registry_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    registryId string
    Example: 12-3456789
    website stringnullable
    Example: https://example.com
    websites string[]
    address stringnullable
    Example: 221b Baker Street, Westminster, London, NW1 6XE
    addressLine1 stringnullable
    Example: 221b Baker Street
    addressLine2 stringnullable
    Example: Westminster
    city stringnullable
    Example: London
    state stringnullable
    postcode stringnullable
    Example: NW1 6XE
    registrationDate date-timenullable
    currencyCode stringnullable
    Example: AUD
    trustees stringnullable
    claimedAt date-timenullable
    createdAt date-time

    countrySpecificProperties

    object

    deprecated

    usaGroupExempt booleannullabledeprecated

    USA-specific group exempt

    isBranchParent boolean

    Whether this organisation is a parent of a branch

    Example: false
  • ]

  • totalResults integer
    Example: 33
    pageNumber integer
    Example: 1
    pageSize integer
    Example: 25

    _links

    object

    current string
    Example: https://.../v1/...?query=climate&page=4
    first string
    Example: https://.../v1/...?query=climate&page=1
    last string
    Example: https://.../v1/...?query=climate&page=9
    prev string
    Example: https://.../v1/...?query=climate&page=3
    next string
    Example: https://.../v1/...?query=climate&page=5
    exhaustiveTotalResults boolean

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

    object string
    Example: organisation
Loading...