Quickstart

Get your first successful API call in minutes: Authenticate -> Find a contact -> Assign to a sequence

What You Will Achieve

By the end of this guide, you will:

Validate your API key
Retrieve a contact
Optionally enrich the contact
Trigger a sequence (email, SMS, social, and more)

Base URL

All requests use:

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

Before You Begin

If you are giving this workflow to an AI agent, pass both this page and /openapi/jobin-integration.json. This page explains the business order of operations; the OpenAPI file provides the exact request and schema details.

1. Create an API key

Go to Jobin integrations
Open Custom integration
Click Create new API key
Copy the key because it is shown only once

Example:

sk_xxxxx

2. Set required headers

All requests must include:

x-api-key: <your API key>
Content-Type: application/json

Step 1 -> Get A Sequence (Campaign)

All outreach actions run through sequences created in the UI.

Option A -> Copy from UI

Open a sequence in Jobin
Copy the ID from the URL

https://my.jobin.cloud/outreach/69dcf9e38ca16eee3e8bf8f8/edit

Sequence ID:

69dcf9e38ca16eee3e8bf8f8

Option B -> Fetch via API

See /api-reference/campaigns for listing sequences programmatically.

Rate Limits And Retries

OpenAPI requests are rate-limited per API identity:

API key validation: 30 requests/minute
Reads: 120 requests/minute
Writes: 30 requests/minute
Enrichment, campaign assignment, social message, and event download actions: 10 requests/minute

Every response includes rate-limit headers. If you receive 429 Too Many Requests, wait for retry-after seconds before retrying and use exponential backoff.

Step 2 -> List Contacts

curl --request GET \
  --url "https://my.jobin.cloud/api/openapi/v1/contacts?limit=10" \
  --header "x-api-key: <your API key>"

Save a contactId from the response. If you already know an email or social URL, add email=<email> or socialUrl=<url>.

Step 3 -> Optionally Enrich The Contact

curl --request POST \
  --url "https://my.jobin.cloud/api/openapi/v1/contacts/<contactId>/enrichment" \
  --header "x-api-key: <your API key>" \
  --header "Content-Type: application/json" \
  --data "{\"findEmail\":true,\"findPhone\":true,\"findSocialUrls\":true,\"enrichCareerDetails\":true}"

If the response returns a processing state, poll the enrichment report:

curl --request GET \
  --url "https://my.jobin.cloud/api/openapi/v1/contacts/<contactId>/enrichment/reports/<reportId>" \
  --header "x-api-key: <your API key>"

Step 4 -> Assign Contact To Sequence

curl --request POST \
  --url "https://my.jobin.cloud/api/openapi/v1/campaigns/<campaignId>/contacts" \
  --header "x-api-key: <your API key>" \
  --header "Content-Type: application/json" \
  --data "{ \"contactIds\": [\"<contactId>\"] }"

Full Flow Summary

Create API key
Validate auth
Get sequence ID
Search contact
Optionally enrich
Assign to sequence -> outreach triggered

Use The OpenAPI Definition

Import:

/openapi/jobin-integration.json

Compatible with:

Postman
Insomnia
n8n
Claude, ChatGPT, Cursor, and other agents that can ingest OpenAPI
Any OpenAPI client

Next Steps

/api-reference/authentication
/api-reference/contacts
/api-reference/campaigns

​Quickstart

​What You Will Achieve

​Base URL

​Before You Begin

​1. Create an API key

​2. Set required headers

​Step 1 -> Get A Sequence (Campaign)

​Option A -> Copy from UI

​Option B -> Fetch via API

​Rate Limits And Retries

​Step 2 -> List Contacts

​Step 3 -> Optionally Enrich The Contact

​Step 4 -> Assign Contact To Sequence

​Full Flow Summary

​Use The OpenAPI Definition

​Next Steps