Basics

Who the token acts as.

Base URL https://api.zilomail.in

Who am I#

GET/v1/me

any valid token

The person the token acts as, their organisation, and what the token may do. A good first call: it proves the token works.

Answer · 200 OK

idstring

Their ZiloOne user id (the same sub Sign in with ZiloOne gives).

emailstring

namestring | null

usernamestring | null

rolestring

Their role in the organisation: owner, admin or user.

organisationobject

idstring

namestring

kindenum

One of organisation, personal.

viaenum

How this request signed in. One of app, key, personal.

appobject | null

idstring

namestring

scopesarray of string

What this token may do.

appsobject

Which ZiloOne apps the organisation has on.

curl "https://api.zilomail.in/v1/me" \
  -H "Authorization: Bearer $ZILO_TOKEN"

Answer · 200 OK

{
  "id": "string",
  "email": "string",
  "name": "string",
  "username": "string",
  "role": "string",
  "organisation": {
    "id": "string",
    "name": "string",
    "kind": "organisation"
  },
  "via": "app",
  "app": {
    "id": "string",
    "name": "string"
  },
  "scopes": [
    "string"
  ],
  "apps": {}
}

Try it