YSUITE External API

The YSUITE External API provides programmatic access to your business data — leads, contacts, deals, tasks, estimates, and invoices.

Base URL

https://api.ysuite.org/v1

All requests must be made over HTTPS.

Authentication

All endpoints require an Access Key and Secret Key passed as request headers:

x-ysuite-access-key: YOUR_ACCESS_KEY
x-ysuite-secret-key: YOUR_SECRET_KEY

See the Authentication guide for how to generate and manage API credentials.

Response format

Every response — success or error — uses a consistent envelope:

{
  "success": true,
  "message": "Lead created successfully!",
  "data": { ... }
}

For errors, success is false and data is omitted:

{
  "success": false,
  "message": "No organisation assigned to user"
}

Request format

The API accepts and returns JSON. Include Content-Type: application/json on POST and PUT requests.

Versioning

The current version is v1. Breaking changes are released under a new version prefix.

Supported modules

| Module | Endpoints | |---|---|---| | Leads | /v1/leads| | Contacts | /v1/contacts | | Deals | /v1/deals | | Tasks | /v1/tasks | | Estimates | /v1/estimates | | Invoices | /v1/invoices |

Explore interactively

Use the Interactive Explorer to browse every endpoint, try live requests, and see example responses — no code required.