Skip to main content
Every Jobin API action follows the same conventions. Read this page once, then use the action pages for the exact fields.

​
Base URL

Append each action’s path to this base URL:

​
Headers

Send your API key with every request. Add Content-Type when the request has a JSON body.

​
Success responses

After a 202, check the contact or the operations for the result. For error responses and retries, see integration guidelines.

​
Identifiers

Actions that work on one record take its identifier in the path. Keep the identifiers that earlier responses return, such as contactId and campaignId, and reuse them in later requests. The introduction lists the terms you will see.

​
Pagination

List actions return one page at a time. Most use page (starting at 1, up to 100) and limit. A few lists work differently:
  • Contacts beyond page 100. Page numbers stop at 100. To keep going, send the nextCursor value from the previous response as the cursor query parameter. nextCursor is null when there are no more contacts.
  • Counts. Contact and campaign lists only include a total when you send includeTotal=true. Request it only when you need the count; contact lists with a count have a lower rate limit.
  • Contact events. Events have no page number. Send beforeDate to read events created before that timestamp.
  • Contact tags. Tags have no page number. Use limit to choose how many to return.

​
Next steps

Integration guidelines

Handle errors, retries, background work, and rate limits.

OpenAPI specification

Give your tool or assistant the exact request definitions.