Skip to main content

Get a list of notes​

Retrieves a paged collection of notes (required scope notes:read)

Query Parameters
    sortBy NoteSortOptions

    Possible values: [createdAt, dueAt, progressedAt, status, progressPercentage]

    The field to sort items in the page by

    direction SortDirection

    Possible values: [ascending, descending]

    The direction to apply the sort

    id int64[]

    Only return notes where id matches the value(s) provided

    entityType NoteEntityType

    Possible values: [contact, job, stockItem, resource, vehicle, salesOpportunity, contract]

    Only return notes where entityType matches the value provided

    entityId int64[]

    Only return notes where entityId matches the value(s) provided. To use this filter, entityType must also be provided

    typeId int64[]

    Only return notes where typeId matches the value(s) provided

    ownedByUserId int64[]

    Only return notes where ownedByUserId matches the value(s) provided

    reference string[]

    Only return notes where reference matches the value(s) provided

    status NoteStatus[]

    Possible values: [open, completed, cancelled]

    Only return notes where status matches the value(s) provided

    contactId int64[]

    Only return notes where contactId matches the value(s) provided

    dueAtTo date-time

    Only return notes where dueAt occurs at or before the UTC timestamp provided

    dueAtFrom date-time

    Only return notes where dueAt occurs at or after the UTC timestamp provided

    createdAtFrom date-time

    Only return notes where createdAt is the same or newer than this UTC value

    createdAtTo date-time

    Only return notes where createdAt is the same or older than this UTC value

    pageNumber int32

    Possible values: >= 1 and <= 2147483

    The page number being requested (minimum: 1, maximum: 2147483)

    pageSize int32

    Possible values: >= 1 and <= 1000

    The page size being requested (minimum: 1, maximum: 1000)

Header Parameters
    Customer-Id int64 required

    The customer identifier

Responses

Success

Schema
    items object[]

    The items returned for the requested page

  • Array [
    • id int64

    The unique identifier of the note

    entityType NoteEntityType

    Possible values: [contact, job, stockItem, resource, vehicle, salesOpportunity, contract]

    The type of entity that the note is associated to

    Possible values:

    • contact: Associated with a contact entity
    • job: Associated with a job entity
    • stockItem: Associated with a stock item entity
    • resource: Associated with a resource entity
    • vehicle: Associated with a vehicle entity
    • salesOpportunity: Associated with a sales opportunity entity
    • contract: Associated with a contract entity

    entityId int64

    The unique identifier of the associated entity that owns the note, relative to the entityType

    contactId int64 nullable

    The unique identifier of the contact associated to this note

    typeId int64

    The unique identifier of the note type definition associated to this note

    createdAt date-time

    The UTC timestamp of when this note was created

    subject string

    The subject of the note

    parentId int64 nullable

    The unique identifier of the parent note of this note

    dueAt date-time nullable

    The UTC timestamp of when this note is due for completion

    progressedAt date-time nullable

    The UTC timestamp of when this note was last progressed

    reference string

    The internal reference of the note - should usually be unique

    status NoteStatus

    Possible values: [open, completed, cancelled]

    The status of the note

    Possible values:

    • open: Open
    • completed: Completed
    • cancelled: Cancelled

    description string

    The detailed textual content about the note

    completionText string nullable

    A textual note that can be added when a note has been completed. Can only be set if the note has a completed status

    progressPercentage int32

    The percentage of work done required to complete the note

    createdByUserName string

    The name of the user who owns the note

    ownedByUserId int64

    The unique id of the user who owns the note

    ownedByUserName string

    The name of the user who owns the note

    customFields object[]

    The collection of custom fields applied to this note

  • Array [
    • definitionId int64

    The unique identifier of the associated custom field definition

    value string nullable

    The current value set for the custom field

    definition object

    Represents the definition of a custom field

    caption string

    The caption of a custom field

    type CustomFieldType

    Possible values: [boolean, integer, decimal, text, list, statement, date, note, time, systemList]

    The type of the custom field. New field types may be added in the future, so integrations should be resilient to this

    Possible values:

    • boolean: Indicates a boolean field (Example: "false")
    • integer: Indicates an integer numeric field (Example: "1001")
    • decimal: Indicates a floating point numeric field (Example: "1.42")
    • text: Indicates an editable text field (Example: "Purple")
    • list: Indicates a field with a single value from a predefined list of options (Example: "Purple")
    • statement: Indicates a text field that cannot be edited. The value is always equal to the default value (Example: "By signing this you agree to the following...")
    • date: Indicates a date field, which will be represented as an RFC3339 formatted date string. The default value is not supported for this type and will always be null (Example: "2024-01-31")
    • note: Indicates a multiline, editable text field. Lines are seperated with a line feed character (Example: "This is a note.")
    • time: Indicates a time field, formatted as HH:mm. The default value is not supported for this type and will always be null (Example: "10:30")
    • systemList: Indicates the ID of a related resource, vehicle or web user (Example: "228007")

    listOptions string[] nullable

    Shows the possible values for a list type custom field. Value will be null if type is not list

    isRequired boolean

    Indicates if the field is required in the UI. This is NOT enforced in the API

    isEditable boolean

    Indicates if the field is editable

    default string nullable

    The default value of a custom field. Formatted in accordance with the rules of the field type

    systemListValueMetadata object

    Represents details of custom field value of type system list

    label string nullable

    A descriptive label for the specific resource, vehicle or web user that this system list value relates to

    entityType CustomFieldSystemListType

    Possible values: [resource, vehicle, webUser]

    The type of entity used for custom field value of type system list

    Possible values:

    • resource
    • vehicle
    • webUser

  • ]
  • ]
    • pageNumber int32

    The page number of the response where 1 is the first page

    pageSize int32

    The number of items requested for the current page

    pageItemCount int32

    The number of items returned in the current page

Loading...