ClarifyClarify APIBeta
Getting Started

AI assistants

Use the Clarify API with Claude Code, Cursor, and other AI agents

Install the Clarify skill

The fastest way to give your AI assistant full Clarify API context:

npx skills add clarifyhq/skills

This works with Claude Code, Cursor, and any agent that supports skills. Your assistant gets every endpoint, field type, and best practice — no copy-pasting docs.

Claude Code

MCP integration

Clarify has a native MCP (Model Context Protocol) integration. Connect it in Settings > Integrations in Claude Code. Once connected, Claude can query records, schema, and lists directly — no API key needed in the conversation.

Direct API access

Give Claude your API key and workspace slug:

My Clarify workspace is "acme" and my API key is in $CLARIFY_API_KEY.
Base URL: https://api.clarify.ai/v1
Auth: "Authorization: api-key $CLARIFY_API_KEY" (not Bearer)

Example prompts

  • "List the first 10 companies in my Clarify workspace"
  • "Create a person named Jane Doe with email jane@acme.com"
  • "Find all deals with stage 'Negotiation' and amount over 50k"
  • "Build a script that imports this CSV into Clarify as companies"
  • "What fields are on the deal object in my workspace?"

Tips for AI-assisted development

  • Install the skill firstnpx skills add clarifyhq/skills is easier than pasting docs
  • Share the OpenAPI spec — point to https://api.clarify.ai/swagger-json for full endpoint coverage
  • Mention collection fields{ items: [...] } format isn't a common API pattern, assistants will miss it
  • Warn about api-key auth — every assistant defaults to Bearer unless told otherwise
  • Start with reads — have the assistant fetch existing records before writes, so it discovers your schema
  • Use --globoff with curl — filter brackets get mangled by shell expansion

Cursor

Install the skill in your Cursor project:

npx skills add clarifyhq/skills

Then ask Cursor to build integrations — it'll have full API context for code generation.

Custom GPTs and assistants

If you're building a custom GPT or AI assistant:

  1. Upload the OpenAPI spec as an action schema
  2. Configure auth as a custom header: Authorization: api-key {key}
  3. Set the server URL to https://api.clarify.ai/v1

Postman and Insomnia

Import the OpenAPI spec for a complete collection:

https://api.clarify.ai/swagger-json

Set up an environment variable for your API key and configure the auth header as api-key {{apiKey}}.