Retrieve an Organisation

GET 
/v1/organisations/:id

Retrieve an Organisation

Request

Path Parameters

id stringrequired

Id of the organisation

Responses

200

Retrieve a nonprofit Organisation

application/json

Schema

Schema

data

object

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

typesstring[]

Possible values: [nonprofit, social_impact, education]

objectstring
Example: Organisation

Example (from schema)

{
  "data": {},
  "object": "Organisation"
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

codestring

Example: forbidden

titlestring

Example: Forbidden

messagestring

Example: Access is denied due to missing scope permissions

Example (from schema)

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

404

The specified resource was not found

application/json

Schema

Schema

error

object

codestring

Example: not_found

titlestring

Example: Resource not found

messagestring

Example: This endpoint is unavailable or can not be found

Example (from schema)

{
  "error": {
    "code": "not_found",
    "title": "Resource not found",
    "message": "This endpoint is unavailable or can not be found"
  }
}