GET api/Customer_Custom_Field/Get/{id}

Retrieves the specified customers custom fields.

Request Information

Parameters

NameDescriptionAdditional 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_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"
  }
]

application/xml, text/xml

Sample:
<ArrayOfcustom_field_with_value xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api.Org">
  <custom_field_with_value>
    <custom_field>
      <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1: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>
</ArrayOfcustom_field_with_value>