Retrieve a Registry

GET 
/v1/registries/:id

Retrieve a Registry

Request

Path Parameters

id stringrequired

Id of the registry

Responses

200

Successfully retrieved a Registry

application/json

Schema

Schema

data

object

idstring

Example: registry_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

namestring

Example: Charity Registry

englishNamestring

Example: Charity Registry

codestring

Example: CR
objectstring
Example: Registry

Example (from schema)

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

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