Quickstart

From zero to your first successful call.

1. Mint a key

Settings → API Keys → New key. In the scope picker, grant what you need — for this quickstart, contacts:read. Copy the agx_… value (shown once).

2. Make the call — three ways

The same operation — "search my contacts for acme" — in each surface.

curl (REST)

curl "https://api.expedify.ai/v1/objects/contacts?q=acme&limit=5" \
  -H "Authorization: Bearer agx_your_key"

{
  "data": [
    { "id": "…", "email": "jane@acme.com", "first_name": "Jane", "lead_status": "qualified" }
  ],
  "pagination": { "limit": 5, "offset": 0, "total": 1, "has_more": false }
}

SDK (TypeScript)

import { Expedify } from "@expedify/sdk";

const client = new Expedify({ apiKey: process.env.EXPEDIFY_API_KEY });

const page = await client.contacts.list({ q: "acme", limit: 5 });
console.log(page.data);

Python is identical in spirit — see the SDKs page for install + usage.

MCP (an agent)

Connect a client once (Connect), then just ask:

"Use Expedify to search my contacts for acme."

The agent calls the search_contacts tool:

{
  "jsonrpc": "2.0", "id": 1, "method": "tools/call",
  "params": { "name": "search_contacts", "arguments": { "q": "acme", "limit": 5 } }
}

3. Next

• Create something: POST /v1/objects/contacts (needs contacts:write).
• Page + filter: ?lead_score__gte=50&sort=created_at&order=desc — see Overview → Filtering.
• Go further: browse the Workflows, Knowledge Base, and Analytics operations in the API reference sidebar; or the MCP tool catalog.