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 CRM API

Manage people, companies, and deals in your CRM.

The Mobile First Company CRM 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 CRM. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 9 paths, and defines 16 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.

13 operations 9 paths 16 schemas 1 DELETE3 GET1 PATCH6 POST2 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 CRM 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 13

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

CRM 13

Manage people, companies, and deals in your CRM.

POST
/v2/api/crm/people
Create person
createPerson body → 200401409422429
GET
/v2/api/crm/people/{id}
Get person
getPerson 1 param → 200401404429
PUT
/v2/api/crm/people/{id}
Update person
updatePerson 1 param body → 200401404422429
POST
/v2/api/crm/people/search
Search people
searchPeople body → 200401422429
POST
/v2/api/crm/companies
Create company
createCompany body → 201401422429
GET
/v2/api/crm/companies/{id}
Get company
getCompany 1 param → 200401404429
PUT
/v2/api/crm/companies/{id}
Update company
updateCompany 1 param body → 200401404422429
POST
/v2/api/crm/companies/search
Search companies
searchCompanies body → 200401422429
POST
/v2/api/crm/deals
Create deal
createDeal body → 201401422429
GET
/v2/api/crm/deals/{id}
Get deal
getDeal 1 param → 200401404429
PATCH
/v2/api/crm/deals/{id}
Update deal
updateDeal 1 param body → 200401404422429
DELETE
/v2/api/crm/deals/{id}
Delete deal
deleteDeal 1 param → 204401404429
POST
/v2/api/crm/deals/search
Search deals
searchDeals body → 200401422429

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are CrmPerson (13 properties), CrmCompany (9 properties), CreatePersonRequest (9 properties), CrmDeal (9 properties). Each schema is shown below with its type and property counts.

CrmCompany
object
A company in the CRM
9 properties
UpdateCompanyRequest
object
Request body for updating a company. Only provided fields will be updated.
3 properties
CreateCompanyRequest
object
Request body for creating a company
3 properties 1 required
UpdateDealRequest
object
Request body for updating a deal. Only provided fields will be updated.
6 properties
CrmCompanyRef
object
Embedded company reference
2 properties
SearchPeopleRequest
object
Request body for searching people
5 properties
PaginatedResponse
object
1 property
SearchDealsRequest
object
Request body for searching deals
5 properties
SearchCompaniesRequest
object
Request body for searching companies
4 properties
CrmPerson
object
A person in the CRM
13 properties
CreateDealRequest
object
Request body for creating a deal
6 properties 1 required
CrmDeal
object
A deal in the CRM
9 properties
UpdatePersonRequest
object
Request body for updating a person. Only provided fields will be updated.
8 properties
CreatePersonRequest
object
Request body for creating a person
9 properties 1 required
Pagination
object
5 properties
ApiError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-mobile-first-company-crm-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 Contacts API
The Mobile First Company Conversations 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