Read what installing an app would grant

Path parameters

• tenant_idintegerRequired
• app_idstringRequired
  Pattern ^app_[0-9a-f]{32}$

Returns · 200

• appAppRecordRequired
  Child attributes

  • idstringRequired
  • team_idstringRequired
  • namestringRequired
  • descriptionstring | nullRequired
  • icon_urlstring | nullRequired
  • ui_originsarray of stringRequired
  • extensionsarray of objectRequired
  • scopesarray of stringRequired
    The scopes the app requests; an install holds the part its installer consented to.
  • webhook_urlstring | nullRequired
    Null for a first_party app read from another team's project.
  • revisionintegerRequired
    Counts the changes to the app's scopes, origins and extensions. A consent is valid only for the revision it was given on.
  • visibilityenumRequired
    private: only the owning team's projects can install it. first_party: Ivora's own app, installable by every project and shown as made by Ivora; only Ivora administrators set it (403 otherwise).
    One of private, first_party
  • publisherstring | null
    Ivora for a first_party app, which the dashboard shows as made by Ivora; null: the team that registered it.
  • statusenumRequired
    One of active, archived
  • checkout_servicebooleanRequired
    Whether Ivora trusts the app's backend to name the driver's IP address (X-Ivora-Driver-Address) on payment creation, so the 30-a-minute per-address limit counts per driver: honoured only on a client_credentials token of an install holding billing:write, never on a session or exchanged token. Only Ivora administrators set it (403 otherwise), on an app that requests billing:write.
  • secret_prefixstring | nullRequired
    The client secret's first characters, to recognise it; the secret is shown only when it is created or rotated. Null for a first_party app read from another team's project.
  • secret_rotated_atstring | nullRequired
  • created_bystring | nullRequired
    Null for a first_party app read from another team's project.
  • created_atstringRequired
  • updated_atstringRequired
  • installsinteger | null
    Active installs, in the team's projects.
• tenant_idintegerRequired
• scopesarray of ScopeInfoRequired
  The scopes the app requests, as the consent screen lists them.
  Child attributes

  • scopestringRequired
  • sensitivebooleanRequired
    True where the app could act on chargers or money: it needs your explicit consent and is rate limited per install.
  • descriptionstringRequired
• rate_limit_per_minuteintegerRequired
• revisionintegerRequired
  Send this as consent_revision when installing.
• installedobject | nullRequired
  The active install, when the app is already installed here.
  Child attributes

  • idstringRequired
  • app_idstringRequired
  • app_namestring | null
  • tenant_idintegerRequired
  • scopesarray of stringRequired
    What the app holds in this project: its consented scopes, never more than the app requests.
  • consent_revisionintegerRequired
  • rate_limit_per_minuteintegerRequired
  • statusenumRequired
    One of active, revoked
  • installed_bystringRequired
  • installed_atstringRequired
  • updated_atstringRequired
  • revoked_atstring | nullRequired
  • revoked_bystring | nullRequired
  • revoked_reasonstring | nullRequired
    uninstalled or app_archived.
  • staff_reasonstring | null
    Set when Ivora staff installed the app on the project's request: why. Null for an install by the project's own team.
• can_installbooleanRequired
  Whether you may install this app in this project: a team owner, admin or developer (only an owner or admin for another team's first_party app), or an Ivora administrator.
• reason_requiredboolean
  True for Ivora administrators outside the project's team: installing needs a reason, which the project's audit trail keeps.
  Default false

Errors