Agile CRM Events API

The Events API from Agile CRM — 3 operation(s) for events.

OpenAPI Specification

agile-crm-events-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Agile CRM REST Campaigns Events API
  version: 1.0.0
  description: HTTPS-only REST API for managing contacts, companies, deals (opportunities), campaigns, tasks, events, notes, tracks, tickets, and documents in Agile CRM. Authentication is HTTP Basic with account email as username and REST client API key as password.
  contact:
    name: Agile CRM
    url: https://www.agilecrm.com/api
servers:
- url: https://{domain}.agilecrm.com/dev
  description: Tenant-scoped base URL
  variables:
    domain:
      default: mydomain
      description: Your Agile CRM tenant subdomain
security:
- BasicAuth: []
tags:
- name: Events
paths:
  /api/events:
    get:
      tags:
      - Events
      summary: List events
      responses:
        '200':
          description: Events
    post:
      tags:
      - Events
      summary: Create an event
      responses:
        '200':
          description: Event created
  /api/contacts/{contact_id}/events:
    get:
      tags:
      - Events
      summary: Get events for a contact
      parameters:
      - $ref: '#/components/parameters/ContactId'
      responses:
        '200':
          description: Events
  /api/events/{id}:
    put:
      tags:
      - Events
      summary: Update an event
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: Event updated
    delete:
      tags:
      - Events
      summary: Delete an event
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '204':
          description: Event deleted
components:
  parameters:
    ContactId:
      name: contact_id
      in: path
      required: true
      schema:
        type: string
    Id:
      name: id
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic auth - username is account email, password is REST client API key.