GET api/contacts/{id}/contactnotes?offset={offset}&limit={limit}&returnTotal={returnTotal}

Get all ContactNotes that are related to the supplied Contact id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The primary key of the Contact record.

integer

Required

offset

The position in the collection of ContactNotes from which to start returning data from.

integer

Default value is 0

limit

The maximum amount of ContactNotes that can be returned in any one call. Maximum allowed is 500.

integer

Default value is 50

returnTotal

Whether to include the total amount of ContactNotes in the database that match the filter specified.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

ContactNoteDto
NameDescriptionTypeAdditional information
Id

The primary key of the record in the Hobsons database. Ignored for POST requests sent to the API.

integer

None.

CrmNumber

The identifier of the Contact associated with the given record.

integer

Required

Range: inclusive between 1 and 2147483647

Content

The content of the note.

string

Required

String length: inclusive between 0 and 4000

DateCreated

The date the record was created in the Hobsons database. Ignored for PUT and POST requests sent to the API.

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "CrmNumber": 2,
  "Content": "sample string 3",
  "DateCreated": "2024-05-20T11:54:31.7082728+10:00"
}