FEfergus
Notes

GET /notes

Schema for Notes

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
sortField'created_at'
filterEntityIdnumber

The entity id to filter notes by

filterEntityName'JOB' | 'CUSTOMER' | 'CUSTOMER_INVOICE' | 'QUOTE' | 'SITE' | 'TASK' | 'ENQUIRY' | 'JOB_PHASE' required

The entity type to filter notes by (required)

filterCreatedByIdnumber

The user id who created the notes to filter by

Response

Successful Response

resultstring required

Changes

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