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

Weave Contacts API

Patient/customer contacts and contact info.

Weave Contacts API is one of 8 APIs that Weave 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 5 operations across 5 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

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

5 operations 5 paths 2 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.weaveconnect.com
Authentication
OAuth 2.0, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Weave Contacts API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 access token issued by Weave's OIDC provider. Authorization and token endpoints are served under https://auth.weaveconnect.com/oauth2/default (issuer…
  • bearerAuth — OAuth 2.0 bearer access token passed as Authorization: Bearer ACCESSTOKEN.

Paths & Operations 5

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

Contacts 5

Patient/customer contacts and contact info.

GET
/v1/contacts
List contacts
listContacts 2 params → 200401
POST
/v1/contacts/search
Search contacts
searchContacts 1 param body → 200401
GET
/v1/contact-infos
List contact info records
listContactInfos 1 param → 200401
POST
/v1/contacts/block
Block a contact
blockContact 1 param body → 200401
POST
/v1/contacts/unblock
Unblock a contact
unblockContact 1 param body → 200401

Schemas 2

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

Contact
object
6 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weave-hq-contacts-api-openapi.yml Raw ↑

Other APIs Weave publishes across the network.

Weave Events API
Weave Forms API
Weave Messaging API
Weave Payments API
Weave Phone & Calls API
Weave Reviews API
Weave Scheduling API