List available Countries

GET 
/v1/countries

This endpoint will return all the Countries that Percent currently supports. If hasRegistry is true, it will return the subset of Countries that Percent 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
name string
hasRegistry boolean
]
object string

Example (from schema)

{
  "data": [
    {
      "code": "POL",
      "name": "Poland",
      "hasRegistry": true
    }
  ],
  "object": "Country"
}

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...