List available Countries

GET 
/v1/countries

This endpoint will return all the Countries that Goodstack currently supports. If hasRegistry is true, it will return the subset of Countries that Goodstack currently has nonprofit data for.

Request

Query Parameters

hasRegistry boolean

Only return Countries with Registries

Responses

200

Successfully retrieved Countries

application/json

Schema

Schema

data

object[]

Array [

code string

Example: BEL

name string

Example: Belgium

hasRegistry boolean

Example: true

endonyms object

Example: {"de":"Belgien","fr":"Belgique","nl":"België"}

]

object string
Example: Country

Example (from schema)

{
  "data": [
    {
      "code": "BEL",
      "name": "Belgium",
      "hasRegistry": true,
      "endonyms": {
        "de": "Belgien",
        "fr": "Belgique",
        "nl": "België"
      }
    }
  ],
  "object": "Country"
}

400

Error validating inputs

application/json

Schema

Schema

error

object

code string

Example: bad_request

title string

Example: Bad request

message string

Example: One or more of the inputs were invalid

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

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

Loading...