Skip to main content

​
API Reference

Use the Jobin Integration API to validate credentials, search and enrich contacts, and add people to Jobin sequences from your own systems. This section uses Mintlify’s native API reference experience, so each endpoint page includes a request builder, generated code samples, and response schemas backed by the OpenAPI document.

Base URL

https://my.jobin.cloud/api/openapi/v1

Auth Header

x-api-key: <your API key>

Try It Now

Open the interactive auth validation request and confirm your credentials.

Download OpenAPI JSON

Import the schema into Postman, Insomnia, n8n, or a typed client generator.

​
Start With These Reference Areas

Authentication

Create a key, understand the public auth model, and validate access before running automation.

Contacts

Search contacts, fetch a single record, update fields, and trigger selective enrichment.

Campaigns

Treat Jobin sequences as campaigns in the API, inspect them, and assign contacts to launch outreach.

Webhooks

Review the provider-facing enrichment callback documented alongside the authenticated API surface.

​
Common Workflow

  1. Validate your API key.
  2. Search or fetch the contact you want to act on.
  3. Trigger enrichment if your sequence depends on missing data.
  4. Assign the contact to a campaign to start the configured sequence.

Try It: Validate API Key

Confirm that your credentials are accepted before wiring Jobin into your workflow.

Try It: List Contacts

Query contacts with filters such as q, email, campaignId, and updatedAfter.

Try It: Trigger Enrichment

Start selective enrichment and inspect the returned reportId when processing continues asynchronously.

Try It: Assign Contacts To Campaign

Add contacts to a sequence and let Jobin run the configured outreach steps.

​
Jobin-Specific Conventions

  • Sequence in the UI equals campaign in the API.
  • campaignId is the sequence identifier copied from the Jobin app URL.
  • Campaign assignment is asynchronous and typically returns 202 Accepted.
  • Enrichment can complete immediately or return a reportId for polling.

​
OpenAPI Source Of Truth

OpenAPI Spec

Use the raw specification for imports, mocks, typed clients, and external tooling.