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

Respond.io Contacts API

Create, read, update, merge, list, and delete contacts.

Respond.io Contacts API is one of 6 APIs that Respond.io 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 8 operations across 6 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, https://api.respond.io/v2.

8 operations 6 paths 6 schemas 1 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://api.respond.io/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Respond.io Contacts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — API Access Token from Settings Integrations Developer API, sent in the Authorization header as Bearer {token}.

Paths & Operations 8

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

Contacts 8

Create, read, update, merge, list, and delete contacts.

POST
/contact
Create a contact
createContact body → 200429
POST
/contact/create_or_update/{identifier}
Create or update a contact
createOrUpdateContact 1 param body → 200429
GET
/contact/list
List contacts
listContacts 2 params → 200429
GET
/contact/{identifier}
Get a contact
getContact 1 param → 200404429
PUT
/contact/{identifier}
Update a contact
updateContact 1 param body → 200404429
DELETE
/contact/{identifier}
Delete a contact
deleteContact 1 param → 200404429
POST
/contact/merge
Merge contacts
mergeContacts body → 200429
GET
/contact/{identifier}/channel
List a contact's channels
listContactChannels 1 param → 200429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Contact (13 properties), ContactCreate (8 properties), Channel (4 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Contact
object
13 properties
CustomFieldValue
object
2 properties
ContactCreate
object
8 properties
Channel
object
4 properties
Pagination
object
2 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

respond-contacts-api-openapi.yml Raw ↑

Other APIs Respond.io publishes across the network.

Respond.io Comments API
Respond.io Conversations API
Respond.io Custom Fields API
Respond.io Messages API
Respond.io Tags API