geo21 Ops

Geo API

Regions, zones, geocoding, and reverse geocoding.

Queries

QUERY

addressSearch

#

Argumente

  • queryString!

    Search query (address, place name, or landmark)

  • countryCodeString

    Optional country code to limit search (ISO 3166-1 alpha-2)

  • limitInt

    Maximum number of results (default: 10)

  • bias

    Coordinates to bias result ranking toward (searcher's position)

  • languageString

    Language tag for localized result labels (e.g., "fa", "en")

Gibt zurück[!]!
QUERY

adminRegion

#

Get a single admin region by ID.

Argumente

  • id!
Gibt zurück
QUERY

adminRegions

#

List administrative regions (states / provinces / admin1) with optional filtering.

Argumente

  • input!

    Standard

    {
      "filter": null,
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      }
    }
Gibt zurück!
QUERY

adminTenantRegions

#

List the operational regions of a specific tenant (PlatformAdmin only). Mirrors tenantRegions but takes the target tenant from the argument instead of the request context, so platform admins can inspect a tenant they're not impersonating. Used by the admin tenant detail page.

Argumente

  • tenantId!
  • input!

    Standard

    {
      "filter": null,
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      }
    }
Gibt zurück!
QUERY

getAddressDetails

#

Get detailed address information for form prefilling Retrieves comprehensive address components including: - Street name and number - Unit/apartment number - Building name - Neighborhood/district - City, region, postal code - Country code - Coordinates and geohash - Address types and verification level Either place_id OR both latitude and longitude must be provided.

Argumente

  • input!
Gibt zurück!
QUERY

getCountry

#

Argumente

  • codeString!

    Country code (ISO 3166-1 alpha-2)

Gibt zurück
QUERY

getCurrency

#

Argumente

  • codeString!

    Currency code (ISO 4217)

Gibt zurück
QUERY

listCountries

#

Argumente

  • searchString

    Optional search term to filter countries

Gibt zurück[!]!
QUERY

listCurrencies

#

Argumente

  • kindString

    Optional filter by kind (FIAT or DIGITAL)

Gibt zurück[!]!
QUERY

reverseGeocode

#

Argumente

  • coordinates!

    Coordinates

Gibt zurück!
QUERY

tenantRegion

#

Get a single tenant region by ID.

Argumente

  • id!
Gibt zurück
QUERY

tenantRegions

#

List tenant regions with filtering and pagination.

Argumente

  • input!

    Standard

    {
      "filter": null,
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      }
    }
Gibt zurück!
QUERY

zone

#

Get a single zone by ID

Argumente

  • id!
Gibt zurück
QUERY

zones

#

List zones with filtering and pagination

Argumente

  • input!

    Standard

    {
      "filter": null,
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      }
    }
Gibt zurück!

Mutations

MUTATION

createTenantRegion

#

Create a new tenant region.

Argumente

  • input!
Gibt zurück!
MUTATION

createZone

#

Create a new zone

Argumente

  • input!
Gibt zurück!
MUTATION

deleteTenantRegion

#

Delete (deactivate) a tenant region.

Argumente

  • id!
Gibt zurückBoolean!
MUTATION

deleteZone

#

Delete (deactivate) a zone

Argumente

  • id!
Gibt zurückBoolean!
MUTATION

updateTenantRegion

#

Update an existing tenant region.

Argumente

  • input!
Gibt zurück!
MUTATION

updateZone

#

Update an existing zone

Argumente

  • input!
Gibt zurück!
MUTATION

updateZoneBoundaries

#

Update zone boundaries (polygon)

Argumente

  • input!
Gibt zurück!