FEfergus
Jobs

GET /jobs

Returns a list of jobs. The list can be filtered by job type.

Request

  • Base URL
    https://api.fergus.com
  • Auth
    • OAuth 2
      Authorization codehttps://auth.fergus.com/oauth2/authorize
      Token URLhttps://auth.fergus.com/oauth2/token
    • or HTTP bearer
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

pageSizeinteger
'asc'
OR
'desc'
pageCursorstring
filterJobNostring
'Active'
OR
'Completed'
OR
'Estimate Rejected'
OR
'Estimate Sent'
OR
'Inactive'
OR
'Quote Sent'
OR
'Quote Rejected'
OR
'To Price'
'Quote'
OR
'Estimate'
OR
'Charge Up'
filterCustomerIdnumber
filterSiteIdnumber
'jobNo'
OR
'createdAt'
OR
'lastModified'
filterShowOnHoldboolean
filterShowArchivedboolean
filterSearchTextstring

Searchable fields:

  • description
  • longDescription
  • jobNo
  • customer.customerFullName
  • siteAddress.name
  • siteAddress.firstName
  • siteAddress.lastName
  • mainContact.firstName
  • mainContact.lastName

Response

Successful Response

resultstring required

Changes

No recorded changes to this operation across all 18 revisions of this API.