Skip to main content
Use this guide to connect an automation tool or AI assistant through the Jobin API. For a conversational connection, follow the Jobin MCP setup guide.

Before you begin

Have a Jobin account and a sequence ready. Review the sequence’s messages, timing, and senders before adding contacts. Give your assistant this guide and the OpenAPI specification. The specification provides the exact fields your assistant or tool needs.

Start your first workflow

1

Create an API key

Open Jobin integrations, select Custom integration, and click Create new API key.Copy the key when it appears and save it in your tool’s credentials settings. Send it in the x-api-key header.
2

Check the connection

Ask your assistant or tool to validate the API key. A successful response contains valid: true.
3

Choose a contact

Find a contact using an email address, name, role, or tag. Keep the returned contactId for the next steps.Example instruction for your assistant:
Find contacts with the title “Account Manager” in my Jobin workspace. Show me the matches before taking further action.
If the contact is new to Jobin, import the contact first.
4

Fill in missing information

If your sequence needs information the contact is missing, request contact enrichment. Select the fields you need, such as email or phone.Enrichment may continue in the background. Check the contact for the requested fields before proceeding.
5

Choose and review a sequence

Open your sequence in Jobin and copy its ID from the URL, or use List campaigns.A sequence is called a campaign in the API. Use its ID as campaignId. Confirm the contact, messages, timing, and sender before starting outreach.
6

Add the contact to the sequence

Use Assign contacts to a campaign with the selected contactId and campaignId.This action starts the configured outreach. A 202 Accepted response means Jobin has queued the work. Save the returned jobGroupId to check sequence operations.

Check the result

Review the contact’s sequence activity in Jobin. Use the operations reference when your tool needs to inspect queued or processing work. If a request is interrupted, check the result before sending the action again. See integration guidelines for background processing and retries. Requests are rate limited. For a 429 response, wait for retry-after before trying again. Rate limits.