Skip to main content

​
Introduction

The Jobin OpenAPI lets you programmatically trigger outreach workflows such as email, SMS, and social actions by using your existing Jobin data. This page gives you the mental model needed before using the API.

​
AI Agent Starting Point

If you are using ChatGPT, Claude, Cursor, or another coding agent:
  • Use /openapi/jobin-integration.json as the machine-readable source of truth.
  • Use /api-reference/introduction for the human-readable workflow and operational limits.
  • Treat Jobin UI sequences as campaigns in the API.
  • Start with GET /auth/validate, then search or import contacts, then assign contacts to a campaign.
This split exists because agents work better when they have both the raw schema and one short page that explains Jobin-specific business rules.

​
How Jobin Works

Jobin is built around sequences. A sequence is a workflow configured in the UI that can include:
  • Email steps
  • SMS messages
  • Social messages and invites
  • Multi-step automation logic
The API does not send messages directly. Instead, it assigns contacts to sequences, and Jobin executes the workflow.

​
High-Level Integration Flow

All integrations follow the same pattern:
  1. Authenticate using an API key
  2. Retrieve or identify a contact
  3. Optionally enrich the contact
  4. Assign the contact to a sequence
Once assigned, Jobin automatically runs the configured outreach.

​
Base URL

All endpoints are under:
Example:

​
Authentication

All requests require an API key:
Create your key here: Jobin integrations

​
Resource Overview

Use the following resources depending on your use case:

Authentication

Validate API keys and understand auth behavior.

Contacts

Search, retrieve, and enrich contact data.

Campaigns

Manage sequences and assign contacts.

Webhook Best Practices

Design receivers, signing, retries, and idempotent event processing.

​
Sequence Model

In the API:
  • sequence (UI) = campaign (API)
  • Identified by: campaignId
To use a sequence:
  1. Create it in the Jobin UI
  2. Copy the ID from the URL
  3. Use it in:

​
When To Use Enrichment

Enrichment is optional but useful when your sequence depends on missing data such as:
  • Email
  • Phone
  • Social profiles
  • Career data
Use the enrichment endpoint before assigning the contact when downstream steps depend on those fields.

​
OpenAPI Specification

Instead of building requests manually, import the official schema:

OpenAPI Spec

Import into Postman, Insomnia, n8n, or an AI agent that can consume OpenAPI directly.
Continue with the Quickstart to execute your first workflow:

Quickstart

Validate your API key and trigger your first sequence.