Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Mobile First Company Contacts API

Search and retrieve contact information with sorting and pagination. Includes engagement level tracking.

The Mobile First Company Contacts API is one of 13 APIs that The Mobile First Company publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, and defines 11 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.withallo.com.

4 operations 3 paths 11 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.withallo.com
Authentication
API Key, API Key, API Key, API Key, API Key
Contact
Allo Support
Resource Areas
1

Authentication & Security 5

The Mobile First Company Contacts API declares 5 security schemes for authenticating requests. An API key is passed in the header as Authorization (CallsAuth). An API key is passed in the header as Authorization (ContactsAuth). An API key is passed in the header as Authorization (ContactsWriteAuth). An API key is passed in the header as Authorization (SmsAuth). An API key is passed in the header as Authorization (ApiKeyAuth).

  • CallsAuth — Scope needed: CONVERSATIONSREAD
  • ContactsAuth — Scope needed: CONTACTSREAD
  • ContactsWriteAuth — Scope needed: CONTACTSREADWRITE
  • SmsAuth — Scope needed: SMSSEND

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Contacts 4

Search and retrieve contact information with sorting and pagination. Includes engagement level tracking.

GET
/v1/api/contacts
Search Contacts
searchContacts 2 params → 200401403429
POST
/v1/api/contacts
Create Contact
createContact body → 200401403429
PUT
/v1/api/contacts/{contact_id}
Update Contact
updateContact 1 param body → 200400401403429
GET
/v1/api/contact/{contact_id}
Get Contact
getContactContext 2 params → 200400401403429

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ContactWithEngagementApiResponse (14 properties), ContactContextApiResponse (13 properties), UpdateContactRequest (6 properties), CreateContactRequest (6 properties). Each schema is shown below with its type and property counts.

GetContactContextResponse
object
Standard response wrapper for contact context
1 property
ContactApiResponse
object
Standard response wrapper for a single contact
1 property
PaginationMeta
object
Pagination metadata wrapper for contacts endpoint
1 property
ContactContextApiResponse
object
Comprehensive contact context including integration data and activity
13 properties
CreateContactRequest
object
Request body for creating a new contact
6 properties 1 required
UpdateContactRequest
object
Request body for updating an existing contact. Only provided fields will be updated.
6 properties
ContactActivityApiResponse
object
A communication activity (call or SMS) with a contact
5 properties 2 required
ErrorResponse
object
2 properties
SearchContactsApiResponse
object
Standard response wrapper for paginated contact results
1 property
ContactWithEngagementApiResponse
object
A contact record with engagement information
14 properties
ErrorDetail
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-mobile-first-company-contacts-api-openapi.yml Raw ↑

Other APIs The Mobile First Company publishes across the network.

The Mobile First Company Analytics API
The Mobile First Company Calls API
The Mobile First Company Conversations API
The Mobile First Company CRM API
The Mobile First Company Partner API
The Mobile First Company Phone Numbers API
The Mobile First Company Power Dialer API
The Mobile First Company SMS API
The Mobile First Company Summary Templates API
The Mobile First Company Tags API
The Mobile First Company Users API
The Mobile First Company Webhooks API