Meridian CRM API Documentation

Welcome to the Meridian CRM API documentation. This guide provides comprehensive information about the Meridian API endpoints, authentication methods, and data models.

Overview

The Meridian API is a RESTful API that allows you to interact with the Meridian CRM system programmatically. You can use the API to manage companies, deals, people, emails, meetings, notes, documents, and users.

Base URL

Development Environment: https://meridian-ai.dev/api/public/v1/
Test Environment: https://uat.meridian-ai.dev/api/public/v1/
Production Environment: https://app.meridian-ai.com/api/public/v1/

Authentication

All API requests require authentication using OAuth 2.0 with PKCE. See the Authentication documentation for details on how to authenticate your requests.

API Coverage

Companies - Manage company information and relationships
Deals - Track and manage sales opportunities
People - Manage contacts and individuals
Emails - Track email communications
Meetings - Schedule and manage meetings
Notes - Create and manage notes, including AI-generated summaries
Documents - Store and manage files and documents
Users - Manage user accounts and permissions

For a combined view of all API documentation in both markdown and tabular formats, see the Combined Documentation.

OpenAPI Specification

The Meridian API is documented using the OpenAPI 3.0 specification. You can access the full OpenAPI specification at:

<https://app.meridian-ai.com/api/schema/>

This endpoint returns the complete OpenAPI schema in JSON format, which can be imported into tools like Swagger UI, Postman, or other API clients.

For a more user-friendly interface, you can access the Swagger UI at:

<https://app.meridian-ai.com/api/schema/swagger-ui/>

API Versioning

The Meridian API uses URL versioning. The current version is v1. All API endpoints are prefixed with /api/public/v1/.

When new versions are released, they will be available at /api/public/v2/, /api/public/v3/, etc. We maintain backward compatibility for at least one year after a new version is released.

Rate Limits

The Meridian API does not currently implement explicit rate limiting. However, to ensure service stability:

Implement reasonable request patterns in your applications
Avoid sending large bursts of requests in short time periods
Consider implementing client-side throttling for batch operations

For specific rate limit requirements or concerns, please contact Meridian support.

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of requests:

200 OK - The request was successful
201 Created - The resource was successfully created
204 No Content - The request was successful but no content is returned
400 Bad Request - The request was invalid
401 Unauthorized - Authentication failed
403 Forbidden - The authenticated user does not have permission to access the resource
404 Not Found - The requested resource was not found
500 Internal Server Error - An error occurred on the server

Error responses include a JSON body with details about the error:

{
  "error": "error_code",
  "message": "A human-readable error message",
  "details": {
    "field_name": ["Error details for the specific field"]
  }
}

Pagination

List endpoints support pagination using limit and offset parameters:

GET /api/public/v1/companies/?limit=10&offset=20

Paginated responses include metadata about the pagination:

{
  "count": 100,
  "next": "",
  "previous": "",
  "results": [
    // Array of items
  ]
}

Filtering and Sorting

Most list endpoints support filtering and sorting:

Filtering: Use query parameters that match field names
Sorting: Use the ordering parameter with field names (prefix with for descending order)

Example:

GET /api/public/v1/companies/?type=b215c217-248f-4d11-be17-d47f1a0b644e&ordering=-created

Rate Limits

Meridian offers two API access tiers to support vendor integrations. All requests are subject to strict rate limits to ensure system stability and fair usage.

Plan

Rate Limit

Notes

Standard

600 requests per minute

Suitable for most vendor use cases

Enterprise

3,000 requests per minute

Higher throughput for large-scale integrations

For specific rate limit requirements or concerns, please contact Meridian support.

Changelog

v1.0.0 (2025-01-01)

Initial release of the Meridian API
Support for companies, deals, people, emails, meetings, notes, documents, and users
OAuth 2.0 authentication with PKCE
OpenAPI 3.0 documentation

v1.1.0 (2025-03-15)