GET organisation_units/groups/list
- Joseph Ioannou (Unlicensed)
- Evangelos Papadopoulos
Available from CRM.COM R14.9.0 and CRM.COM R15.3.0
Deprecated from CRM.COM R18.0.0 (replaced with /wiki/spaces/V4Development/pages/491357)
This method returns information related with groups. Multiple groups are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
community_identifier (optional) | Community Identifier | The identifier of the community related with the group that will be returned as results. The allowed community identifier fields are the following:
| ||||||||||||
classification (optional) | String | Defines whether the group is a partner group or not. The supported values are INTERNAL and PARTNER | ||||||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call | ||||||||||||
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 | ||||||||||||
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 group |
name | String | The name of the retrieved group |
alternative_code | String | The alternative code of the retrieved group |
unified_code | String | The unified code of the retrieved group Available from CRM.COM R16.2.2 |
number | String | The number of the retrieved group |
description | String | The description of the retrieved group |
classification | String | The classification of the retrieved group, which can be INTERNAL or PARTNER |
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_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_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 |
Accounts Receivable Object | The accounts receivable that is related with the retrieved group. Applicable only if the group is partner and the accounts receivable will be applied on the group level | |
Community Object | The community that the group belongs to | |
Set of Units Object | The units that belongs to the retrieved group | |
Log Information Object | The log information related with the retrieved group |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
company_name | Sting | The company name of the retrieved contact information |
Demographics Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
Name | Type | Description |
gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
passport_number | String | The passport number of the retrieved contact information |
passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
Name | Type | Description |
---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
number_of_employees | Number | The number of employees of the retrieved contact information |
registration_number | String | The registration number of the retrieved contact information |
vat_registration_number | String | The vat registration number of the retrieved contact information |
vat_registered_by | String | The vat registration by of the retrieved contact information |
vat_registration_date | Date | The vat registration date of the retrieved contact information |
tax_reference_number | String | The tax referenece number of the retrieved contact information |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
alternative_code | String | The alternative code of the retrieved country |
dialing_code | String | The dialing code of the retrieved country Available from CRM.COM R15.1.0 |
two_character_code | String | The two character code of the retrieved country |
three_character_code | String | The three character code of the retrieved country |
country_flag | Image Object | The flag of the retrieved country Available from CRM.COM R15.1.0 |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved country flag |
file | File Object | The information of the attached file |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
file_name | String | The name of the file |
file_content_url | String | The url that can be used to access the actual content of the file |
file_mime_type | String | The mime type of the attached file |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved community |
name | String | The name of the retrieved community |
alternative_code | String | The alternative code of the retrieved community |
description | String | The description of the retrieved community |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0 | |
User Object | The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled | |
Unit Object | The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0 | |
Unit Object | The last unit that updated the retrieved record Available from CRM.COM R18.0.0 | |
User Object | The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
code | String | The code of the retrieved business unit |
unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
String | The email of the retrieved user |
Examples
HTTP Method: GET
Request::
Response:
{ "data": [ { "alternative_code": "Group2__9442", "log_information": { "created_by_unit": { "alternative_code": "adminunit", "group_name": "Main Group", "community_name": "Community", "name": "Admin Unit", "description": "admin unit", "id": "1" }, "updated_by_unit": { "alternative_code": "adminunit", "group_name": "Main Group", "community_name": "Community", "name": "Admin Unit", "description": "admin unit", "id": "1" }, "created_date": "2018-07-12T17:54:48", "updated_date": "2018-11-01T11:20:13", "updated_by_user": { "person_name": "CRM COM", "id": "1", "email": "test@crm.com", "username": "MPAdministrator" }, "created_by_user": { "person_name": "CRM COM", "id": "1", "email": "test@crm.com", "username": "MPAdministrator" } }, "description": null, "udf_date_2": null, "udf_date_1": null, "udf_date_4": null, "udf_date_3": null, "number": "147", "udf_float_3": null, "udf_float_4": null, "id": "BFF7D270855C4B61943E9B5D500BCF27", "udf_float_1": null, "udf_float_2": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_1": null, "accounts_receivable": null, "classification": "PARTNER", "community": { "alternative_code": "Communite2_9442", "name": "Communite2_9442", "description": null, "id": "02604BE8338F4CC0B1369F4010D17808" }, "name": "Group2__9442", "units_set": [], "udf_string_6": null, "udf_string_7": null, "udf_string_8": null }, { "alternative_code": "Group9442_D", "log_information": { "created_by_unit": { "alternative_code": "adminunit", "group_name": "Main Group", "community_name": "Community", "name": "Admin Unit", "description": "admin unit", "id": "1" }, "updated_by_unit": { "alternative_code": "adminunit", "group_name": "Main Group", "community_name": "Community", "name": "Admin Unit", "description": "admin unit", "id": "1" }, "created_date": "2018-07-13T11:39:18", "updated_date": "2018-07-13T11:39:29", "updated_by_user": { "person_name": "CRM COM", "id": "1", "email": "test@crm.com", "username": "MPAdministrator" }, "created_by_user": { "person_name": "CRM COM", "id": "1", "email": "test@crm.com", "username": "MPAdministrator" } }, "description": null, "udf_date_2": null, "udf_date_1": null, "udf_date_4": null, "udf_date_3": null, "number": "160", "udf_float_3": null, "udf_float_4": null, "id": "460B3800CEEE48C3B7333BE9DD83B4CC", "udf_float_1": null, "udf_float_2": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_1": null, "accounts_receivable": { "number": "ACR0000002213", "name": "ACR0000002213 Group9442_D", "id": "CD5FFADA4626469C86A37674A183CF2F", "life_cycle_state": "ACTIVE", "account_owner": { "company_profile": { "tax_reference_number": null, "registered_in_country": { "alternative_code": "CY", "three_character_code": null, "name": "Cyprus", "id": "5BC0", "two_character_code": "CC" }, "number_of_employees": null, "annual_turnover": null, "profile_year": null, "registration_number": null, "vat_registration_number": null, "industry_sector": null, "industry": null, "established_date": null, "vat_registered_by": null, "vat_registration_date": null }, "company_name": "Group9442_D", "name": null, "last_name": null, "id": "2681E2F6CAE7488EB3C04550A676B48C", "life_cycle_state": "FINANCIAL", "middle_name": null, "title": null, "type": "COMPANY", "first_name": null, "demographics": null } }, "classification": "PARTNER", "community": { "alternative_code": "CommunityA_9442", "name": "CommunityA_9442", "description": null, "id": "9451A29BCB15406CB218CA3A4D627E11" }, "name": "Group9442_D", "units_set": [], "udf_string_6": null, "udf_string_7": null, "udf_string_8": null }, { "alternative_code": "G_1", "log_information": { "created_by_unit": { "alternative_code": "adminunit", "group_name": "Main Group", "community_name": "Community", "name": "Admin Unit", "description": "admin unit", "id": "1" }, "updated_by_unit": { "alternative_code": "adminunit", "group_name": "Main Group", "community_name": "Community", "name": "Admin Unit", "description": "admin unit", "id": "1" }, "created_date": "2016-02-10T15:00:46", "updated_date": "2016-02-10T15:01:00", "updated_by_user": { "person_name": "michael may", "id": "969C508EE99B478EB34570A3BD9BBC13", "email": null, "username": "mmay" }, "created_by_user": { "person_name": "michael may", "id": "969C508EE99B478EB34570A3BD9BBC13", "email": null, "username": "mmay" } }, "description": null, "udf_date_2": null, "udf_date_1": null, "udf_date_4": null, "udf_date_3": null, "number": "19", "udf_float_3": null, "udf_float_4": null, "id": "C143A6A4FAEA4B058CC9E66F5134BD78", "udf_float_1": null, "udf_float_2": null, "udf_string_2": null, "udf_string_3": null, "udf_string_4": null, "udf_string_5": null, "udf_string_1": null, "accounts_receivable": null, "classification": "PARTNER", "community": { "alternative_code": "C_2", "name": "CommunityB", "description": null, "id": "46D9FC6FD87E45439A1D26400B0DF47C" }, "name": "GroupB", "units_set": [ { "alternative_code": "U_1", "group_name": "GroupB", "community_name": "CommunityB", "name": "Unit B", "description": null, "id": "5E79D05A7D8148AB86747C228A01425E" }, { "alternative_code": "awfawf", "group_name": "GroupB", "community_name": "CommunityB", "name": "angelosTest", "description": "awfawfawf", "id": "93BE42D7C7FC49A8A751C1AC1D571FB6" } ], "udf_string_6": null, "udf_string_7": null, "udf_string_8": null } ], "status": { "code": "OK", "description": "", "message": "" } }
HTTP Method: GET
Request::
Response:
{ "data": [ { "alternative_code": "A_1", "name": "Airlink", "accounts_receivable": null, "units_set": [] }, { "alternative_code": "AT", "name": "Airlink test", "accounts_receivable": { "number": "ACR0000002868", "name": "ACR0000002868 Airlink test", "id": "B9EE4061D8D14F24B52EFD9448133E57", "life_cycle_state": "ACTIVE", "account_owner": { "company_profile": { "tax_reference_number": null, "registered_in_country": null, "number_of_employees": null, "annual_turnover": null, "profile_year": null, "registration_number": null, "vat_registration_number": null, "industry_sector": null, "industry": null, "established_date": null, "vat_registered_by": null, "vat_registration_date": null }, "company_name": "Airlink test", "name": null, "last_name": null, "id": "9FF250DE7F214B2BAB71CE73508A7251", "life_cycle_state": "FINANCIAL", "middle_name": null, "title": null, "type": "COMPANY", "first_name": null, "demographics": null } }, "units_set": [] }, { "alternative_code": "C", "name": "CVB", "accounts_receivable": null, "units_set": [] }, { "alternative_code": "ET", "name": "Erik Tooty", "accounts_receivable": { "number": "ACR0000002563", "name": "ACR0000002563 Erik Tooty", "id": "3C94531CE88844C09DA51DFA45586196", "life_cycle_state": "ACTIVE", "account_owner": { "company_profile": { "tax_reference_number": null, "registered_in_country": { "alternative_code": "CY", "three_character_code": null, "name": "Cyprus", "id": "5BC0", "two_character_code": "CC" }, "number_of_employees": null, "annual_turnover": null, "profile_year": null, "registration_number": null, "vat_registration_number": null, "industry_sector": null, "industry": null, "established_date": null, "vat_registered_by": null, "vat_registration_date": null }, "company_name": "Erik Tooty", "name": null, "last_name": null, "id": "33235CAB7880441385B4C780D98E592D", "life_cycle_state": "FINANCIAL", "middle_name": null, "title": null, "type": "COMPANY", "first_name": null, "demographics": null } }, "units_set": [ { "alternative_code": "P", "group_name": "Erik Tooty", "community_name": "CommunityB", "name": "Unit 311", "description": null, "id": "B19BF67015BE4B3FAD2F8A1BAF1C9047" } ] }, { "alternative_code": "G_1", "name": "GroupB", "accounts_receivable": null, "units_set": [ { "alternative_code": "awfawf", "group_name": "GroupB", "community_name": "CommunityB", "name": "angelosTest", "description": "awfawfawf", "id": "93BE42D7C7FC49A8A751C1AC1D571FB6" }, { "alternative_code": "U_1", "group_name": "GroupB", "community_name": "CommunityB", "name": "Unit B", "description": null, "id": "5E79D05A7D8148AB86747C228A01425E" } ] }, { "alternative_code": "J_1", "name": "jjhhj", "accounts_receivable": { "number": "ACR0000002164", "name": "ACR0000002164 jjhhj", "id": "D3496A8382D8466E8972DE12AE1EB54E", "life_cycle_state": "ACTIVE", "account_owner": { "company_profile": { "tax_reference_number": null, "registered_in_country": { "alternative_code": "CY", "three_character_code": null, "name": "Cyprus", "id": "5BC0", "two_character_code": "CC" }, "number_of_employees": null, "annual_turnover": null, "profile_year": null, "registration_number": null, "vat_registration_number": null, "industry_sector": null, "industry": null, "established_date": null, "vat_registered_by": null, "vat_registration_date": null }, "company_name": "jjhhj", "name": null, "last_name": null, "id": "A478D7A5FED940DB968A7EBD4D427184", "life_cycle_state": "FINANCIAL", "middle_name": null, "title": null, "type": "COMPANY", "first_name": null, "demographics": null } }, "units_set": [] }, { "alternative_code": "12343221KPTesting", "name": "KPTestingGroup", "accounts_receivable": { "number": "ACR0000002173", "name": "ACR0000002173 KPTestingGroup", "id": "56AF1296528B4F178DC19471352E8567", "life_cycle_state": "ACTIVE", "account_owner": { "company_profile": { "tax_reference_number": null, "registered_in_country": { "alternative_code": "CY", "three_character_code": null, "name": "Cyprus", "id": "5BC0", "two_character_code": "CC" }, "number_of_employees": null, "annual_turnover": null, "profile_year": null, "registration_number": null, "vat_registration_number": null, "industry_sector": null, "industry": null, "established_date": null, "vat_registered_by": null, "vat_registration_date": null }, "company_name": "KPTestingGroup", "name": null, "last_name": null, "id": "833574855372451185D830712634D6E8", "life_cycle_state": "FINANCIAL", "middle_name": null, "title": null, "type": "COMPANY", "first_name": null, "demographics": null } }, "units_set": [ { "alternative_code": "41343", "group_name": "KPTestingGroup", "community_name": "CommunityB", "name": "KP", "description": null, "id": "FB19B70BE5E44432858341C4B21145AE" } ] }, { "alternative_code": "MRA", "name": "Merchant ABCD", "accounts_receivable": { "number": "ACR0000001751", "name": "ACR0000001751 Merchant ABCD", "id": "7115A9213ECA4356978FCAF1746C55AB", "life_cycle_state": "ACTIVE", "account_owner": { "company_profile": { "tax_reference_number": null, "registered_in_country": null, "number_of_employees": null, "annual_turnover": null, "profile_year": null, "registration_number": null, "vat_registration_number": null, "industry_sector": null, "industry": null, "established_date": null, "vat_registered_by": null, "vat_registration_date": null }, "company_name": "Merchant ABCD", "name": null, "last_name": null, "id": "336C4FB98AE24540BD3887D4FED8F28B", "life_cycle_state": "FINANCIAL", "middle_name": null, "title": null, "type": "COMPANY", "first_name": null, "demographics": null } }, "units_set": [ { "alternative_code": "MRAU", "group_name": "Merchant ABCD", "community_name": "CommunityB", "name": "Merchant A unit", "description": null, "id": "AB18F69E3CA84413BABEF07713D410CB" } ] }, { "alternative_code": "MG_3", "name": "Merchant GroupB", "accounts_receivable": null, "units_set": [ { "alternative_code": "MU_3", "group_name": "Merchant GroupB", "community_name": "CommunityB", "name": "Merchant UnitB1", "description": null, "id": "7481DE61483B40DEA14D71E16E606E2E" }, { "alternative_code": "MU_4", "group_name": "Merchant GroupB", "community_name": "CommunityB", "name": "Merchant UnitB2", "description": null, "id": "A8ADF0499FC6408A998C847C32F2EDE4" } ] }, { "alternative_code": "MGB_1", "name": "Merchant Group BP", "accounts_receivable": null, "units_set": [ { "alternative_code": "S_1", "group_name": "Merchant Group BP", "community_name": "CommunityB", "name": "Sales", "description": null, "id": "BD90D862D14141ADBB395419088F36FC" }, { "alternative_code": "MUB", "group_name": "Merchant Group BP", "community_name": "CommunityB", "name": "Merchant Unit BP1", "description": null, "id": "53FC3C9BF5654B2AA449E1942AC47FFE" }, { "alternative_code": "MUA", "group_name": "Merchant Group BP", "community_name": "CommunityB", "name": "Merchant Unit AP1", "description": null, "id": "11B32D7D7E214545BD0892EE6EF2918D" }, { "alternative_code": "MUB_1", "group_name": "Merchant Group BP", "community_name": "CommunityB", "name": "Merchant Unit BP2", "description": null, "id": "3D505AA2F2ED4421A3DD01F2AC349BA4" } ] } ], "status": { "code": "OK", "description": "", "message": "" } }