Get the signed-in user

get/v1/me

This endpoint is in the contract, but the API doesn't serve it during early access. It returns 404 for now.

Returns the signed-in user, their capabilities and — when Vojo-Organisation is sent — their effective permissions in that org. OAuth only (secret keys have no user).

curl "https://api.vojo-media.com/v1/me" \
  -H "Authorization: Bearer $VOJO_ACCESS_TOKEN" \
  -H "Vojo-Organisation: $VOJO_ORG"

const { data, error } = await api.GET("/v1/me");
if (error) throw new VojoApiError(error);

Response 200

{
  "data": {
    "id": "cm1usr3h7t0001k2m8q4w6z9ab",
    "email": "[email protected]",
    "type": "organisation_owner",
    "two_factor_enabled": true,
    "home_organisation_id": "cm1org8k2q0001x7v3n9p4d2fa",
    "active_organisation_id": "cm1org8k2q0001x7v3n9p4d2fa",
    "capabilities": {
      "network_access": true,
      "view_org_issues": true
    },
    "permissions": {
      "manage_organisation": true,
      "advertisement_access_page": true,
      "advertisement_add_new": true,
      "advertisement_assign_clients": true,
      "advertisement_assign_tags": true,
      "advertisement_delete": true,
      "advertisement_download_source": true,
      "advertisement_edit": true,
      "advertisement_export_stats": true,
      "advertisement_fingerprinting": true,
      "advertisement_view_source": true,
      "advertisement_view_stats": true,
      "billing_access_orders": true,
      "billing_access_page": true,
      "billing_access_store": true,
      "billing_manage_subscriptions": true,
      "campaign_access_page": true,
      "campaign_add_new": true,
      "client_access_page": true,
      "client_add_new": true,
      "client_delete": true,
      "client_edit": true,
      "client_export_stats": true,
      "client_view_stats": true,
      "harvester_access_page": true,
      "harvester_assign_screen": true,
      "harvester_calibration": true,
      "harvester_install": true,
      "network_access_page": true,
      "network_add_new": true,
      "network_delete": true,
      "network_edit": true,
      "network_export_quality": true,
      "network_export_stats": true,
      "network_view_quality": true,
      "network_view_stats": true,
      "organisation_customer_portal": true,
      "organisation_edit": true,
      "sites_access_page": true,
      "sites_add_new": true,
      "sites_assign_screen": true,
      "sites_assign_user": true,
      "sites_delete": true,
      "sites_edit": true,
      "tags_add_new": true,
      "tags_delete": true,
      "user_access_page": true,
      "user_assign_sites": true,
      "user_invite": true,
      "user_set_permissions": true,
      "user_view_details": true,
      "network_update_harvester": true,
      "alerting_access_page": true,
      "alerting_manage_brightness_thresholds": true,
      "campaign_delete": true,
      "developer_access": true
    }
  },
  "meta": {}
}

Access

Authentication: OAuth access token only. Secret keys are rejected.
Scope: account:read
User permission: Membership of the organisation is enough.

Headers

Vojo-Organisationstring
The organisation this request acts on (org id). Required for oauth2 callers — a missing header returns 400 organisation_header_required; an org the user cannot access (a membership or an access grant, and granted to this OAuth client) returns 403 organisation_access_denied. Secret keys are bound to one org: the header may be omitted, and if sent it must match the key's org (else 403). Every query is scoped by the resolved org, never by an id in the body.
Vojo-Versionstring
Optional API version pin (a date). Overrides the version pinned on the secret key / organisation for this request. Echoed in the Vojo-Version response header. Within /v1 only additive changes ship, so most callers can omit it.
date

Response 200

dataobjectRequired
The signed-in user.
Show 8 fields
- idstringRequired
  User id. Opaque string — treat as an identifier, never parse it.
- emailstringRequired
  email
- typestringRequired
  Global user type.
  One of invited, user, admin, organisation_owner, client, client_invited, installer, installer_invited
- two_factor_enabledbooleanRequired
  Whether the user has enrolled a second factor (enforced at sign-in).
- home_organisation_idstring or nullRequired
  The user's default organisation.
- active_organisation_idstring or nullRequired
  The org resolved from Vojo-Organisation, or null when the header was not sent.
- capabilitiesobjectRequired
  Pure functions of the user type.
  Show 2 fields
  - network_accessbooleanRequired
    False for client and installer roles.
  - view_org_issuesbooleanRequired
    Whether the user can view organisation issues.
