- Created by Former user , last modified on Jul 11, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 4 Next »
This method returns all the access tokens which are not associated with an existing entity. Multiple access tokens are retrieved by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
number (mandatory) | Number | The number of access tokens that should be retrieved |
life_cycle_state (optional) | String | The life cycle state of the access tokens that should be retrieved. The allowed options are EFFECTIVE or NOT_EFFECTIVE or PENDING_VERIFICATION |
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 access token |
number | String | The number of the retrieved access token |
life_cycle_state | String | The state of the retrieved access token which can be one of the following: EFFECTIVE, NOT_EFFECTIVE, PENDING_VERIFICATION |
authentication_code | String | The authentication code of the retrieved access token |
identifier | String | The identifier of the retrieved access token |
card_masked_number | String | The masked number of the card as provided
Available from CRM.COM R16.2.0 |
card_last_4_digits | String | The last 4 digits of the card as provided.
Available from CRM.COM R15.0.0 Deprecated from CRM.COM R16.2.0 |
verification_code | String | The verification code of the retrieved access token Available from CRM.COM R9.0.0 |
verified_date | Date | The date that the access token was verified Available from CRM.COM R9.0.0 |
udf_string_1 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_2 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_3 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_4 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_5 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_6 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_7 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_string_8 | String | User Defined Field of type String Available from CRM.COM R10.1.0 |
udf_float_1 | Float | User Defined Field of type Float Available from CRM.COM R10.1.0 |
udf_float_2 | Float | User Defined Field of type Float Available from CRM.COM R10.1.0 |
udf_float_3 | Float | User Defined Field of type Float Available from CRM.COM R10.1.0 |
udf_float_4 | Float | User Defined Field of type Float Available from CRM.COM R10.1.0 |
udf_date_1 | Date | User Defined Field of type Date Available from CRM.COM R10.1.0 |
udf_date_2 | Date | User Defined Field of type Date Available from CRM.COM R10.1.0 |
udf_date_3 | Date | User Defined Field of type Date Available from CRM.COM R10.1.0 |
udf_date_4 | Date | User Defined Field of type Date Available from CRM.COM R10.1.0 |
verified_by_user | User Object | The user that verified the access token Available from CRM.COM R9.0.0 |
rewards_participant | Rewards Participant Object | The rewards participant associated with the access token |
accounts_receivable | Accounts Receivable Object | The accounts receivable associated with the access token Available from CRM.COM R8.0.0 |
classification | Access Token Classification Object | The classification of the access token Available from CRM.COM R10.0.0 |
Log Information Object | The log information related with the retrieved access token |
Referred Objects Response Data
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved reward participant |
number | String | The number of the retrieved reward participant |
life_cycle_state | String | The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED. Available from CRM.COM R12.0.0 |
accounts_receivable | Accounts receivable object | The accounts receivable owned by the reward participant |
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 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 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 |
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved classification |
name | String | The name of the retrieved classification |
alternative_code | String | The alternative code of the retrieved classification |
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:
{ "status": { "message": "", "description": "", "code": "OK" }, "data": [ { "log_information": { "updated_date": "2015-05-27T11:14:32", "created_date": "2015-01-29T12:22:58", "created_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1", "alternative_code": "MG" }, "updated_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1", "alternative_code": "MG" }, "created_by_user": { "person_name": "emichailidou", "username": "emichailidou", "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD", "email": "e_michailidou@crm.com" }, "updated_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" } }, "reward_participant": null, "authentication_code": "4B686F53D4F498EFE54FBA13707CC896", "life_cycle_state": "NOT_EFFECTIVE", "accounts_receivable": null, "number": "31", "identifier": "cd0900001!", "id": "0B417EC816D48FE604FDBAA3D3668D21" }, { "log_information": { "updated_date": "2015-05-27T09:57:38", "created_date": "2015-05-27T09:25:38", "created_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1", "alternative_code": "MG" }, "updated_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1", "alternative_code": "MG" }, "created_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" }, "updated_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" } }, "reward_participant": null, "authentication_code": "23131234", "life_cycle_state": "NOT_EFFECTIVE", "accounts_receivable": null, "number": "49", "identifier": "123145as", "id": "1D734D9AD4484E93B248921080C4C494" }, { "log_information": { "updated_date": "2015-01-13T15:46:41", "created_date": "2015-01-09T15:15:23", "created_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1", "alternative_code": "MG" }, "updated_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1", "alternative_code": "MG" }, "created_by_user": { "person_name": "p_xenopoulou", "username": "p_xenopoulou", "id": "159C17D9C4B1E48DC129FBC701D38438", "email": "p_xenopoulou@crm.com" }, "updated_by_user": { "person_name": "p_xenopoulou", "username": "p_xenopoulou", "id": "159C17D9C4B1E48DC129FBC701D38438", "email": "p_xenopoulou@crm.com" } }, "reward_participant": null, "authentication_code": "21A8D8A1EF9E37F43E863D78466C99D1", "life_cycle_state": "NOT_EFFECTIVE", "accounts_receivable": null, "number": "5", "identifier": "!12ABCD", "id": "2436DBBFFC1CE395B7F7B9C3D904031F" }, { "log_information": { "updated_date": "2015-05-27T11:27:50", "created_date": "2015-05-27T09:21:31", "created_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1", "alternative_code": "MG" }, "updated_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1", "alternative_code": "MG" }, "created_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" }, "updated_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" } }, "reward_participant": null, "authentication_code": "112233665", "life_cycle_state": "EFFECTIVE", "accounts_receivable": { "account_owner": { "last_name": null, "middle_name": null, "life_cycle_state": "FINANCIAL", "company_profile": { "annual_turnover": null, "tax_reference_number": null, "profile_year": 2014, "number_of_employees": 30, "established_date": "2014-02-05T00:00:00", "industry_sector": null, "vat_registration_number": "11552546", "registered_in_country": null, "vat_registered_by": null, "vat_registration_date": null, "industry": null, "registration_number": "128596663" }, "title": null, "first_name": null, "type": "COMPANY", "id": "DF91C1AD6E8BB995377B3C29C5F5FFAB", "name": null, "company_name": "Walt Disney Museum", "demographics": null }, "life_cycle_state": "TERMINATED", "number": "ACR000604", "id": "E337DA5F4A834E188B3A60E3E36F1B51", "name": "ACR000604" }, "number": "47", "identifier": "4857ap23", "id": "4754A06B5F2F45A1B7CB7CCB85DEA473" }, { "log_information": { "updated_date": "2015-05-27T09:32:24", "created_date": "2015-05-27T09:23:57", "created_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1", "alternative_code": "MG" }, "updated_by_unit": { "community_name": "Internal Community", "id": "48305F8849E3C18B227C5BE3A27BA6DF", "name": "Admin Unit", "group_name": "Main Group", "description": "r1", "alternative_code": "MG" }, "created_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" }, "updated_by_user": { "person_name": "MPAdministrator", "username": "MPAdministrator", "id": "1", "email": "sakkascy1986@hotmail.com" } }, "reward_participant": null, "authentication_code": "66554433", "life_cycle_state": "NOT_EFFECTIVE", "accounts_receivable": null, "number": "48", "identifier": "99aw2311", "id": "4B7037868CE14A7D863E56251A629A20" } ] }
- No labels