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

Insightly Contacts API

The Contacts API from Insightly — 3 operation(s) for contacts.

Insightly Contacts API is one of 8 APIs that Insightly 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.

This API exposes 6 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 3.1.

Requests are made against a single base URL, https://api.{pod}.insightly.com/v3.1.

6 operations 3 paths 1 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.1
Base URL
https://api.{pod}.insightly.com/v3.1
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Insightly Contacts API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BasicAuth — Username is the Base64-encoded API key; password is left blank. Example header: Authorization: Basic

Paths & Operations 6

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

Contacts 6
GET
/Contacts
List contacts
listContacts 2 params → 200
POST
/Contacts
Create a contact
createContact body → 201
GET
/Contacts/{id}
Get a contact
getContact 1 param → 200
PUT
/Contacts/{id}
Update a contact
updateContact 1 param body → 200
DELETE
/Contacts/{id}
Delete a contact
deleteContact 1 param → 202
GET
/Contacts/Search
Search contacts by field
searchContacts 2 params → 200

Schemas 1

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

Contact
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

insightly-contacts-api-openapi.yml Raw ↑

Other APIs Insightly publishes across the network.

Insightly REST API v3.1
Insightly Leads API
Insightly Opportunities API
Insightly Organisations API
Insightly Products API
Insightly Projects API
Insightly Quotations API