# Jobin Integration API

> AI-agent guide for the Jobin public API documentation. Use this index to find the shortest path to the right machine-readable spec, workflow guide, and endpoint reference.

## Start Here

- [Introduction](https://my.jobin.cloud/introduction.md): Product mental model, sequence-to-campaign mapping, and recommended integration order.
- [Quickstart](https://my.jobin.cloud/quickstart.md): First successful flow for validating auth, finding a contact, and assigning the contact to a campaign.
- [API Reference](https://my.jobin.cloud/api-reference/introduction.md): Human-readable operational guidance for the interactive endpoint reference.
- [OpenAPI Spec Guide](https://my.jobin.cloud/api-reference/openapi.md): Explains how to use the raw OpenAPI file with AI agents and automation tools.

## OpenAPI Specs

- [Jobin OpenAPI JSON](https://my.jobin.cloud/openapi/jobin-integration.json): Machine-readable OpenAPI 3.1 source of truth for authentication, contacts, enrichment, campaigns, and supported public endpoints.

## Key Endpoint Areas

- [Authentication](https://my.jobin.cloud/api-reference/authentication.md): API-key model and validation flow.
- [Validate API Key](https://my.jobin.cloud/api-reference/authentication/validate-api-key.md): First request every new integration should call.
- [Contacts](https://my.jobin.cloud/api-reference/contacts.md): Search, import, patch, document, event, and enrichment flows.
- [Campaigns](https://my.jobin.cloud/api-reference/campaigns.md): Sequence lookup and campaign assignment workflow.

## Operational Guidance

- [Webhook Best Practices](https://my.jobin.cloud/webhook-best-practices.md): Receiver design, retries, and downstream processing guidance.
- [Development](https://my.jobin.cloud/development.md): Local development and testing notes for the public integration surface.
- [Jobin MCP](https://my.jobin.cloud/jobin-mcp.md): Remote MCP setup guide for connecting Jobin.cloud contacts to AI assistants.