How do I import data with the API?
In Import data, click Start on API, then New key. Copy the key once and send records from a script. Each import can be undone.
Open Import data, click Start on API, then click New key. Give the key to your developer or your script: it sends your customers, companies, quotes, jobs and invoices to your app. Every import shows under Recent imports, where you can undo it.
Also called: API key, developer, script, integration, REST API, bulk import, migration from Jobber, clé API, développeur, importation par API
Use this when someone writes a script to move your data from another tool. Each key works for your app only, and writes to your real data.
Step 1: Open the API page
In the side menu, click Import data. On the API card, click Start. The page Data import API shows your Base URL, your keys and a guide with your app's real fields.
Click: Import data › API › Start
Step 2: Make a key
Click New key, type a Key name (for example "Jobber migration"), then click Create key. Click Copy right away: for your security, it won't be shown again. Then click Done.
Click: New key › Create key › Copy
Step 3: Send your data
Give the key and the Base URL to your developer. The guide How to use the API on the same page shows every step, with code samples and your app's fields. Records show in your CRM right away.
Click: How to use the API
Step 4: Check or undo an import
Under Recent imports, each import shows how many records it added, updated or failed. To take one back, click Undo, then confirm. It deletes the records this import added. Records your team has added to since are kept.
Click: Recent imports › Undo
Good to know
Up to 500 records per request, and 120 requests a minute per key.
Sending the same record again updates it instead of making a copy, so a retry is safe.
Your developer can do a test run first: it checks every record and saves nothing.
To stop a key, click Revoke. Scripts using it stop working right away. Imported records stay.
If it doesn't work
"The key is missing, wrong or revoked." Make a new key and use it.
"Your app isn't ready for imports yet, or the import is already undone." Your app may need an update: open it, publish or upgrade it, then try again. If you just undid that import, there is nothing left to do.
"More than 500 records in one request." Send smaller batches.
"Too many requests. Wait a minute and try again." Slow down to 120 requests a minute.
"Your app couldn't list its fields right now. Try again in a minute, or call GET /objects." Reload the page in a minute.
"Something went wrong. Try again." Try again in a moment.