GET /jobs

Retrieve a list of jobs based on search criteria or details for a specific job.

Query parameters

  • query string

    Search term for filtering jobs.

  • companyID integer Required

    Company identifier for filtering jobs.

Responses

  • 200 application/json

    A list of jobs or the details of a specific job.

    Hide response attributes Show response attributes object
    • jobID integer
    • jobTitle string
    • jobDescription string
    • scheduleLater boolean
    • Rrule string
    • companyID integer
    • propertyID integer
    • jobStatusID integer
    • clientID integer
    • jobTypeID integer
    • createdBy integer
    • updatedBy integer
  • 400

    Invalid data provided.

  • 500

    An error occurred while processing the request.

GET /jobs 
curl \
 -X GET http://api.example.com/jobs?companyID=42
Response examples (200) 
[
  {
    "jobID": 42,
    "jobTitle": "string",
    "jobDescription": "string",
    "scheduleLater": true,
    "Rrule": "string",
    "companyID": 42,
    "propertyID": 42,
    "jobStatusID": 42,
    "clientID": 42,
    "jobTypeID": 42,
    "createdBy": 42,
    "updatedBy": 42
  }
]