Get Activity By Id

GET

api

collection-records

activity-list

{activityId}

curl --request GET \
  --url https://api.zixflow.com/api/v1/collection-records/activity-list/{activityId} \
  --header 'Authorization: Bearer <token>'

{
    "status": true,
    "message": "Records fetched successfully",
    "data": {
        "_id": "654b3231448888ff7d161a59",
        "name": "Call HOH",
        "scheduleAt": "2023-11-08T07:01:00.000Z",
        "description": "",
        "associated": null,
        "assignee": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test User",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "status": {
            "_id": "65338d9cf781c59be3859c63",
            "color": "#99ff93",
            "name": "Completed",
            "celebrationEnabled": false,
            "isArchived": false,
            "order": 2,
            "statusType": "normal",
            "timeInStatus": 0
        },
        "sourceDetails": "",
        "source": {
            "_id": "65338d9cf781c59be3859c6a",
            "name": "Manually created",
            "color": "#efe0da",
            "isArchived": false,
            "order": 1
        },
        "createdBy": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test User",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "completedTime": "2023-11-08T07:01:30.450Z",
        "activityLostReason": null,
        "createdAt": "2023-11-08T07:01:05.770Z"
    }
}

Path

activityId

string

required

A unique identifier for the activity data.

Response

status

boolean

Indicates the success or failure of the record retrieval. In this case, true signifies a successful operation.

message

string

Provides a human-readable message accompanying the response. In this instance, it confirms the successful retrieval of records with the message “Records fetched successfully.”

data

object

An array containing details of the fetched records. For each record in the data array:

Show data

_id

string

A unique identifier for the record, allowing for precise referencing.

name

string

The name associated with the record.

scheduleAt

string

The scheduled time for the record in ISO 8601 format.

description

string

Additional information or details about the record.

associated

null

Details about any associated entity, if applicable.

assignee

object

Details about the assignee of the record:

Show assignee

_id

string

Unique identifier for the assignee.

name

string

The name of the assignee.

avatar

string

URL or information about the assignee’s avatar.

string

Email address of the assignee.

status

object

Details about the status of the record:

Show status

_id

string

Unique identifier for the status.

color

string

Hex color code representing the status color.

name

string

The name of the status.

sourceDetails

string

Additional details about the source of the record.

source

object

Details about the source of the record:

Show source

_id

string

Unique identifier for the source.

name

string

The name of the source.

color

string

Hex color code representing the source color.

createdBy

object

Details about the creator of the record:

Show createdBy

_id

string

Unique identifier for the creator.

name

string

The name of the creator.

avatar

string

URL or information about the creator’s avatar.

string

Email address of the creator.

completedTime

string

The timestamp when the record was completed in ISO 8601 format.

activityLostReason

null

Reason for any lost activity, if applicable.

createdAt

string

The timestamp when the record was created in ISO 8601 format.

{
    "status": true,
    "message": "Records fetched successfully",
    "data": {
        "_id": "654b3231448888ff7d161a59",
        "name": "Call HOH",
        "scheduleAt": "2023-11-08T07:01:00.000Z",
        "description": "",
        "associated": null,
        "assignee": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test User",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "status": {
            "_id": "65338d9cf781c59be3859c63",
            "color": "#99ff93",
            "name": "Completed",
            "celebrationEnabled": false,
            "isArchived": false,
            "order": 2,
            "statusType": "normal",
            "timeInStatus": 0
        },
        "sourceDetails": "",
        "source": {
            "_id": "65338d9cf781c59be3859c6a",
            "name": "Manually created",
            "color": "#efe0da",
            "isArchived": false,
            "order": 1
        },
        "createdBy": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test User",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "completedTime": "2023-11-08T07:01:30.450Z",
        "activityLostReason": null,
        "createdAt": "2023-11-08T07:01:05.770Z"
    }
}

curl --request GET \
  --url https://api.zixflow.com/api/v1/collection-records/activity-list/{activityId} \
  --header 'Authorization: Bearer <token>'

{
    "status": true,
    "message": "Records fetched successfully",
    "data": {
        "_id": "654b3231448888ff7d161a59",
        "name": "Call HOH",
        "scheduleAt": "2023-11-08T07:01:00.000Z",
        "description": "",
        "associated": null,
        "assignee": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test User",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "status": {
            "_id": "65338d9cf781c59be3859c63",
            "color": "#99ff93",
            "name": "Completed",
            "celebrationEnabled": false,
            "isArchived": false,
            "order": 2,
            "statusType": "normal",
            "timeInStatus": 0
        },
        "sourceDetails": "",
        "source": {
            "_id": "65338d9cf781c59be3859c6a",
            "name": "Manually created",
            "color": "#efe0da",
            "isArchived": false,
            "order": 1
        },
        "createdBy": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test User",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "completedTime": "2023-11-08T07:01:30.450Z",
        "activityLostReason": null,
        "createdAt": "2023-11-08T07:01:05.770Z"
    }
}

GET

api

collection-records

activity-list

{activityId}

curl --request GET \
  --url https://api.zixflow.com/api/v1/collection-records/activity-list/{activityId} \
  --header 'Authorization: Bearer <token>'

