Skip to contentSee BidToJob in Action

Connect Another App Through the Open API

A REST-based connection can automate routine work between systems. The setup has three parts: create a secret key, share your account subdomain, and agree on the exact field values the sending app should use.

1. Create and protect the secret key

Open the Integrations area from Admin in the left menu, scroll to the Open API section, and choose the option to generate a new key. Name it after the sending application so it is easy to recognise later, then select the clients.create permission. Copy the secret key immediately and send it to the other app by email. It is shown only once, so treat it like a password and keep it secure. If it is lost, generate a replacement key rather than trying to retrieve the original.

2. Find and share your subdomain

The subdomain is the first part of the web address used to sign in. For example, in a login address beginning with johnsfloors before the main domain, johnsfloors is the subdomain. Send that value to the sending app so it knows which account should receive the data.

3. Agree the data format and exact values

Use the attached API document for the required request format. Some fields are optional, but any field you do include must match an existing setup value exactly or the request will fail. Before handing the connection over, check each value against the live account rather than relying on memory.

Field map with example values

leadStatusName: Lead Received leadSourceName: Facebook salesPersonFirstName: Alice salesPersonLastName: Thompson leadSetterFirstName: Bob leadSetterLastName: Roberts className: Residential projectTypeName: Replacement Windows

4. Send one complete handover email

Send the API document as an attachment, then include the secret key, the subdomain, and the default values for each field listed above. Replace every placeholder with the agreed value before sending, and ask the other app to confirm the format it will use.

Pre-send checklist

Key created and copied before leaving the screen Sending app named in the key label clients.create permission selected Subdomain checked against the login address Every optional field value checked against existing setup values API document attached to the handover email Secret key stored securely, not shared in a public channel

Frequently asked questions

What does Open API documentation mean in this context?

Here it means a publicly available REST API: the endpoints and instructions another application uses to send data into, or pull data from, your account.

What is the benefit of connecting through the API?

It allows a connection to other applications so lead creation and data syncing can happen automatically, without manual re-entry.