Developer resources
Developer tools

Read the tenant's OCPI publishing settings

get/v1/tenants/{tenant_id}/ocpi
Requires an API key

Defaults (publish false, Ivora's shared party) until the tenant writes them. Requires stations:read.

Path parameters

  • tenant_idintegerRequired

Returns · 200

  • tenant_idintegerRequired
  • publishbooleanRequired
    The tenant's choice.
  • privatebooleanRequired
    Ivora keeps this tenant private: never published, whatever publish says.
  • publishedbooleanRequired
    Whether partners receive this tenant's locations and tariffs now: publish, not private, with a display_name. Only where this environment serves OCPI (versions_url not null).
  • display_namestring | nullRequired
  • websitestring | nullRequired
  • time_zonestring | nullRequired
  • connector_defaultsConnectorDefaultsRequired
    Child attributes
    • standardstringRequired
    • formatstringRequired
    • power_typestringRequired
    • max_voltageintegerRequired
      Volts.
    • max_amperageintegerRequired
      Amperes.
  • excluded_location_idsarray of integerRequired
  • own_partyobject | nullRequired
    The party the tenant requested, if any, and whether it is approved.
    Child attributes
    • country_codestringRequired
    • party_idstringRequired
    • statusenumRequired
      approved: Ivora staff approved this pair and locations publish under it. pending_approval: locations publish under USIVR until staff approve it. rejected: staff could not confirm you hold it (rejection_note says why); locations publish under USIVR.
      One of approved, pending_approval, rejected
    • rejection_notestring | nullRequired
      Why Ivora staff rejected the pair, while status is rejected; else null.
  • partyOcpiPartyRequired
    Child attributes
    • country_codestringRequired
    • party_idstringRequired
    • sharedbooleanRequired
      true: Ivora's shared party US*IVR.
  • versions_urlstring | nullRequired
    The OCPI versions endpoint partners call in this environment; null where it serves no OCPI.
  • updated_bystring | nullRequired
    Who last wrote these settings (user:, key: or staff); null for the defaults.
  • updated_atstring | nullRequired
GET /v1/tenants/{tenant_id}/ocpi
curl --fail-with-body "https://api.ivoracharge.com/v1/tenants/1042/ocpi" \
  -H "Authorization: Bearer $IVORA_API_KEY"
Response · 200
{
  "tenant_id": 1042,
  "publish": false,
  "private": false,
  "published": false,
  "display_name": "string",
  "website": "string",
  "time_zone": "America/Los_Angeles",
  "connector_defaults": {
    "standard": "string",
    "format": "string",
    "power_type": "string",
    "max_voltage": 1,
    "max_amperage": 1
  },
  "excluded_location_ids": [
    1
  ],
  "own_party": {
    "country_code": "string",
    "party_id": "party_0123456789abcdef",
    "status": "approved",
    "rejection_note": "string"
  },
  "party": {
    "country_code": "string",
    "party_id": "party_0123456789abcdef",
    "shared": false
  },
  "versions_url": "https://app.example.com/return",
  "updated_by": "string",
  "updated_at": "2026-09-30T17:00:00Z"
}
Try it is not available here yetRequests from this page are off until the production API at https://api.ivoracharge.com is public. Use the code samples from your application server; Ivora grants production access. Keys are created in Developer tools.