Environments and base URLs
Send every request to the base URL below, and read Developing against live data before your first write.
| Environment | Base URL | Token endpoint | What it is |
|---|---|---|---|
| Production | https://api2.recruso.co.uk | POST /apiauth | Live agency data. Credentials are issued per API app through the Developer Console and are bound to one agency; every request is scoped to that agency's OwnerID. |
There is one environment, and it is production — no sandbox, no staging tier, no test instance. Every call you make while building reads and writes the same agency data your colleagues are working in. That is the fact the rest of this page is about, and it is stated here rather than in a footnote because it changes how you work, not just where you point your client.
Reading the paths in this documentation
Section titled “Reading the paths in this documentation”Every path in the reference is relative to the base URL above. GET /v1/branches means
GET https://api2.recruso.co.uk/v1/branches.
Two surfaces sit alongside the API on the same host, and both are same-origin, so no separate domain or CORS configuration is involved:
/openapi/v1.json— the machine-readable contract for the integrator surface./scalar/v1— the playground, where you can execute a call against your own credentials.
HTTPS only
Section titled “HTTPS only”The API is served over TLS and nothing else. Tokens are bearer credentials: anything holding one can
act as your integration for the life of that token, so a request over plain HTTP would put the
credential on the wire. Reject a redirect to http:// rather than following it.
Developing against live data
Section titled “Developing against live data”Working without a test tier is a constraint to design around rather than an oversight to work around, and four things follow from it.
- Reads are safe.
GETcalls change nothing, so exploring the shape of your agency’s data — through the playground or your own client — costs nothing but rate. - Writes are not rehearsals. A record created by a test run is a record your colleagues will see in the Recruso UI. Name test data so a human can recognise it as such.
- Some deletes are recoverable and some are not. Several resources are soft-deleted and have an explicit restore operation; others are not. Check the operation in the reference before you call it, not after.
- Your credentials cannot reach another agency. Whatever a test run does, it does inside your own tenant. See Multi-tenancy and data isolation.
Adding an environment
Section titled “Adding an environment”If Recruso ever stands one up, it appears in the table above without anything else on this site changing: the table, the code samples and the playground links all render from a single configuration file. An environment listed here is one Recruso is committing to, which is why none is listed speculatively.
Responses and pagination — the conventions every endpoint follows.