Overview

Important: This section describes the API endpoints that your system must implement to integrate with Genesy. These are not Genesy API endpoints — they are the interface specification that Genesy will call on your CRM.

Introduction

To integrate your custom CRM with Genesy, your system must expose a set of HTTP endpoints that Genesy will call. This documentation covers the exact specification your API must follow.

All endpoints must be accessible via HTTPS and accept the API key header you configured during connection setup.

Required Endpoints

Health Endpoint

Connection validation endpoint

Tasks API

Task CRUD and batch operations

Authentication

Your API must validate the API key sent in the header you specified during setup (default: X-API-Key).

# Genesy will send requests like this:
GET /health HTTP/1.1
Host: your-api.com
X-API-Key: your-configured-secret
Content-Type: application/json
Accept: application/json

Return 401 Unauthorized if the API key is invalid or missing.

Health Endpoint

Your Implementation Required

This endpoint must be implemented on your server

Genesy calls this endpoint to validate the connection during setup and periodic health checks.

Request

GET /health

Headers

Header	Description
`X-API-Key` (or your custom header)	Your API key for authentication
`Content-Type`	`application/json`
`Accept`	`application/json`

Response

Success (200)
Unauthorized (401)

Return any 2xx status code to indicate your API is healthy and the authentication is valid.

{
  "status": "ok"
}

The response body is not validated — only the HTTP status code matters.

Return 401 if the API key is invalid.

{
  "error": "Invalid API key"
}

Error Handling

Your API should return appropriate HTTP status codes:

Status Code	When to Use
`200` / `201`	Success
`400`	Invalid request body or parameters
`401`	Invalid or missing API key
`404`	Resource not found
`500`	Server error

Error responses should include a message:

{
  "error": "Task not found",
  "message": "No task exists with ID: task-xyz"
}

API documentation

Custom CRM

Endpoints

Introduction

Required Endpoints

Health Endpoint

Tasks API

Authentication

Health Endpoint

Your Implementation Required

Request

Headers

Response

Error Handling

Next Steps

Tasks API

Examples

API documentation

Custom CRM

Endpoints

​Introduction

​Required Endpoints

Health Endpoint

Tasks API

​Authentication

​Health Endpoint

Your Implementation Required

​Request

​Headers

​Response

​Error Handling

​Next Steps

Tasks API

Examples

Introduction

Required Endpoints

Authentication

Health Endpoint

Request

Headers

Response

Error Handling

Next Steps