Groupilot Docs

Account

The account behind this key

GET
/me

Returns the project (one WhatsApp number = one project), its billing and number state, the key's scopes and the limits that apply. A good first call to check a key.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An API key created in Settings > Integrations (gp_live_…), or an OAuth access token.

Response Body

Account summary.

application/json
  1. response
project*
channel*|

Null when no WhatsApp number has been linked yet.

key*
limits*
curl -X GET 'https://app.groupilot.com/api/v1/me'
{  "project": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "slug": "string",    "timezone": "string",    "billing": "active",    "automation_blocked": true,    "created_at": "2019-08-24T14:15:22Z"  },  "channel": {    "state": "connected",    "phone_masked": "string",    "connected_at": "2019-08-24T14:15:22Z"  },  "key": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "key_id": "string",    "scopes": [      "read"    ]  },  "limits": {    "read_per_minute": 0,    "write_per_minute": 0,    "broadcasts_per_day": 0,    "adhoc_messages_per_day": 0,    "media_per_day": 0  }}

List notifications

GET
/notifications

The account's notifications (send failures, disconnections, full communities…), newest first.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An API key created in Settings > Integrations (gp_live_…), or an OAuth access token.

Query Parameters

limit?integer
Range1 <= value <= 100
Default20
offset?|
Range0 <= value <= 10000
Default0
unread_only?|
Default"false"

Response Body

Notifications.

application/json
  1. response
items*array<>
curl -X GET 'https://app.groupilot.com/api/v1/notifications'
{  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "type": "string",      "title": "string",      "message": "string",      "read": true,      "metadata": {        "property1": null,        "property2": null      },      "created_at": "2019-08-24T14:15:22Z"    }  ]}