Filter options

API referenceInbox

From the Inbox API reference. Requests use the base URL https://app.warmerly.com/api/v1 and an API key, see Authentication.

text

GET /inbox/filter-options

Returns the projects and email accounts in your workspace that the inbox can be filtered by, for populating a workspace/account picker in your own UI.

bash

curl https://app.warmerly.com/api/v1/inbox/filter-options \
  -H "X-Api-Key: wmv_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

json

{
  "workspaces": [
    { "id": "b2f4a6c1-3e5d-4f7a-9b1c-0d2e4f6a8c1b", "name": "Marketing outreach" }
  ],
  "accounts": [
    {
      "id": "8f14e45f-ceea-4c6a-8c8d-6b1a5b5c9c1a",
      "email": "you@yourcompany.com",
      "provider": "gmail",
      "projectId": "b2f4a6c1-3e5d-4f7a-9b1c-0d2e4f6a8c1b"
    }
  ]
}

workspaces here is a list of projects within your workspace (the workspaceId query param used elsewhere in this API is a project ID, see the note under List contacts).

Was this page helpful?

Filter options

More from Inbox