Using the API

The Dealops API gives you programmatic access to the same catalog, quotes, deals, and approvals your team works with in the app. It's a JSON over HTTPS API, authenticated with an organization API key.

This section covers the mechanics every call depends on. For the endpoints themselves, see the API reference.

Base URL

https://api.dealops.com/external/v1

Every path in the reference is relative to that base, so GET /whoami is:

curl https://api.dealops.com/external/v1/whoami \
  -H "x-api-key: $DEALOPS_API_KEY"

/whoami is the cheapest way to confirm a key works — it returns the organization the key belongs to and nothing else, so it's a good connectivity check to run first and to wire into your own health checks.

Requests and responses

• Everything is JSON. Send Content-Type: application/json on requests with a body; responses are always application/json.
• HTTPS only. Plain HTTP is not served.
• Unknown request fields are ignored. If you send a field the endpoint doesn't accept, it's dropped and the rest of the request is processed normally rather than rejected. That keeps a stray field from breaking a working integration — but it also means a typo in a field name fails silently, so check that a write did what you expected.
• Request bodies are capped at 10 MB. Larger bodies are rejected with 413. Only the largest quote payloads come close.

Authentication

Every endpoint requires an API key in the x-api-key header. See Authentication.

Versioning

The version is in the path: /external/v1. Everything documented here is v1.

Within a version, the API grows additively — new endpoints and new fields on existing responses can appear without notice. Write clients that ignore fields they don't recognize, and don't depend on a response containing only the fields you see today. Changes that would break a working integration go behind a new version path instead.

What to read next

Page	What it covers
Authentication	Getting a key, what it can do, rotating and revoking it
Errors	Status codes, the error body, and which failures are worth retrying
Rate limits	The per-organization limit and the headers that report your budget
Pagination	How to page through list endpoints