Skip to content
Recruso API

Overview

Clients & sites 1.0.0

Section titled “Clients & sites 1.0.0”

Clients, the sites they operate, and everything hanging off a site — contact persons, rate contracts, activities and cost-centre links. Leads are prospective clients.

Information

  • OpenAPI version: 3.0.1

Operations

Section titled “Operations”
GET
/v1/clients
POST
/v1/clients
GET
/v1/clients/{id}
PUT
/v1/clients/{id}
DELETE
/v1/clients/{id}
GET
/v1/clients/with-sites
GET
/v1/clients/{clientId}/sites
POST
/v1/clients/{clientId}/sites
GET
/v1/clients/{clientId}/sites/{id}
PUT
/v1/clients/{clientId}/sites/{id}
DELETE
/v1/clients/{clientId}/sites/{id}
POST
/v1/clients/{clientId}/sites/{id}/restore
GET
/v1/clients/{clientId}/sites/{siteId}/contact-persons
POST
/v1/clients/{clientId}/sites/{siteId}/contact-persons
GET
/v1/clients/{clientId}/sites/{siteId}/contact-persons/{id}
PUT
/v1/clients/{clientId}/sites/{siteId}/contact-persons/{id}
DELETE
/v1/clients/{clientId}/sites/{siteId}/contact-persons/{id}
POST
/v1/clients/{clientId}/sites/{siteId}/contact-persons/{id}/restore
GET
/v1/clients/{clientId}/sites/{siteId}/contact-persons/{contactPersonId}/activities
POST
/v1/clients/{clientId}/sites/{siteId}/contact-persons/{contactPersonId}/activities
GET
/v1/clients/{clientId}/sites/{siteId}/contact-persons/{contactPersonId}/activities/{id}
PUT
/v1/clients/{clientId}/sites/{siteId}/contact-persons/{contactPersonId}/activities/{id}
DELETE
/v1/clients/{clientId}/sites/{siteId}/contact-persons/{contactPersonId}/activities/{id}
GET
/v1/clients/{clientId}/sites/{siteId}/contact-persons/{contactPersonId}/cost-centres
POST
/v1/clients/{clientId}/sites/{siteId}/contact-persons/{contactPersonId}/cost-centres
DELETE
/v1/clients/{clientId}/sites/{siteId}/contact-persons/{contactPersonId}/cost-centres/{id}
GET
/v1/clients/{clientId}/sites/{siteId}/cost-centres
POST
/v1/clients/{clientId}/sites/{siteId}/cost-centres
DELETE
/v1/clients/{clientId}/sites/{siteId}/cost-centres/{id}
GET
/v1/clients/{clientId}/sites/{id}/information
PUT
/v1/clients/{clientId}/sites/{id}/information
GET
/v1/clients/{clientId}/sites/{siteId}/rate-contracts
POST
/v1/clients/{clientId}/sites/{siteId}/rate-contracts
GET
/v1/clients/{clientId}/sites/{siteId}/rate-contracts/{id}
PUT
/v1/clients/{clientId}/sites/{siteId}/rate-contracts/{id}
DELETE
/v1/clients/{clientId}/sites/{siteId}/rate-contracts/{id}
GET
/v1/leads
POST
/v1/leads
GET
/v1/leads/{id}
PUT
/v1/leads/{id}
DELETE
/v1/leads/{id}

Authentication

Section titled “Authentication”

Bearer

Section titled “Bearer”

JWT Authorization header using the bearer scheme

Security scheme type: apiKey

Header parameter name: Authorization