This method returns information related with activities. Multiple activities are returned by each call
Resource URL
Parameters
Name | Type | Description | |||||||||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||||||||
| activity_type_identifier (semi-optional) | Activity type identifier | The identifier of the activity type. The allowed activity type identifier fields are the following:
| |||||||||||||||||||||
| contact_information_identifier (semi-optional) | Contact information identifier | The identifier of the contact information related with the account that will be returned as results. The allowed contact information identifier fields are the following:
| |||||||||||||||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call Available from CRM.COM R13.0.0 | |||||||||||||||||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number Available from CRM.COM R13.0.0 | |||||||||||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved activity |
number | String | The number of the retrieved activity |
| description | String | The description of the retrieved activity |
| notes | String | The notes of the retrieved activity |
life_cycle_state | String | The life cycle state of the retrieved activity which can be PENDING, IN PROGRESS, COMPLETED, CANCELLED |
| start_date | Date | The date that the activity is created |
| expected_completion_date | Date | The date that the activity is expected to be completed |
| actual_completed_date | Date | The date that the activity is actually completed |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
| udf_string_9 | String | User Defined Field of type String |
| udf_string_10 | String | User Defined Field of type String |
| udf_string_11 | String | User Defined Field of type String |
| udf_string_12 | String | User Defined Field of type String |
| udf_string_13 | String | User Defined Field of type String |
| udf_string_14 | String | User Defined Field of type String |
| udf_string_15 | String | User Defined Field of type String |
| udf_string_16 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
| udf_float_5 | Float | User Defined Field of type Float |
| udf_float_6 | Float | User Defined Field of type Float |
| udf_float_7 | Float | User Defined Field of type Float |
| udf_float_8 | Float | User Defined Field of type Float |
| udf_float_9 | Float | User Defined Field of type Float |
| udf_float_10 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
udf_date_5 | Date | User Defined Field of type Date |
udf_date_6 | Date | User Defined Field of type Date |
udf_date_7 | Date | User Defined Field of type Date |
udf_date_8 | Date | User Defined Field of type Date |
udf_date_9 | Date | User Defined Field of type Date |
udf_date_10 | Date | User Defined Field of type Date |
| assigned_to | Assign Object | The assignment information of the retrieved activity |
| type | Activity type object | The type information of the retrieved activity |
| status | Activity Status object | The status information of the retrieved activity |
| category | Activity Category object | The categories information of the retrieved activity |
| estimated_completion_time | Time Period Object | The time that is estimated to complete the activity, measured in MINUTES, HOURS, DAYS, WEEKS, YEARS From CRM.COM R17.0.0, YEARS is deprecated |
| time_to_completion | Time Period Object | The time that is left up to the expected completion date |
| time_overdue | Time Period Object | The time past the expected completion date |
| performed_for | Performed for object | The entities which are related with the activity and can include Subscriptions, Jobs |
Contact Information object | The contact information related with the specified activity | |
| cancellation_reason | Activities Cancellation Object | The reason that the activity was cancelled. This is applicable only if the activity is on a cancelled life cycle state |
| owned_by_group | Group object | The group that is owning the activity Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit) |
| owned_by_business_unit | Business Unit Object | The business unit that is owning the activity Available from CRM.COM R18.0.0 |
| privacy_level | Privacy level object | The activity privacy level Deprecated from CRM.COM R18.0.0 |
Log Information Object | The log information related with the retrieved activity | |
| services_to_be_provided_set | Services to be Provided object | The services that will be provided as part of the activity and the time that was spend on each one, measured in minutes, hours, days, weeks, months and years. |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"notes": null,
"udf_string_10": null,
"udf_string_11": null,
"udf_string_12": null,
"udf_date_10": null,
"udf_string_13": null,
"number": "3",
"udf_string_14": null,
"performed_for":
{
"service_request": null,
"subscription":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Xenofontos ",
"life_cycle_state": "FINANCIAL",
"middle_name": "Iatrou",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Kyriacos",
"name": "Kyriacos Xenofontos",
"id": "31260911295E70BB660EBEB0C4F941AC",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country":
{
"name": "BAHRAIN",
"id": "144"
},
"passport_number": "3463463",
"social_security_number": "73473567",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector": null,
"date_of_birth":
{
"month": 5,
"day": 6,
"year": 1988
},
"name_day":
{
"month": 5,
"day": 3
},
"id_number": "87878000",
"id_issued_by_country":
{
"name": "AZERBAIJAN",
"id": "142"
},
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "195",
"name": "Xenofontos",
"id": "5B51429862A7BCBAD60CC81982BBD45B"
},
"life_cycle_state": "EFFECTIVE",
"number": "S60142",
"type":
{
"name": "United Kingdom",
"id": "1C81FBB1E5D90040F440ECE98D6A368D",
"description": "For subscribers residing in United Kingdom",
"alternative_code": "UK"
},
"id": "253A818FECCA1D1B212703FEE056C8EA"
},
"job": null
},
"udf_string_15": null,
"assign_to":
{
"unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Marketing Unit",
"id": "83922FE923563679768A94F58CAB5569",
"description": "r1c1",
"alternative_code": null
},
"user":
{
"person_name": "eleniTemplate",
"username": "eleniTemplate",
"id": "771CD3A923E7BEED3055E109E4F676DC",
"email": null
}
},
"udf_string_1": null,
"udf_string_16": null,
"udf_string_2": null,
"privacy_level":
{
"number": "000004",
"hierarchy_level": 1,
"name": "To be deleted 3",
"id": "106A9C633A7851071709513CD15B491B"
},
"contact_information":
{
"last_name": "Xenofontos ",
"life_cycle_state": "FINANCIAL",
"middle_name": "Iatrou",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Kyriacos",
"name": "Kyriacos Xenofontos",
"id": "31260911295E70BB660EBEB0C4F941AC",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country":
{
"name": "BAHRAIN",
"id": "144"
},
"passport_number": "3463463",
"social_security_number": "73473567",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector": null,
"date_of_birth":
{
"month": 5,
"day": 6,
"year": 1988
},
"name_day":
{
"month": 5,
"day": 3
},
"id_number": "87878000",
"id_issued_by_country":
{
"name": "AZERBAIJAN",
"id": "142"
},
"industry": null
}
},
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null,
"id": "B3409C01A4E13BF3DA8BF809678138FA",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"expected_completion_date": "2014-07-29T00:00:00",
"udf_date_4": null,
"start_date": "2014-07-15T00:00:00",
"udf_date_5": null,
"udf_date_6": null,
"udf_date_7": null,
"time_to_completion":
{
"time_period_value": null,
"time_period_uot": "WEEKS"
},
"time_overdue":
{
"time_period_value": null,
"time_period_uot": null
},
"udf_date_8": null,
"udf_date_9": null,
"owned_by_group":
{
"community_name": "Main Community",
"name": "Main Group",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"description": "Main Group",
"alternative_code": "das"
},
"log_information":
{
"updated_date": "2014-07-15T11:59:25",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-07-15T09:38:51",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
}
},
"status":
{
"name": "Closed",
"id": "2",
"description": "Completed",
"alternative_code": "CL"
},
"actual_completed_date": "2014-07-15T11:45:50",
"life_cycle_state": "COMPLETED",
"estimate_completion_time":
{
"time_period_value": 2,
"time_period_uot": "WEEKS"
},
"type":
{
"name": "ActivityType1",
"id": "0EAC36C3C860ED01C2A18E82661570F0",
"description": null,
"alternative_code": "asdasaSA"
},
"description": null,
"category":
{
"name": "name 1",
"id": "E037ECCED154220494E1466B9C792A99",
"description": "desc 1",
"code": "code 1"
},
"services_to_be_provided_set":
[
{
"service":
{
"product_type":
{
"physical_good_type": null,
"service_type": "ONETIME",
"used_for_provisioning": false,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "One-off fee",
"id": "EBD643D9FE1401217E7D3328F85FBB20",
"description": "One-off fee",
"alternative_code": "OOF"
},
"id": "7705DF97FBB8A7639A97BBD918A09D85",
"description": "FEE10",
"code": "FEE10",
"alternative_code": null
},
"id": "06DCFE8041C971C793C58607C36CA4C7",
"time_spend":
{
"time_period_value": 5,
"time_period_uot": "HOURS"
}
},
{
"service":
{
"product_type":
{
"physical_good_type": null,
"service_type": "ONETIME",
"used_for_provisioning": false,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "One-off fee",
"id": "EBD643D9FE1401217E7D3328F85FBB20",
"description": "One-off fee",
"alternative_code": "OOF"
},
"id": "3E0AE236D75C3C5EFCCF56A4BE9322BB",
"description": "FEE2",
"code": "FEE2",
"alternative_code": "FEE2"
},
"id": "C231537428878CB0E6AF93C8A94F01C1",
"time_spend":
{
"time_period_value": 100,
"time_period_uot": "HOURS"
}
},
{
"service":
{
"product_type":
{
"physical_good_type": null,
"service_type": "ONETIME",
"used_for_provisioning": false,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "One-off fee",
"id": "EBD643D9FE1401217E7D3328F85FBB20",
"description": "One-off fee",
"alternative_code": "OOF"
},
"id": "A000839A81878B6B9B8FC475F1F44199",
"description": "FEE1",
"code": "FEE1",
"alternative_code": "FEE1"
},
"id": "CE8BFB8843FFF83F61D78BCF7F60351E",
"time_spend":
{
"time_period_value": 2,
"time_period_uot": "DAYS"
}
}
]
},
{
"notes": null,
"udf_string_10": null,
"udf_string_11": null,
"udf_string_12": null,
"udf_date_10": null,
"udf_string_13": null,
"number": "5",
"udf_string_14": null,
"performed_for":
{
"service_request": null,
"subscription": null,
"job": null
},
"udf_string_15": null,
"assign_to":
{
"unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "test555",
"id": "94016E390E900729C45ECD564E309181",
"description": null,
"alternative_code": "4444"
},
"user": null
},
"udf_string_1": null,
"udf_string_16": null,
"udf_string_2": null,
"privacy_level": null,
"contact_information":
{
"last_name": "Xenofontos ",
"life_cycle_state": "FINANCIAL",
"middle_name": "Iatrou",
"company_profile": null,
"title": "Mr",
"type": "PERSON",
"first_name": "Kyriacos",
"name": "Kyriacos Xenofontos",
"id": "31260911295E70BB660EBEB0C4F941AC",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country":
{
"name": "BAHRAIN",
"id": "144"
},
"passport_number": "3463463",
"social_security_number": "73473567",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector": null,
"date_of_birth":
{
"month": 5,
"day": 6,
"year": 1988
},
"name_day":
{
"month": 5,
"day": 3
},
"id_number": "87878000",
"id_issued_by_country":
{
"name": "AZERBAIJAN",
"id": "142"
},
"industry": null
}
},
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null,
"id": "11C8884D199519F1EE6AD42F44C713E4",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"expected_completion_date": "2014-07-15T15:16:00",
"udf_date_4": null,
"start_date": "2014-07-15T15:13:57",
"udf_date_5": null,
"udf_date_6": null,
"udf_date_7": null,
"time_to_completion":
{
"time_period_value": null,
"time_period_uot": "SECONDS"
},
"time_overdue":
{
"time_period_value": null,
"time_period_uot": null
},
"udf_date_8": null,
"udf_date_9": null,
"owned_by_group":
{
"community_name": "Main Community",
"name": "Main Group",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"description": "Main Group",
"alternative_code": "das"
},
"log_information":
{
"updated_date": "2014-07-15T15:22:04",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-07-15T15:13:57",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "mp@ministrator.com"
}
},
"status":
{
"name": "Closed",
"id": "2",
"description": "Completed",
"alternative_code": "CL"
},
"actual_completed_date": "2014-07-15T15:22:00",
"life_cycle_state": "COMPLETED",
"estimate_completion_time":
{
"time_period_value": 123,
"time_period_uot": "SECONDS"
},
"type":
{
"name": "Activity Type 1",
"id": "AF4D27993257C5242E7CAD6F35566222",
"description": "testyoiniokjuiiju",
"alternative_code": "ACT11"
},
"description": null,
"category":
{
"name": "name 2",
"id": "73EE48F5950613300C48B806FCCCFB2E",
"description": "desc 2",
"code": "code 2"
},
"services_to_be_provided_set":
[
]
},......
}