Get entity from CrmContacts by key
GET/CrmContacts(:id)
Get entity from CrmContacts by key
Request
Path Parameters
Possible values: Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
key: id of CrmContact
Query Parameters
Possible values: [salutation
, firstName
, lastNamePrefix
, lastName
, companyName
, email
, phone1
, phone2
, streetName
, houseNumber
, postalCode
, state
, city
, useParentAddress
, countryIso
, crmAccountId
, contactReference
, id
, createdDate
, updatedDate
, organizationId
, reference
, creatorId
, customField1
, customField2
, customField3
, customField4
, customField5
, organization
]
Select properties to be returned
Possible values: [*
, organization
]
Expand related entities
Responses
- 200
- default
Retrieved entity
- application/json
- Schema
- Example (from schema)
Schema
Possible values: <= 2 characters
{
"salutation": "string",
"firstName": "string",
"lastNamePrefix": "string",
"lastName": "string",
"companyName": "string",
"email": "string",
"phone1": "string",
"phone2": "string",
"streetName": "string",
"houseNumber": "string",
"postalCode": "string",
"state": "string",
"city": "string",
"useParentAddress": true,
"countryIso": "string",
"crmAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"contactReference": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdDate": "2024-06-06T15:30:37.125Z",
"updatedDate": "2024-06-06T15:30:37.125Z",
"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customField1": "string",
"customField2": "string",
"customField3": "string",
"customField4": "string",
"customField5": "string",
"organization": {}
}
error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
error
object
required
details
object[]
The structure of this object is service-specific
{
"error": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{
"code": "string",
"message": "string",
"target": "string"
}
],
"innererror": {}
}
}