API reference / People

People

The organisation's directory.

Base URL https://api.zilomail.in

List people#

GET/v1/people

users.read

The organisation's directory: everyone with an active account, by name.

Query

qstring

Up to 200 characters.

limitinteger

How many to return (1–200). Default 50.

cursorstring

The next value from the previous page. Up to 500 characters.

Answer · 200 OK

dataarray of object

idstring

namestring | null

emailstring

usernamestring | null

jobTitlestring | null

departmentstring | null

nextstring | null

Pass as cursor for the next page; null on the last.

curl "https://api.zilomail.in/v1/people?limit=20" \
  -H "Authorization: Bearer $ZILO_TOKEN"

Answer · 200 OK

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "email": "string",
      "username": "string",
      "jobTitle": "string",
      "department": "string"
    }
  ],
  "next": "string"
}

Try it

Get a person#

GET/v1/people/{id}

users.read

Path

idstringrequired

Their user id or email address. Up to 64 characters.

Answer · 200 OK

idstring

namestring | null

emailstring

usernamestring | null

jobTitlestring | null

departmentstring | null

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

Answer · 200 OK

{
  "id": "string",
  "name": "string",
  "email": "string",
  "username": "string",
  "jobTitle": "string",
  "department": "string"
}

Try it