Description
Activities consist of appointments, tasks, issues, and milestones belonging to the logged-in Aspire user. Click activities for more information.
Resource Overview
Overview of available endpoints.
| Endpoint | Definition |
| GET/Activities | Retrieve activity data. |
Attributes
| Attribute | Description | Data Type | Notes |
|---|---|---|---|
| ActivityID | unique identifier for an activity | integer(int32) | |
| ActivityNumber | an identifying number assigned to an activity used to search for a saved activity in Aspire | integer(int32) | |
| ActivityType | an email, task, issue, or milestone in the Aspire system | string | Max Length: 15 |
| CompleteDate | date of activity closure | DateTime | |
| CompletedByUserID | unique identifier of the user who closed out the activity | integer(int32) | |
| CompletedByUserName | full name of the user who completed the activity | string | Max Length: 101 |
| CreatedByUserID | unique identifier of the user who created the activity. | integer(int32) | |
| CreatedByUserName | full name of the user who created the activity | string | Max Length: 101 |
| CreatedDate | activity creation date | DateTime | |
| DueDate | date detailing when an action specified in an email, task, issue, or milestone is expected to be completed. | DateTime | |
| EndDate | date detailing when an action specified in an email, task, issue, or milestone is scheduled to close. | DateTime | |
| IncludeClient | specify whether the primary contact for a client is to receive notification regarding the activity. | boolean | |
| IncludeCrew | specify whether the crew leader(s) associated with an activity will receive a notification once created. | boolean | |
| InvoiceID | unique identifier for invoice | integer(int32) | |
| IsMileStone | target dates related to an opportunity or work order | boolean | |
| Location | physical address related to an activity | string | Max Length: 100 |
| ModifiedDate | date capturing when activity information is updated | DateTime | |
| Notes | additional details added to an activity. | string | Max Length: 2147483647 |
| OpportunityID | unique identifier for an opportunity | integer(int32) | |
| PaymentID | unique identifier for a payment entry | integer(int32) | |
| Priority | assigned order of importance classified as "High," "Normal," or "Low" | string | Max Length: 15 |
| Private | prevent users not assigned to the activity from having visibility | boolean | |
| PropertyID | unique identifier for a property | integer (int32) | |
| SentDate | date user activity type to the recipient | DateTime | |
| StartDate | created start date | DateTime | |
| Status | current state of activity: "Open" or "Completed" | string | Max Length: 15 |
| Subject | title heading of activity | string | Max Length: 200 |
| WorkTicketID | unique identifier for work ticket | integer(int32) |