List Registries
GET/v1/registries
List Registries
Request​
Query Parameters
countryCode stringrequired
3 letter ISO-3166 alpha 3 identifier of the country
Responses​
- 200
- 400
- 401
- 403
Successfully retrieved Registries for a Country
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
data object[]
id string
name string
englishName string
code string
object string
{
"data": [
{
"id": "registry_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"name": "Charity Registry",
"englishName": "Charity Registry",
"code": "CR"
}
],
"object": "Registry"
}
Error validating inputs
- application/json
- Schema
- Example (from schema)
Schema
error object
code string
title string
message string
reasons string[]
{
"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"
]
}
}
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"
}
}
Loading...