GetByEnquiryAsync - Gofive OpenAPI

List conversations filtered by employee, customer, status and a date range on the conversation's date.

When neither dateStart nor dateEnd is sent, only conversations from today are returned. When only
one of the two is sent, the other is derived from it, and a dateEnd at 00:00 is extended to 23:59:59
of that day. Results are ordered by creation date, newest first.

The response contains a lightweight summary of each conversation. To retrieve full details (customer,
contact, deal, activity, attachments, notes), call GET /v1/Conversation/{conversationId} with each
conversation's conversationId.

Permissions: The token's user can see conversations of their own company only. Other companies' data
is never returned.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "staffCodes": [
        "EMP001"
    ],
    "customerCodes": [
        "C000001"
    ],
    "actionIds": [
        110061
    ],
    "dateStart": "2019-08-24T14:15:22.123Z",
    "dateEnd": "2019-08-24T14:15:22.123Z",
    "skip": 0,
    "take": 10000
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Success

Bodyapplication/json

Example

{
    "total": 42,
    "data": [
        {
            "conversationId": 987654,
            "customerId": 0,
            "contactId": 0,
            "type": 110011,
            "subType": 0,
            "outcome": 0,
            "quantified": 0,
            "action": 110061,
            "description": "string",
            "dateConversation": "2019-08-24T14:15:22.123Z",
            "dateFollowUp": "2019-08-24T14:15:22.123Z",
            "followUpNotes": "string",
            "callMinutes": 0,
            "createdByUserId": "string",
            "dateCreated": "2019-08-24T14:15:22.123Z",
            "fullname": "string",
            "fullnameEn": "string",
            "firstname": "string",
            "firstnameEn": "string",
            "lastname": "string",
            "lastnameEn": "string",
            "pictureUrl": "string",
            "role": "string",
            "position": "string",
            "unqualifiedReason": "string",
            "typeName": "string",
            "outcomeName": "string",
            "quantifiedName": "string",
            "subTypeName": "string",
            "actionName": "string",
            "customerName": "string",
            "canCreatePlan": true,
            "canEdit": true,
            "canManage": true,
            "isAiGenerated": true,
            "attachments": [
                {}
            ],
            "task": {}
        }
    ]
}

🟠400

🟠401

🟠403