> For the complete documentation index, see [llms.txt](https://en.help.firstline.cc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://en.help.firstline.cc/developer/api/response-object.md).
# Response object data
{% hint style="info" %}
This page provides reference for API response fields.**Please read the data according to the field names in the response; do not change the names yourself**. For example `creater`,`creater_id` should be used as is. The fields returned by different APIs may differ, and some fields may also be `null`.
{% endhint %}
## Knowledge Base Kb
| Field Name | Type | Description | Example Value |
|---|
id | integer | Unique KB data identifier | 5 |
subject | string | Article title | "LINE graphic menu" |
content | string | Article content, supports HTML format | "<h2>Overview</h2><p>..." |
like_count | integer | Number of likes | 1 |
dislike_count | integer | Number of dislikes | 0 |
readed_count | integer | Read count (reading counter) | 10 |
is_public | boolean | Whether the article is public | true |
creater_id | integer | Creator user ID | 3 |
creater | object | Creator information, containing detailed user attributes | {...} |
├─ id | integer | User ID | 3 |
├─ name | string | User name (full name) | "eason d" |
sub_category_id | integer/null | Subcategory ID | null |
sub_category | object/null | Subcategory information | null |
file_entities_count | integer | Number of attachments | 0 |
file_entities | array | Attachment list, each element contains file information | [] |
category_id | integer | Main category ID | -1 |
category | object/null | Main category information | null |
kb_tags | array | List of KB tag information objects | [] |
kb_tag_ids | array | List of KB tag IDs | [] |
## Address Address
| PROPERTY | TYPE | DESCRIPTION |
| --------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id** | Number | address id |
| **type** | Number | Address type
- 0: Home
- 1: Mailing
- 2: Billing
- 3: Shipping
- 4: Current residence
- 5: Other
|
| **address** | String | Address content |
| **profile\_id** | Number | ID of the customer profile object |
| **state** | Object | [State/County](/developer/api/response-object.md#ou-city) |
| **state\_id** | Number | State/County ID |
| **country** | Object | [Country](/developer/api/response-object.md#guo-jia-country) |
| **country\_id** | Number | Country ID |
| **city** | Object | [District](/developer/api/response-object.md#ou-city) |
| **city\_id** | Number | District ID |
| **description** | String | Address description |
## Country Country
| PROPERTY | TYPE | DESCRIPTION |
| -------- | ------ | ----------- |
| **id** | Number | id |
| **name** | String | Name |
## City State
| PROPERTY | TYPE | DESCRIPTION |
| -------- | ------ | ----------- |
| **id** | Number | id |
| **name** | String | Name |
## District City
| PROPERTY | TYPE | DESCRIPTION |
| -------- | ------ | ----------- |
| **id** | Number | id |
| **name** | String | Name |
## Customer Contact
| PROPERTY | TYPE | DESCRIPTION |
| -------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id** | Number | Customer ID |
| **name** | String | Full name |
| **first\_name** | String | Last name |
| **last\_name** | String | First name |
| **membership\_no** | String | Membership number |
| **identity\_no** | String | ID number |
| **gender** | Number | Gender |
| **birth\_at** | Datetime | Birthday |
| **profile\_id** | Number | ID of the customer profile object |
| **profile** | Object | [Customer profile object](/developer/api/response-object.md#ke-hu-ge-zi-wu-jian-profile) |
| **sponsor** | Object | [Owner](/developer/api/response-object.md#ye-zhu-sponsor) |
| **sponsor\_id** | Number | Owner ID |
| **email\_contacts** | Array of objects | [Customer email array](/developer/api/response-object.md#dian-zi-xin-xiang-emailcontact) |
| **cz\_cols** | Array of objects | [Customer dynamic field array](/developer/api/response-object.md#dong-tai-lan-wei-czcol) |
| **tags** | Array of objects | [Tag array](/developer/api/response-object.md#ke-hu-biao-qian-contact-tag) |
| **disturb\_setting** | Object | [Do not disturb](/developer/api/response-object.md#ke-hu-wu-rao-she-ding-disturb-setting) |
| **\*\_contacts** | Array of objects | Represents the social media data corresponding to this customer across messaging channels. For example:
fb\_contacts indicates Facebook social media data;
line\_contacts indicates data related to the LINE Official Account.
|
## Customer Profile object Profile
| PROPERTY | TYPE | DESCRIPTION |
| ---------- | --------------- | ------------------------------------------------------------------------- |
| **id** | Number | The ID of the customer profile object, used to retrieve address and phone |
| **phones** | Array of object | [Phone array](/developer/api/response-object.md#dian-hua-phone-number) |
## Email Contact
| PROPERTY | TYPE | DESCRIPTION |
| --------------- | ------ | ------------------------------------------------------------------------- |
| **id** | Number | Email ID |
| **contact\_id** | Number | Belongs to [Customer](/developer/api/response-object.md#ke-hu-contact) ID |
| **address** | String | Email address |
| **draft** | String | Draft |
| **name** | String | Custom email alias |
| **description** | String | Email description |
## Custom field CzCol
| PROPERTY | TYPE | DESCRIPTION |
| --------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id** | Number | Dynamic field ID |
| **name** | String | Dynamic field name |
| **description** | String | Dynamic field description |
| **is\_allowed\_null** | Boolean | Whether null is allowed |
| **default** | Object | Default value of this dynamic field |
| **type** | Number | Dynamic field type
- 0: Number
- 1: String
- 2: Boolean
- 3: Date
- 4: Time
- 5: Datetime
- 6: Single select
- 7: Multi-select
|
| **category\_id** | Number | Main category ID |
| **category** | Object | [Main category](/developer/api/response-object.md#zhu-fen-lei-category) |
| **creater\_id** | Number | Employee ID of the staff member who created this dynamic field |
| **creater** | Object | Created this dynamic field [Staff](/developer/api/response-object.md#yuan-gong-employee) |
## Custom field category CzColCategory
| PROPERTY | TYPE | DESCRIPTION |
| --------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id** | Number | Dynamic field category ID |
| **name** | String | Dynamic field category name |
| **type** | Number | Dynamic field category type {0: customer dynamic relation form 1: customer dynamic relation table 2: ticket dynamic relation form 3: ticket dynamic relation table} |
| **description** | String | Dynamic field category description |
| **cols** | Array of objects | [Dynamic fields](/developer/api/response-object.md#dong-tai-lan-wei-czcol) |
## Customer custom table Contact Cz Relation
| PROPERTY | TYPE | DESCRIPTION |
| ------------------ | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id** | Number | Customer dynamic relation table ID |
| **relation\_id** | Number | [Dynamic field category](/developer/api/response-object.md#dong-tai-lan-wei-fen-lei-czcolcategory) ID |
| **relation\_name** | String | [Dynamic field category](/developer/api/response-object.md#dong-tai-lan-wei-fen-lei-czcolcategory) Name |
| **information** | Array of Objects | [Customer dynamic relation table content](/developer/api/response-object.md#ke-hu-dong-tai-guan-lian-biao-ge-nei-rong-contactczrelationinformation) array |
## Customer custom table Contact Cz RelationInformation
| PROPERTY | TYPE | DESCRIPTION |
| ------------- | ------ | ------------------------------------------------------------------------------- |
| **id** | Number | ID of the customer dynamic relation table content |
| **value** | String | Value of the customer dynamic relation table content |
| **col\_id** | Number | [Dynamic fields ](/developer/api/response-object.md#dong-tai-lan-wei-czcol)ID |
| **col\_name** | String | [Dynamic fields ](/developer/api/response-object.md#dong-tai-lan-wei-czcol)Name |
## Customer Tag Contact Tag
| PROPERTY | TYPE | DESCRIPTION |
| --------------- | ------ | ----------- |
| **id** | Number | id |
| **name** | String | Name |
| **description** | String | Description |
## Customer Do Not Disturb Setting Disturb Setting
| PROPERTY | TYPE | DESCRIPTION |
| -------------------------- | --------------- | --------------------------------------------------------------- |
| **id** | Number | id |
| **type** | Array of string | Types of do-not-disturb settings, including phone, Fb, and Line |
| **no\_disturb\_start\_at** | Time | Do-not-disturb start time |
| **no\_disturb\_end\_at** | Time | Do-not-disturb end time |
| **reason** | String | Reason for do not disturb |
## Employee Employee
| PROPERTY | TYPE | DESCRIPTION |
| ----------------------- | -------- | ----------------------------------------------------------------------------------- |
| **id** | Number | Employee ID |
| **name** | String | Name |
| **first\_name** | String | Last name |
| **last\_name** | String | First name |
| **employee\_no** | String | Employee number |
| **photo\_url** | String | Photo path |
| **identity\_no** | String | ID number |
| **job\_title\_id** | Number | Job title ID |
| **job\_title** | Object | [Job title](/developer/api/response-object.md#zhi-chen-job-title) |
| **department\_id** | Number | Department ID |
| **department** | Object | [Department](/developer/api/response-object.md#bu-men-deaprtment) |
| **extension\_id** | Number | Extension ID |
| **extension** | Object | [Extension](/developer/api/response-object.md#fen-ji-extension) |
| **profile** | Object | [Customer profile](/developer/api/response-object.md#ke-hu-ge-zi-wu-jian-profile) |
| **is\_active** | Boolean | Whether enabled |
| **role** | String | Permission |
| **email** | String | Email address |
| **group\_id** | Number | Employee group ID |
| **group** | Object | [Employee group](/developer/api/response-object.md#yuan-gong-qun-zu-employee-group) |
| **is\_immortal** | Boolean | Cannot be modified |
| **cti\_agent\_account** | String | CTI account name |
| **cti\_agent** | Object | [Phone agent](/developer/api/response-object.md#dian-hua-zhuan-yuan-ctiagent) |
| **created\_at** | Datetime | Initial creation time |
| **updated\_at** | Datetime | Last updated time |
## Job Title Job Title
| PROPERTY | TYPE | DESCRIPTION |
| --------------- | ------ | ------------ |
| **id** | Number | id |
| **abbrev** | String | Abbreviation |
| **name** | String | Name |
| **description** | String | Description |
## Extension Extension
| PROPERTY | TYPE | DESCRIPTION |
| ---------------------- | ------ | ------------------------------------------------------------- |
| **id** | Number | id |
| **type** | Number | Type <0: Extension, 1: ACD, 2: IVR, 3: WEBRTC> |
| **extension** | String | Extension number |
| **description** | String | Description |
| **media\_cluster\_id** | Number | **To be filled in** |
| **media\_cluster** | Object | **To be filled in** |
| **employee\_id** | Number | [Staff](/developer/api/response-object.md#yuan-gong-employee) |
| **employee** | Object | Employee ID |
## Phone agent CtiAgent
| PROPERTY | TYPE | DESCRIPTION |
| ------------- | ------ | ----------------------------------------------------------------------------------- |
| **id** | Number | id |
| **account** | String | Account |
| **employee** | Object | [Staff](/developer/api/response-object.md#yuan-gong-employee) |
| **group\_id** | Number | Employee group ID |
| **group** | Object | [Employee group](/developer/api/response-object.md#yuan-gong-qun-zu-employee-group) |
## Employee Group Employee Group
| PROPERTY | TYPE | DESCRIPTION |
| ------------------ | --------------- | ------------------------------------------------------------------------------------------------- |
| **id** | Number | Employee ID |
| **name** | String | Name |
| **description** | String | Description |
| **supervisor\_id** | Number | Supervisor ID |
| **supervisor** | Object | Supervisor, in the format of[Staff](/developer/api/response-object.md#yuan-gong-employee) |
| **members** | Array of object | Group members, in the format of[Staff](/developer/api/response-object.md#yuan-gong-employee)array |
## Department Deaprtment
| PROPERTY | TYPE | DESCRIPTION |
| --------------- | ------ | ------------ |
| **id** | Number | id |
| **name** | String | Name |
| **abbrev** | String | Abbreviation |
| **number** | Number | Code |
| **description** | String | Description |
## Phone Phone Number
| PROPERTY | TYPE | DESCRIPTION |
| --------------- | ------ | ------------------------------------------------ |
| **id** | Number | id |
| **type** | Number | 0: Home, 1: Company, 2: Mobile, 3: Fax, 4: Other |
| **extension** | String | Extension |
| **number** | String | Number |
| **description** | String | Description |
## Ticket Ticket
| PROPERTY | TYPE | DESCRIPTION |
| ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| **id** | Number | id |
| **subject** | String | Title |
| **content** | String | Content |
| **due\_at** | Datetime | Due time |
| **status** | Number | Ticket status < 0: Pending 1: In progress 2: Resolved 3: Closed > |
| **status\_memo** | String | Status note |
| **priority** | Number | Priority |
| **termination\_code\_id** | Number | Status detail ID |
| **termination\_code** | Object | [Status detail](/developer/api/response-object.md#gong-chan-zhuang-tai-xi-xiang-dai-ma-ticket-termination-code) |
| **contact** | Object | [Customer](/developer/api/response-object.md#ke-hu-contact) |
| **contact\_id** | Number | Customer ID |
| **sub\_category** | Object | [Subcategory](/developer/api/response-object.md#zi-fen-lei-subcategory) |
| **sub\_category\_id** | Number | Subcategory ID |
| **creater** | Object | [Employee who created this ticket](/developer/api/response-object.md#yuan-gong-employee) |
| **handler\_id** | Number | Employee ID of the staff member who created this ticket |
| **handler** | Object | [Employee responsible for this ticket](/developer/api/response-object.md#yuan-gong-employee) |
| **sponsor\_id** | Number | Employee ID of the staff member responsible for this ticket |
| **sponsor** | Object | [Owner of this ticket](/developer/api/response-object.md#ye-zhu-sponsor) |
| **created\_at** | Datetime | Initial creation time |
| **updated\_at** | Datetime | Last updated time |
## Ticket status detail code Ticket Termination Code
| PROPERTY | TYPE | DESCRIPTION |
| --------------- | ------ | ----------------------------------------------------------------------------------------------- |
| **id** | Number | id |
| **name** | String | Name |
| **description** | String | Description |
| **status** | Number | Corresponding ticket status < 0: Pending 1: In Progress 2: Resolved 3: Closed > |
| **creater\_id** | Number | ID of the employee who created this status detail |
| **creater** | Object | [Employee who created this status detail](/developer/api/response-object.md#yuan-gong-employee) |
## Main Category
| PROPERTY | TYPE | DESCRIPTION |
| --------------- | ---------------- | ----------------------------------------------------------------------------- |
| **id** | Number | id |
| **name** | String | Name |
| **description** | String | Description |
| **children** | Array of objects | [Subcategory array](/developer/api/response-object.md#zi-fen-lei-subcategory) |
## Subcategory
| PROPERTY | TYPE | DESCRIPTION |
| ---------------- | ------ | ----------------------------------------------------------------------- |
| **id** | Number | id |
| **name** | String | Name |
| **description** | String | Description |
| **category** | Object | [Main category](/developer/api/response-object.md#zhu-fen-lei-category) |
| **category\_id** | Number | Main category id |
## Sponsor
| PROPERTY | TYPE | DESCRIPTION |
| ---------------- | ------- | ----------------- |
| **id** | Number | id |
| **name** | String | Name |
| **description** | String | Description |
| **is\_immortal** | Boolean | Whether immutable |
## Service record Interact-collection
| PROPERTY | TYPE | DESCRIPTION |
| ------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | Number | Service record system ID |
| is\_acw\_completed | Boolean | Whether the service is completed, 0: Not completed, 1: Completed |
| first\_enter\_queue\_time | String | Time when the customer call started being assigned. |
| first\_start\_service\_at | Datetime | Time when the agent connected and started servicing the customer. |
| last\_finished\_at | Datetime | Time when the conversation with the customer ended, but it does not mean the service is completed. |
| acw\_at | Datetime | Time when the agent finished this service. |
| handler\_id | Number | Responsible agent system ID |
| handler | Object | Responsible agent data |
| contact\_id | Number | Customer ID |
| contact | Object | Customer data |
| memo | String | Service record notes |
| bound\_type | Number | Direction of the service.
0 means the agent initiated the contact; 1 means the customer initiated contact.
|
| logs | Array | All related conversation records for this service record. The list view does not include complete information; please retrieve complete information via single record lookup. |
| sponsor\_id | Number | Owner ID |
| sponsor | Object | Owner data |
| reasons | Array | Service reason data |
| reason\_ids | Array | Service reason IDs |
| result\_id | Number | Service result ID |
| result | Object | Service result data |
| media\_cluster\_id | Number | Channel integration ID |
| media\_cluster | Object | Channel integration |
| transfer\_logs | Array | Records this service record has been transferred/reassigned to |
| created\_at | Datetime | Service record system creation time |
## Custom table import template Relation Import Recipe
| Property | Type | Description |
| ------------------------ | ------ | ---------------------------------------------------------------------------------------------------- |
| id | Number | **Custom table batch import template**ID |
| name | String | **Custom table batch import template**Name |
| importable\_type | String | **Custom table batch import template**Type, currently only supports **App\Contact** |
| description | String | **Custom table batch import template**Detailed description of |
| headers | Array | Field definitions of the import file |
| cz\_col\_category\_id | Number | Dynamic field category ID |
| cz\_col\_category | Object | Dynamic field category |
| unique\_columns | Array | Defined**Customer**Unique value identification field |
| relation\_unique\_column | Array | Defined**Custom table**Unique value identification field |
| creater\_id | Number | Creator's id |
| creater | Object | Creator |
| tasks\_count | Number | Based on this**Custom table batch import template**Created**Custom table batch import task**Quantity |
## Custom table import schedule Relation Import Task
> Only important fields are described
| Property | Type | Description |
| --------------------- | -------- | ---------------------------------------------------------------------- |
| id | Number | **Custom table import task**ID |
| size | Number | File size (byte) |
| total\_amount | Number | Total number of rows |
| description | String | Task description |
| status | Number | Status (0: Created, 1: Importing, 2: Completed, 10: Error, 11: Paused) |
| current\_sheet\_index | Number | Which sheet the import file is currently processing |
| current\_row\_index | Number | Which row has currently been imported |
| executed\_start\_at | Datetime | Start execution time |
| executed\_end\_at | Datetime | End execution time |
| creater\_id | Number | Creator's id |
| created\_at | Datetime | Initial creation time |
| updated\_at | Datetime | Last updated time |
## Customer import template Entity Import Recipe
| Property | Type | Description |
| --------------------- | ------ | -------------------------------------------------------------------------- |
| id | Number | **Batch import template**ID |
| name | String | **Batch import template**Name |
| importable\_type | String | **Batch import template**Type, currently only supports **App\Contact** |
| description | String | **Batch import template**Detailed description of |
| headers | Array | Field definitions of the import file |
| cz\_col\_category\_id | Number | Dynamic field category ID |
| cz\_col\_category | Object | Dynamic field category |
| unique\_columns | Array | Defined**Customer**Unique value identification field |
| creater\_id | Number | Creator's id |
| creater | Object | Creator |
| tasks\_count | Number | Based on this**Batch import template**Created**Batch import task**Quantity |
## Customer import schedule Entity Import Task
> Only important fields are described
| Property | Type | Description |
| --------------------- | -------- | ---------------------------------------------------------------------- |
| id | Number | **Import task**ID |
| size | Number | File size (byte) |
| total\_amount | Number | Total number of rows |
| description | String | Task description |
| status | Number | Status (0: Created, 1: Importing, 2: Completed, 10: Error, 11: Paused) |
| current\_sheet\_index | Number | Which sheet the import file is currently processing |
| current\_row\_index | Number | Which row has currently been imported |
| executed\_start\_at | Datetime | Start execution time |
| executed\_end\_at | Datetime | End execution time |
| creater\_id | Number | Creator's id |
| created\_at | Datetime | Initial creation time |
| updated\_at | Datetime | Last updated time |