Skip to main content

​
Getting your API key

1

Contact Pylote

Send an email to hello@pylote.io stating your company and your use case (direct integration, distribution via platform, CRM integrator, etc.).
2

Sign the partnership agreement

Pylote sends you the API partnership agreement. Signing it constitutes acceptance of the legal terms (tracking, GDPR, confidentiality).
3

Receive your key

Once the agreement is signed, Pylote emails you your API key. You can start integrating right away.
While waiting for your key, you can already test the API via the sandbox
  • no key required.

​
API key

The API uses an API key to identify requests. Include it in the x-api-key header of every request: 
curl -X GET "https://client-p.pylote.io/freelances?modifiedTime=0&page=1&limit=50" \
  -H "x-api-key: your-api-key"

​
Access levels

Your API key determines your access level:
TypeAccessible endpointsExamples
ClientGET /freelances, POST /freelances, GET /freelances/deleted-freelancesComet, RecruitCRM
IntegratorAll Client + /integration/*BoondManager
Partner/partners/whitelist + /partners/eventsAgrega
AdminAll Client + cache refresh, debugPylote internal

​
Authentication errors

{
  "statusCode": 401,
  "message": "Missing x-api-key header"
}

{
  "statusCode": 403,
  "message": "Invalid API key"
}

​
Security and responsibility

The API key is personal, non-transferable and may not be shared with third parties. Any use of the API key, including fraudulent use, is deemed to be carried out under your responsibility.
In the event of a confirmed or suspected compromise of your API key:
  1. Immediately notify Pylote at support@pylote.io
  2. Pylote will revoke the compromised key and provide you with a new one
  3. Any use between the compromise and the notification remains under your responsibility
Pylote reserves the right to suspend or revoke the API key in the event of a breach of any of your contractual obligations.