GET /crm/prospects/{id}
Retrieves the customer for the given customer/prospect ID.
Roles that can access this endpoint are Users.
Parameters
| name |
description |
type |
default |
type |
| id |
ID for the prospect/customer to be returned |
path
|
|
String
|
| includeComments |
if related Comment records should be included |
query
|
false |
Boolean
|
| includeContacts |
if related Contact records should be included |
query
|
false |
Boolean
|
Result
RowCustomer
of type:
application/xml
application/json
a RowCustomer object.
Additional attributes:
__prospectTypeDescr This value represents the description of the prospect type, found in the customer.prospect_type_id field.__salesStatusDescr This value represents the description of the sales status, found in the customer.sales_status_id field.__categoryDescr This value represents the description of the category code, found in the customer.category field.__bridgeName This value represents the name of the bridge customer, found in the customer.bridge_id field.__marketPlanDescr This value represents the description of the market plan, found in the customer.mark+plan_id field.
Child Elements:
RowSalesperson This element represent the salesperson associated with the prospect, by the customer.salesperson_id field. The element contains a __name attribute with the value salesperson.RowSalesperson This element represent the sales manager associated with the prospect by the customer.sales_manager_id field. The element contains a __name attribute with the value salesManager.RowUsers This element represent the operations user associated with the prospect by the customer.operations_user field. The element contains a __name attribute with the value operationsUser.RowContact These elements represent the contacts associated with the prospect. The element contains a __name attribute with the value contacts. *Note this is only returned if the includeContacts Query Parameter is passed as true.RowComments These elements represent the comments associated with the prospect. The element contains a __name attribute with the value comments. *Note this is only returned if the includeComments Query Parameter is passed as true.
Try It Out
Request