Insightly Contacts API

openapi: 3.1.0
info:
  title: Insightly CRM Contacts API
  description: 'Insightly CRM REST API v3.1. Supports CRUD over Contacts, Organizations,

    Opportunities, Leads, Projects, Products, Quotations, and more. Authentication

    is HTTP Basic with a Base64-encoded API key as the username.

    '
  version: '3.1'
  contact:
    name: Insightly API Help
    url: https://api.insightly.com/v3.1/Help
servers:
- url: https://api.{pod}.insightly.com/v3.1
  description: Pod-specific base URL (your pod is shown in User Settings under API Key)
  variables:
    pod:
      default: na1
security:
- BasicAuth: []
tags:
- name: Contacts
paths:
  /Contacts:
    get:
      summary: List contacts
      operationId: listContacts
      parameters:
      - in: query
        name: top
        schema:
          type: integer
      - in: query
        name: skip
        schema:
          type: integer
      responses:
        '200':
          description: Array of contacts
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Contact'
      tags:
      - Contacts
    post:
      summary: Create a contact
      operationId: createContact
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Contact'
      responses:
        '201':
          description: Created contact
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
      tags:
      - Contacts
  /Contacts/{id}:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: integer
        format: int64
    get:
      summary: Get a contact
      operationId: getContact
      responses:
        '200':
          description: Contact
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
      tags:
      - Contacts
    put:
      summary: Update a contact
      operationId: updateContact
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Contact'
      responses:
        '200':
          description: Updated contact
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Contact'
      tags:
      - Contacts
    delete:
      summary: Delete a contact
      operationId: deleteContact
      responses:
        '202':
          description: Deleted
      tags:
      - Contacts
  /Contacts/Search:
    get:
      summary: Search contacts by field
      operationId: searchContacts
      parameters:
      - in: query
        name: field_name
        schema:
          type: string
      - in: query
        name: field_value
        schema:
          type: string
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Contact'
      tags:
      - Contacts
components:
  schemas:
    Contact:
      type: object
      properties:
        CONTACT_ID:
          type: integer
          format: int64
        FIRST_NAME:
          type: string
        LAST_NAME:
          type: string
        EMAIL_ADDRESS:
          type: string
          format: email
        PHONE:
          type: string
        DATE_CREATED_UTC:
          type: string
          format: date-time
        DATE_UPDATED_UTC:
          type: string
          format: date-time
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: 'Username is the Base64-encoded API key; password is left blank.

        Example header: Authorization: Basic <base64(apiKey:)>

        '