List Registries

GET 
/v1/registries

List Registries

Request

Query Parameters

countryCode stringrequired

3 letter ISO-3166 alpha 3 identifier of the country

Responses

200

Successfully retrieved Registries for a Country

application/json

Schema

Schema

data object[]
Array [
id string
name string
englishName string
code string
]
object string

Example (from schema)

{
  "data": [
    {
      "id": "registry_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "name": "Charity Registry",
      "englishName": "Charity Registry",
      "code": "CR"
    }
  ],
  "object": "Registry"
}

400

Error validating inputs

application/json

Schema

Schema

error object
code string
title string
message string
reasons string[]

Example (from schema)

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "One or more of the inputs were invalid",
    "reasons": [
      "pageSize must be greater than or equal to 0"
    ]
  }
}

401

Unauthorized

403

Forbidden (scope)

application/json

Schema

Schema

error object
code string
title string
message string

Example (from schema)

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

Loading...