Retrieve an Organisation by country code, registry and registryId

GET 
/v1/organisations/:countryCode/:registry/:registryId

Retrieve an Organisation by country code, registry and registryId

Request

Path Parameters

countryCode stringrequired

3 letter ISO-3166 alpha 3 identifier of the country

registry stringrequired

Id of the registry

registryId stringrequired

Id of the Organisation within the registry

Responses

200

Retrieve a Organisation by country code, registry and registryId

application/json

Schema

Schema

data

object

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
object string
Example: Organisation

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-07-29T15:51:28.071Z",
    "currencyCode": "AUD",
    "trustees": "string",
    "claimedAt": "2024-07-29T15:51:28.071Z",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "isBranchParent": false
  },
  "object": "Organisation"
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error

object

code string

Example: forbidden

title string

Example: Forbidden

message string

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

code string

Example: not_found

title string

Example: Resource not found

message string

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

Loading...