- permissionsobject or nullRequired
  Effective flags in active_organisation_id; null when no Vojo-Organisation was sent.
  Show 56 fields
  - manage_organisationbooleanRequired
    Permissions.manageOrganisation.
  - advertisement_access_pagebooleanRequired
    Permissions.advertisementAccessPage.
  - advertisement_add_newbooleanRequired
    Permissions.advertisementAddNew.
  - advertisement_assign_clientsbooleanRequired
    Permissions.advertisementAssignClients.
  - advertisement_assign_tagsbooleanRequired
    Permissions.advertisementAssignTags.
  - advertisement_deletebooleanRequired
    Permissions.advertisementDelete.
  - advertisement_download_sourcebooleanRequired
    Permissions.advertisementDownloadSource.
  - advertisement_editbooleanRequired
    Permissions.advertisementEdit.
  - advertisement_export_statsbooleanRequired
    Permissions.advertisementExportStats.
  - advertisement_fingerprintingbooleanRequired
    Permissions.advertisementFingerprinting.
  - advertisement_view_sourcebooleanRequired
    Permissions.advertisementViewSource.
  - advertisement_view_statsbooleanRequired
    Permissions.advertisementViewStats.
  - billing_access_ordersbooleanRequired
    Permissions.billingAccessOrders.
  - billing_access_pagebooleanRequired
    Permissions.billingAccessPage.
  - billing_access_storebooleanRequired
    Permissions.billingAccessStore.
  - billing_manage_subscriptionsbooleanRequired
    Permissions.billingManageSubscriptions.
  - campaign_access_pagebooleanRequired
    Permissions.campaignAccessPage.
  - campaign_add_newbooleanRequired
    Permissions.campaignAddNew.
  - client_access_pagebooleanRequired
    Permissions.clientAccessPage.
  - client_add_newbooleanRequired
    Permissions.clientAddNew.
  - client_deletebooleanRequired
    Permissions.clientDelete.
  - client_editbooleanRequired
    Permissions.clientEdit.
  - client_export_statsbooleanRequired
    Permissions.clientExportStats.
  - client_view_statsbooleanRequired
    Permissions.clientViewStats.
  - harvester_access_pagebooleanRequired
    Permissions.harvesterAccessPage.
  - harvester_assign_screenbooleanRequired
    Permissions.harvesterAssignScreen.
  - harvester_calibrationbooleanRequired
    Permissions.harvesterCalibration.
  - harvester_installbooleanRequired
    Permissions.harvesterInstall.
  - network_access_pagebooleanRequired
    Permissions.networkAccessPage.
  - network_add_newbooleanRequired
    Permissions.networkAddNew.
  - network_deletebooleanRequired
    Permissions.networkDelete.
  - network_editbooleanRequired
    Permissions.networkEdit.
  - network_export_qualitybooleanRequired
    Permissions.networkExportQuality.
  - network_export_statsbooleanRequired
    Permissions.networkExportStats.
  - network_view_qualitybooleanRequired
    Permissions.networkViewQuality.
  - network_view_statsbooleanRequired
    Permissions.networkViewStats.
  - organisation_customer_portalbooleanRequired
    Permissions.organisationCustomerPortal.
  - organisation_editbooleanRequired
    Permissions.organisationEdit.
  - sites_access_pagebooleanRequired
    Permissions.sitesAccessPage.
  - sites_add_newbooleanRequired
    Permissions.sitesAddNew.
  - sites_assign_screenbooleanRequired
    Permissions.sitesAssignScreen.
  - sites_assign_userbooleanRequired
    Permissions.sitesAssignUser.
  - sites_deletebooleanRequired
    Permissions.sitesDelete.
  - sites_editbooleanRequired
    Permissions.sitesEdit.
  - tags_add_newbooleanRequired
    Permissions.tagsAddNew.
  - tags_deletebooleanRequired
    Permissions.tagsDelete.
  - user_access_pagebooleanRequired
    Permissions.userAccessPage.
  - user_assign_sitesbooleanRequired
    Permissions.userAssignSites.
  - user_invitebooleanRequired
    Permissions.userInvite.
  - user_set_permissionsbooleanRequired
    Permissions.userSetPermissions.
  - user_view_detailsbooleanRequired
    Permissions.userViewDetails.
  - network_update_harvesterbooleanRequired
    Permissions.networkUpdateHarvester.
  - alerting_access_pagebooleanRequired
    Permissions.alertingAccessPage.
  - alerting_manage_brightness_thresholdsbooleanRequired
    Permissions.alertingManageBrightnessThresholds.
  - campaign_deletebooleanRequired
    Permissions.campaignDelete.
  - developer_accessbooleanRequired
    Permissions.developerAccess. Gates the webhook operations (developer settings).
metaobjectRequired
Response metadata for single-resource responses. Reserved; currently empty. Clients must ignore unknown members.

Response headers

Vojo-Versionstring
The API version (date) this response was rendered with — the request's Vojo-Version, else the key/org pin.
RateLimitstring
IETF RateLimit header: remaining quota in the current window, e.g. "default";r=97;t=42.
RateLimit-Policystring
IETF RateLimit-Policy header, e.g. "default";q=100;w=60. Portal OAuth clients get a higher tier.

Errors

Every error is application/problem+json. Branch on its code.

400
Malformed request: invalid JSON, a bad cursor, a missing Vojo-Organisation for an OAuth caller, or an unknown Vojo-Version.
401
Missing, invalid, expired or revoked credential.
403
The caller is authenticated but not allowed: missing scope (insufficient_scope), missing Permissions flag (permission_denied), a client/installer persona on an operator endpoint (operator_access_required), or no access to the requested org (organisation_access_denied).
429
Rate limit exceeded for this principal. Back off for Retry-After seconds.
500
Unexpected server failure.