Retrieve an Organisation
GET/v1/organisations/:id
Retrieve an Organisation
Request​
Path Parameters
id stringrequired
Id of the organisation
Responses​
- 200
- 401
- 403
- 404
Retrieve a nonprofit Organisation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
data object
id string
name string
displayName stringnullable
description string
countryCode string
milestones object[]
id string
amount integer
reward string
currencyCode string
organisationId string
categories object[]
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
types string[]
Possible values: [nonprofit
, social_impact
, education
]
object string
{
"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.817Z",
"currencyCode": "AUD",
"trustees": "string",
"claimedAt": "2024-03-08T11:45:00.817Z",
"createdAt": "2024-03-08T11:45:00.817Z",
"countrySpecificProperties": {
"usaGroupExempt": true
},
"isBranchParent": false,
"types": [
"nonprofit"
]
},
"object": "Organisation"
}
Unauthorized
Forbidden (scope)
- application/json
- Schema
- Example (from schema)
Schema
error object
code string
title string
message string
{
"error": {
"code": "forbidden",
"title": "Forbidden",
"message": "Access is denied due to missing scope permissions"
}
}
The specified resource was not found
- application/json
- Schema
- Example (from schema)
Schema
error object
code string
title string
message string
{
"error": {
"code": "not_found",
"title": "Resource not found",
"message": "This endpoint is unavailable or can not be found"
}
}
Loading...