Docs API Reference Organisation/bff/organisation/detect-country-from-ip

/bff/organisation/detect-country-from-ip

Returns the core__country row that matches the caller's current IP (via GeoIP city lookup). Used to pre-select a sensible default in the org-create form. Returns { country: null } when the IP has no city enrichment yet (freshly-seen private / reserved IP) — the caller should fall back to a manual pick.

OrganisationgetBffOrganisationDetect-country-from-ip

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success

countryobject | nullRequired

One of 2:

Variant 1

idnumberRequired

Internal country ID. Use as countryId in /cms/organisation-create.

codestringRequired

ISO 3166-1 alpha-2 code.

ExampleCZ

namestringRequired

Country display name.

isEubooleanRequired

Whether this country is an EU member state.

Variant 2

null

Response example

application/json

{}

Request example

GET /bff/organisation/detect-country-from-ip

get

curl -X GET "https://api.bizkithub.com/bff/organisation/detect-country-from-ip" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key