Piloty API
  • Introduction
  • 🔓Authentication
  • 🔭Scopes and Roles
  • ⏲️Rate limits
  • 📂Pagination
  • ⁉️Errors and Status
  • 🏢COMPANIES API
    • Companies
      • GET : Companies by media
      • GET : Retrieve Company
      • POST : Create company
      • PATCH : Update company
    • Company 's fields
      • GET : List Sectors
      • GET : List Sizes
  • 💼JOBS API
    • Jobs
      • GET : Jobs by media
      • GET : Retrieve job
      • GET : Jobs opened by media
      • GET : Retrieve job opened
      • POST : Create job
      • PATCH : Update job
    • Job's fields
      • GET : List Contracts
      • GET : List Experiences
      • GET : List Educations
      • GET : List Remote policies
      • GET : List Worktimes
      • GET : List Job Categories
  • 👤USERS API
    • Users
      • GET : Users by media
  • 🧑‍💼CANDIDATES API
    • Candidates
      • GET : User candidates by media
      • GET : Job alerts
      • GET : Favoris
    • Opportunities
      • POST : Job applications - v2
      • GET : Job applications
      • 🛑Deprecated - POST : Job applications - v1
  • 📕Changelog
Powered by GitBook
On this page
  • Status Codes
  • Error Messages

Errors and Status

Error messages are formatted like so:

{
    "status": <Status Code>,
    "error": <Error Message>,
}

Status Codes

Piloty API uses the following HTTP status codes

Status Code
Meaning

400

Bad Request

Your request is invalid

401

Unauthorized

Your OAuth access_token is wrong

403

Forbidden

Your not allowed to access this resource

404

Not Found

Resource could not be found

405

Method Not Allowed

You tried to use an endpoint with an invalid method

409

Conflict A conflict occurred when creating or updating a resource

410

Gone Resource could not be accessed

500

Internal Server Error

We had a problem with our server. Try again later.

503

Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Error Messages

Piloty API uses the following error messages:

Error message
Meaning

missing-xxxx

Field is required but missing

xxxx-must-be-xxxx xxxx-format-error

Field is not formatted correctly

xxxx-not-found xxxx-does-n-t-exist

Requested resource could not be found

empty-limitation

The access_token does not have access to any resource

unauthorized-limitation

The access_token does not have access to the requested resource

PreviousPaginationNextCompanies

Last updated 2 months ago

⁉️