Account lists API

Look up the IDs of your lines, sequences, inboxes and dispositions.

Many Aloware API calls ask for an ID: the line to send from, the sequence to enroll in, the inbox to route to, the disposition to set. These four endpoints return the ID and name of each one, so you can look them up from code instead of copying them out of the app.

  • Method: GET
  • Auth: your account API token, in the query string as api_token
  • Format: JSON out: an array with the ID and name of each item

Endpoints

/webhook/linesYour lines. Use the ID as line_id in the SMS, ringless voicemail, two-legged call, AloAi outbound call and Lead APIs. RCS lines aren't listed.
/webhook/sequencesYour active sequences. Use the ID as sequence_id.
/webhook/inboxesYour inboxes. Use the ID as ring_group_id in the inbox availability, two-legged call and Lead APIs.
/webhook/disposition-statusesYour disposition statuses. Use the ID as disposition_status_id in the Lead API.

Each path starts with /api/v1, like every other endpoint here.

Request example

curl --location --request GET 'https://app.aloware.io/api/v1/webhook/lines?api_token=[API_TOKEN]' \
--header 'Accept: application/json'

Swap lines for sequences, inboxes or disposition-statuses to get the others.

Response

200: the list

[
    {
        "id": 1,
        "name": "Sales line"
    }
]

Put your own Aloware API token in place of [API_TOKEN].

Zapier uses the same lists

The dropdowns in Aloware's Zapier actions are filled from these same lists, so what you see there matches what these calls return. See Zapier triggers and actions.

Need another endpoint?

For other API functions or any question about this one, email support@aloware.com with what you're trying to do.

Need a hand?

Our support team can help you set this up.

Contact support