GET api/Customer/{id}
Retrieves the customer with the specified Id.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| id | The Id of the customer to retrieve |
Define this parameter in the request URI. |
Response Information
Response body formats
application/json, text/json
Sample:
{
"custom_fields": [
{
"custom_field": {
"id": 1,
"agent_label": "sample string 2",
"customer_label": "sample string 3",
"field_type": "sample string 4",
"is_agent_required": true,
"is_archived": true,
"is_customer_required": true,
"is_hidden_from_customer": true,
"is_required_when_resolving": true,
"provider_id": 10,
"usage": "sample string 11",
"Values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"value": "sample string 1"
},
{
"custom_field": {
"id": 1,
"agent_label": "sample string 2",
"customer_label": "sample string 3",
"field_type": "sample string 4",
"is_agent_required": true,
"is_archived": true,
"is_customer_required": true,
"is_hidden_from_customer": true,
"is_required_when_resolving": true,
"provider_id": 10,
"usage": "sample string 11",
"Values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"value": "sample string 1"
},
{
"custom_field": {
"id": 1,
"agent_label": "sample string 2",
"customer_label": "sample string 3",
"field_type": "sample string 4",
"is_agent_required": true,
"is_archived": true,
"is_customer_required": true,
"is_hidden_from_customer": true,
"is_required_when_resolving": true,
"provider_id": 10,
"usage": "sample string 11",
"Values": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"value": "sample string 1"
}
],
"address1": "sample string 1",
"address2": "sample string 2",
"city": "sample string 3",
"company_name": "sample string 4",
"country": "sample string 5",
"date_created": "2024-04-18T18:37:28.252289-04:00",
"date_last_updated": "2024-04-18T18:37:28.252289-04:00",
"DateTimeFormat": {
"adjust_for_daylight_savings": true,
"date_format": {
"name": "sample string 1",
"id": 1
},
"time_format": {
"name": "sample string 1",
"id": 1
},
"id": 1
},
"is_active": true,
"location": "sample string 8",
"notes": "sample string 9",
"phone_number": "sample string 10",
"postal_code": "sample string 11",
"id": 1
}
application/xml, text/xml
Sample:
<customer_cf xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api.Org">
<id xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api">1</id>
<DateTimeFormat>
<id xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api">1</id>
<adjust_for_daylight_savings>true</adjust_for_daylight_savings>
<date_format>
<id xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api">1</id>
<name>sample string 1</name>
</date_format>
<time_format>
<id xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api">1</id>
<name>sample string 1</name>
</time_format>
</DateTimeFormat>
<address1>sample string 1</address1>
<address2>sample string 2</address2>
<city>sample string 3</city>
<company_name>sample string 4</company_name>
<country>sample string 5</country>
<date_created>2024-04-18T18:37:28.252289-04:00</date_created>
<date_last_updated>2024-04-18T18:37:28.252289-04:00</date_last_updated>
<is_active>true</is_active>
<location>sample string 8</location>
<notes>sample string 9</notes>
<phone_number>sample string 10</phone_number>
<postal_code>sample string 11</postal_code>
<custom_fields>
<custom_field_with_value>
<custom_field>
<Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
<d5p1:string>sample string 3</d5p1:string>
</Values>
<agent_label>sample string 2</agent_label>
<customer_label>sample string 3</customer_label>
<field_type>sample string 4</field_type>
<id>1</id>
<is_agent_required>true</is_agent_required>
<is_archived>true</is_archived>
<is_customer_required>true</is_customer_required>
<is_hidden_from_customer>true</is_hidden_from_customer>
<is_required_when_resolving>true</is_required_when_resolving>
<provider_id>10</provider_id>
<usage>sample string 11</usage>
</custom_field>
<value>sample string 1</value>
</custom_field_with_value>
<custom_field_with_value>
<custom_field>
<Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
<d5p1:string>sample string 3</d5p1:string>
</Values>
<agent_label>sample string 2</agent_label>
<customer_label>sample string 3</customer_label>
<field_type>sample string 4</field_type>
<id>1</id>
<is_agent_required>true</is_agent_required>
<is_archived>true</is_archived>
<is_customer_required>true</is_customer_required>
<is_hidden_from_customer>true</is_hidden_from_customer>
<is_required_when_resolving>true</is_required_when_resolving>
<provider_id>10</provider_id>
<usage>sample string 11</usage>
</custom_field>
<value>sample string 1</value>
</custom_field_with_value>
<custom_field_with_value>
<custom_field>
<Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
<d5p1:string>sample string 3</d5p1:string>
</Values>
<agent_label>sample string 2</agent_label>
<customer_label>sample string 3</customer_label>
<field_type>sample string 4</field_type>
<id>1</id>
<is_agent_required>true</is_agent_required>
<is_archived>true</is_archived>
<is_customer_required>true</is_customer_required>
<is_hidden_from_customer>true</is_hidden_from_customer>
<is_required_when_resolving>true</is_required_when_resolving>
<provider_id>10</provider_id>
<usage>sample string 11</usage>
</custom_field>
<value>sample string 1</value>
</custom_field_with_value>
</custom_fields>
</customer_cf>