{
    "status": true,
    "message": "Records fetched successfully",
    "data": {
        "_id": "654b3231448888ff7d161a59",
        "name": "Call HOH",
        "scheduleAt": "2023-11-08T07:01:00.000Z",
        "description": "",
        "associated": null,
        "assignee": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test User",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "status": {
            "_id": "65338d9cf781c59be3859c63",
            "color": "#99ff93",
            "name": "Completed",
            "celebrationEnabled": false,
            "isArchived": false,
            "order": 2,
            "statusType": "normal",
            "timeInStatus": 0
        },
        "sourceDetails": "",
        "source": {
            "_id": "65338d9cf781c59be3859c6a",
            "name": "Manually created",
            "color": "#efe0da",
            "isArchived": false,
            "order": 1
        },
        "createdBy": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test User",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "completedTime": "2023-11-08T07:01:30.450Z",
        "activityLostReason": null,
        "createdAt": "2023-11-08T07:01:05.770Z"
    }
}

Path

activityId

string

required

A unique identifier for the activity data.

Response

status

boolean

Indicates the success or failure of the record retrieval. In this case, true signifies a successful operation.

message

string

Provides a human-readable message accompanying the response. In this instance, it confirms the successful retrieval of records with the message “Records fetched successfully.”

data

object

An array containing details of the fetched records. For each record in the data array:

Show data

_id

string

A unique identifier for the record, allowing for precise referencing.

name

string

The name associated with the record.

scheduleAt

string

The scheduled time for the record in ISO 8601 format.

description

string

Additional information or details about the record.

associated

null

Details about any associated entity, if applicable.

assignee

object

Details about the assignee of the record:

Show assignee

_id

string

Unique identifier for the assignee.

name

string

The name of the assignee.

avatar

string

URL or information about the assignee’s avatar.

string

Email address of the assignee.

status

object

Details about the status of the record:

Show status

_id

string

Unique identifier for the status.

color

string

Hex color code representing the status color.

name

string

The name of the status.

sourceDetails

string

Additional details about the source of the record.

source

object

Details about the source of the record:

Show source

_id

string

Unique identifier for the source.

name

string

The name of the source.

color

string

Hex color code representing the source color.

createdBy

object

Details about the creator of the record:

Show createdBy

_id

string

Unique identifier for the creator.

name

string

The name of the creator.

avatar

string

URL or information about the creator’s avatar.

string

Email address of the creator.

completedTime

string

The timestamp when the record was completed in ISO 8601 format.

activityLostReason

null

Reason for any lost activity, if applicable.

createdAt

string

The timestamp when the record was created in ISO 8601 format.

{
    "status": true,
    "message": "Records fetched successfully",
    "data": {
        "_id": "654b3231448888ff7d161a59",
        "name": "Call HOH",
        "scheduleAt": "2023-11-08T07:01:00.000Z",
        "description": "",
        "associated": null,
        "assignee": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test User",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "status": {
            "_id": "65338d9cf781c59be3859c63",
            "color": "#99ff93",
            "name": "Completed",
            "celebrationEnabled": false,
            "isArchived": false,
            "order": 2,
            "statusType": "normal",
            "timeInStatus": 0
        },
        "sourceDetails": "",
        "source": {
            "_id": "65338d9cf781c59be3859c6a",
            "name": "Manually created",
            "color": "#efe0da",
            "isArchived": false,
            "order": 1
        },
        "createdBy": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test User",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "completedTime": "2023-11-08T07:01:30.450Z",
        "activityLostReason": null,
        "createdAt": "2023-11-08T07:01:05.770Z"
    }
}

curl --request GET \
  --url https://api.zixflow.com/api/v1/collection-records/activity-list/{activityId} \
  --header 'Authorization: Bearer <token>'

{
    "status": true,
    "message": "Records fetched successfully",
    "data": {
        "_id": "654b3231448888ff7d161a59",
        "name": "Call HOH",
        "scheduleAt": "2023-11-08T07:01:00.000Z",
        "description": "",
        "associated": null,
        "assignee": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test User",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "status": {
            "_id": "65338d9cf781c59be3859c63",
            "color": "#99ff93",
            "name": "Completed",
            "celebrationEnabled": false,
            "isArchived": false,
            "order": 2,
            "statusType": "normal",
            "timeInStatus": 0
        },
        "sourceDetails": "",
        "source": {
            "_id": "65338d9cf781c59be3859c6a",
            "name": "Manually created",
            "color": "#efe0da",
            "isArchived": false,
            "order": 1
        },
        "createdBy": {
            "_id": "65338d9a4d3b7a624a8d63ab",
            "name": "Test User",
            "avatar": "",
            "email": "user@zixflow.com"
        },
        "completedTime": "2023-11-08T07:01:30.450Z",
        "activityLostReason": null,
        "createdAt": "2023-11-08T07:01:05.770Z"
    }
}

Path

Response

API Documentation

OTPflow Message

Whatsapp Campaign

RCS Campaign

SMS Campaign

Email Campaign

Campaign Report

Collections

Lists

Attributes

Collection Records

List Entries

Activity / Task

Workspace Members

Get Activity By Id

Path

Response

​Path

​Response

API Documentation

OTPflow Message

Whatsapp Campaign

RCS Campaign

SMS Campaign

Email Campaign

Campaign Report

Collections

Lists

Attributes

Collection Records

List Entries

Activity / Task

Workspace Members

​Path

​Response

Path

Response

Path

Response