GET api/processes/exportcontacts?includeNotes={includeNotes}&includeTags={includeTags}&includeConsents={includeConsents}&includeConsentHistory={includeConsentHistory}&lastTraceId={lastTraceId}&traceDateFrom={traceDateFrom}&traceDateTo={traceDateTo}&limit={limit}

Exports all contacts optionally filtered by any of the arguments specified in the query string.

Request Information

URI Parameters

Name	Description	Type	Additional information
includeNotes	Optional filter to include in the export a collection of Notes related to each Contact.	boolean	Default value is False
includeTags	Optional filter to include in the export a collection of Tags related to each Contact.	boolean	Default value is False
includeConsents	Optional filter to include in the export a collection of Consents related to each Contact.	boolean	Default value is False
includeConsentHistory	Optional filter to include in the export a full collection of Consent history related to each Contact. By default only the current (active) consent (if any) for each contact is exported. This filter is only applicable if includeConsents=true.	boolean	Default value is False
lastTraceId	Optional filter on records that were traced after the provided id.	integer	None.
traceDateFrom	Optional filter on records that were traced from the provided date.	date	None.
traceDateTo	Optional filter on records that were traced up to (inclusive) the provided date.	date	None.
limit	The maximum amount of Contacts that can be returned in any one call. Maximum allowed is 999.	integer	Default value is 100

Body Parameters

None.

Response Information

Resource Description

ContactExportDto

Name	Type	Additional information
Contact	ContactDto	None.
CorrespondenceAddress	ContactAddressDto	None.
ContactNumbers	Collection of ContactContactNumberDto	None.
SubscriptionStatus	ContactSubscriptionStatusDto	None.
CurrentActivityCourse	ActivityCourseDto	None.
Notes	Collection of ContactNoteDto	None.
Tags	Collection of ContactTagDto	None.
Consents	Collection of ContactConsentDto	None.

Response Formats

application/json, text/json

Sample:

{
  "Contact": {
    "Id": 1,
    "StudentId": "sample string 2",
    "SalutationId": 1,
    "SalutationName": "sample string 3",
    "Name": "sample string 4",
    "Surname": "sample string 5",
    "MiddleName": "sample string 6",
    "Alias": "sample string 7",
    "FormerName": "sample string 8",
    "Gender": "A",
    "DateOfBirth": "2024-05-20T09:50:30.8875875+10:00",
    "EmailAddress": "sample string 9",
    "IsPermanentResident": true,
    "CountryOfResidenceId": 1,
    "CountryOfResidenceName": "sample string 11",
    "CountryOfCitizenshipId": 1,
    "CountryOfCitizenshipName": "sample string 12",
    "CountryOfBirthId": 1,
    "CountryOfBirthName": "sample string 13",
    "DateCreated": "2024-05-20T09:50:30.8875875+10:00",
    "DateModified": "2024-05-20T09:50:30.8875875+10:00",
    "HeatStatusId": 1,
    "HeatStatusName": "sample string 14",
    "HeatStatusChangeReason": "sample string 15",
    "SubChannelId": 1,
    "SubChannelName": "sample string 16",
    "ChannelId": 1,
    "ChannelName": "sample string 17",
    "ContactStatusId": 1,
    "ContactStatusName": "sample string 18",
    "ContactStatusChangeReason": "sample string 19",
    "IntakeId": 1,
    "IntakeName": "sample string 20",
    "Inactive": true
  },
  "CorrespondenceAddress": {
    "CrmNumber": 1,
    "AddressTypeId": 2,
    "AddressTypeName": "sample string 3",
    "StreetAddressLine1": "sample string 4",
    "StreetAddressLine2": "sample string 5",
    "StreetAddressLine3": "sample string 6",
    "TownSuburb": "sample string 7",
    "StateCity": "sample string 8",
    "Postcode": "sample string 9",
    "CountryId": 1,
    "CountryName": "sample string 10"
  },
  "ContactNumbers": [
    {
      "CrmNumber": 1,
      "ContactNumberTypeId": 2,
      "ContactNumberTypeName": "sample string 3",
      "CountryCode": "sample string 4",
      "AreaCode": "sample string 5",
      "Number": "sample string 6"
    },
    {
      "CrmNumber": 1,
      "ContactNumberTypeId": 2,
      "ContactNumberTypeName": "sample string 3",
      "CountryCode": "sample string 4",
      "AreaCode": "sample string 5",
      "Number": "sample string 6"
    }
  ],
  "SubscriptionStatus": {
    "CrmNumber": 1,
    "SubscribedToDirectEmails": true,
    "SubscribedToDirectPhoneCalls": true,
    "SubscribedToDirectSms": true
  },
  "CurrentActivityCourse": {
    "Id": 1,
    "ActivityId": 2,
    "DateCreated": "2024-05-20T09:50:30.8875875+10:00",
    "PreferenceNumber": 3,
    "SubChannelId": 4,
    "SubChannelName": "sample string 5",
    "StudyLevelId": 1,
    "StudyLevelName": "sample string 6",
    "FacultyId": 1,
    "FacultyName": "sample string 7",
    "CourseId": 1,
    "CourseName": "sample string 8",
    "DepartmentId": 1,
    "DepartmentName": "sample string 9",
    "CampusId": 1,
    "CampusName": "sample string 10",
    "StudyAreaId": 1,
    "StudyAreaName": "sample string 11"
  },
  "Notes": [
    {
      "Id": 1,
      "CrmNumber": 2,
      "Content": "sample string 3",
      "DateCreated": "2024-05-20T09:50:30.8875875+10:00"
    },
    {
      "Id": 1,
      "CrmNumber": 2,
      "Content": "sample string 3",
      "DateCreated": "2024-05-20T09:50:30.8875875+10:00"
    }
  ],
  "Tags": [
    {
      "Id": 1,
      "CrmNumber": 2,
      "TagId": 3,
      "TagName": "sample string 4",
      "TagTypeId": 5,
      "TagTypeName": "sample string 6",
      "DateCreated": "2024-05-20T09:50:30.8875875+10:00",
      "TagDate": "2024-05-20T09:50:30.8875875+10:00"
    },
    {
      "Id": 1,
      "CrmNumber": 2,
      "TagId": 3,
      "TagName": "sample string 4",
      "TagTypeId": 5,
      "TagTypeName": "sample string 6",
      "DateCreated": "2024-05-20T09:50:30.8875875+10:00",
      "TagDate": "2024-05-20T09:50:30.8875875+10:00"
    }
  ],
  "Consents": [
    {
      "Id": 1,
      "CrmNumber": 2,
      "ConsentTypeId": 3,
      "ConsentTypeName": "sample string 4",
      "DateCreated": "2024-05-20T09:50:30.8875875+10:00",
      "Consent": true
    },
    {
      "Id": 1,
      "CrmNumber": 2,
      "ConsentTypeId": 3,
      "ConsentTypeName": "sample string 4",
      "DateCreated": "2024-05-20T09:50:30.8875875+10:00",
      "Consent": true
    }
  ]
}