GET api/activities?crmNumber={crmNumber}&dateCreatedFrom={dateCreatedFrom}&dateCreatedTo={dateCreatedTo}&offset={offset}&limit={limit}&returnTotal={returnTotal}

Get all Activities optionally filtered by any of the arguments specified in the query string.

Request Information

URI Parameters

Name	Description	Type	Additional information
crmNumber	Optional filter on Activityies that are associated with the Contact Id that matches the provided value.	integer	None.
dateCreatedFrom	Optional filter on Activities that were created on a date from the provided value.	date	None.
dateCreatedTo	Optional filter on Activities that were created on a date up to (inclusive) the provided value.	date	None.
offset	The position in the collection of Activities from which to start returning data from.	integer	Default value is 0
limit	The maximum amount of Activities that can be returned in any one call. Maximum allowed is 500.	integer	Default value is 100
returnTotal	Whether to include the total amount of Activities in the database that match the filter specified.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

ActivityDto

Name	Description	Type	Additional information
Id	The primary key of the record in the Hobsons database. Ignored for POST requests sent to the API.	integer	None.
CrmNumber	A reference to the primary key of the Contact record that is associated with this record.	integer	Required Range: inclusive between 1 and 2147483647
ContactStatusId	A reference to the primary key of the ContactStatus record that is associated with this record. For POST requests sent to the API if this value is not provided it will be set to the Default ContactStatus record.	integer	Range: inclusive between 1 and 99999999
ContactStatusName	The name of the ContactStatus record that is associated with this record. Ignored for POST requests sent to the API.	string	None.
IntakeId	A reference to the primary key of the Intake record that is associated with this record. For POST requests sent to the API if this value is not provided it will be set to the Default Intake record.	integer	Range: inclusive between 1 and 99999999
IntakeName	The name of the Intake record that is associated with this record. Ignored for POST requests sent to the API.	string	None.
DateCreated	The date that the Activity record was created (in the Hobsons database). Ignored for POST requests sent to the API.	date	None.
Task	The details of the Task record created that it's associated with this record. Used ONLY for POST requests sent to the API. For GET requests always returned as NULL.	InnerTaskDto	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "CrmNumber": 2,
  "ContactStatusId": 1,
  "ContactStatusName": "sample string 3",
  "IntakeId": 1,
  "IntakeName": "sample string 4",
  "DateCreated": "2024-05-20T12:28:34.9925242+10:00",
  "Task": {
    "TaskTypeId": 1,
    "Description": "sample string 2"
  }
}