- Zixflow Web
- Help Center
- Blog
- Introduction
- GETGet List Of WA Accounts
- GETGet List Of Templates
- GETGet Template Variables
- POSTSend Whatsapp Template Message
- POSTSend Whatsapp Text Message
- POSTSend Whatsapp Image Message
- POSTSend Whatsapp Video Message
- POSTSend Whatsapp Audio Message
- POSTSend Whatsapp Document Message
- POSTSend Whatsapp Location Message
Attribute Options
Attribute Status
- GETGet List Of Attributes
- GETGet Attribute By ID
- POSTCreate Custom Attribute
- PATCHUpdate Custom Attribute
- DELDelete Custom Attribute
- POSTGet List of Collection Records
- GETGet Collection Record By ID
- POSTCreate A Collection Record
- PATCHUpdate A Collection Record
- DELDelete Collection Record By ID
- POSTGet List of List Entries
- GETGet List Entry By ID
- POSTCreate A List Entry
- PATCHUpdate List Entry
- DELDelete List Entry By ID
Whatsapp Campaign
Attributes
Collection Records
List Entries
Get Collection Record By ID
This endpoint returns selected collection record data
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
A unique identifier for the collection.
A unique identifier for the collection.
curl --request GET \
--url https://api.zixflow.com/api/v1/collection-records/{collectionId}/{recordId} \
--header 'Authorization: Bearer <token>'
{
"status": true,
"message": "success",
"data": {
"name": "Test Record",
"firstName": "Test",
"lastName": "Record",
"emails": [
"user@zixflow.com"
],
"phoneNumbers": [
"592965223",
"9176639301"
],
"company": {
"_id": "64b60314e7cca0f47d780544",
"name": "Zixflow",
"avatar": ""
},
"jobTitle": "Developer",
"description": "",
"address": "Mumbai, India",
"emailValidation": {
"_id": "64ad815b273e66dae1afe124",
"color": "#dbeddb",
"name": "Deliverable",
"isArchived": false,
"order": 2
},
"facebook": "",
"instagram": "",
"linkedin": "",
"twitter": "",
"lastInteraction": "2023-11-06T02:34:45.405Z",
"timezone": {
"_id": "64ad82ba273e66dae1b04689",
"color": "#e3e2e0",
"name": "Pacific/Niue",
"isArchived": false,
"order": 1
},
"source": {
"_id": "64ad815b273e66dae1afe141",
"color": "#fadec9",
"name": "Manually created",
"isArchived": false,
"order": 1
},
"owner": {
"_id": "64411b92cc16b5b0b858cc5f",
"name": "Agent Account",
"avatar": "",
"email": "dummy@outlook.com"
},
"share": [ ],
"createdAt": "2023-07-14T07:55:43.517Z",
"apiCustomAttribute": "Custom data",
"apiPipeline": {
"_id": "6520b88e4f7b6dea01cf9b7b",
"name": "Stage 2",
"color": "#02b55c",
"order": 2,
"isArchived": false,
"timeInStatus": null,
"celebrationEnabled": false,
"statusType": "normal"
},
"apiPipeline1": {
"_id": "64ae5870a3325d97495572f2",
"name": "Stage 1",
"color": "#5e6ad2",
"isArchived": false,
"timeInStatus": 0,
"celebrationEnabled": false,
"statusType": "normal"
},
"apiNumber1": 20,
"apiNumber2": 30
}
}
Description
This API endpoint enables the retrieval of selected collection record data. The structure of the collection record data is dynamic and varies depending on the collection, with no fixed response keys within the data.
Path
A unique identifier for the collection.
A unique identifier for the collection.
Response
Indicates the success or failure of the response. In this case, true signifies a successful operation.
Provides a human-readable message accompanying the response. In this instance, it confirms the successful retrieval of the record with the message “success”
The structure of the collection record data is dynamic and varies depending on the collection, with no fixed response keys within the data.
curl --request GET \
--url https://api.zixflow.com/api/v1/collection-records/{collectionId}/{recordId} \
--header 'Authorization: Bearer <token>'
{
"status": true,
"message": "success",
"data": {
"name": "Test Record",
"firstName": "Test",
"lastName": "Record",
"emails": [
"user@zixflow.com"
],
"phoneNumbers": [
"592965223",
"9176639301"
],
"company": {
"_id": "64b60314e7cca0f47d780544",
"name": "Zixflow",
"avatar": ""
},
"jobTitle": "Developer",
"description": "",
"address": "Mumbai, India",
"emailValidation": {
"_id": "64ad815b273e66dae1afe124",
"color": "#dbeddb",
"name": "Deliverable",
"isArchived": false,
"order": 2
},
"facebook": "",
"instagram": "",
"linkedin": "",
"twitter": "",
"lastInteraction": "2023-11-06T02:34:45.405Z",
"timezone": {
"_id": "64ad82ba273e66dae1b04689",
"color": "#e3e2e0",
"name": "Pacific/Niue",
"isArchived": false,
"order": 1
},
"source": {
"_id": "64ad815b273e66dae1afe141",
"color": "#fadec9",
"name": "Manually created",
"isArchived": false,
"order": 1
},
"owner": {
"_id": "64411b92cc16b5b0b858cc5f",
"name": "Agent Account",
"avatar": "",
"email": "dummy@outlook.com"
},
"share": [ ],
"createdAt": "2023-07-14T07:55:43.517Z",
"apiCustomAttribute": "Custom data",
"apiPipeline": {
"_id": "6520b88e4f7b6dea01cf9b7b",
"name": "Stage 2",
"color": "#02b55c",
"order": 2,
"isArchived": false,
"timeInStatus": null,
"celebrationEnabled": false,
"statusType": "normal"
},
"apiPipeline1": {
"_id": "64ae5870a3325d97495572f2",
"name": "Stage 1",
"color": "#5e6ad2",
"isArchived": false,
"timeInStatus": 0,
"celebrationEnabled": false,
"statusType": "normal"
},
"apiNumber1": 20,
"apiNumber2": 30
}
}