> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zixflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get List of Activities

> This endpoint returns all activity data

#### Body

<ParamField body="filter" type="array">
  An array that will eventually allow users to define specific criteria for
  filtering data. Currently, it is an empty array, indicating that no filtering
  is applied at this time.
</ParamField>

<ParamField body="sort" type="array">
  An array that will eventually enable users to specify sorting criteria for the
  data. Like the filter array, it is currently empty, implying that no sorting
  is applied in the current context.
</ParamField>

<ParamField body="limit" type="number" required>
  he number of records to be returned, set to 10 in this instance. This
  parameter restricts the response to a specific quantity of records.
</ParamField>

<ParamField body="offset" type="number" required>
  The starting point from which the records are to be fetched within the entire
  dataset. In this case, it is set to 0, indicating that retrieval should
  commence from the beginning of the dataset.
</ParamField>

#### Response

<ResponseField name="status" type="boolean">
  Indicates the success or failure of the record retrieval. In this case, true
  signifies a successful operation.
</ResponseField>

<ResponseField name="message" type="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."
</ResponseField>

<ResponseField name="data" type="array_object">
  An array containing details of the fetched records. For each record
  in the data array:

  <Expandable title="data">
    <ResponseField name="_id" type="string">
      A unique identifier for the record, allowing for precise referencing.
    </ResponseField>

    <ResponseField name="name" type="string">
      The name associated with the record.
    </ResponseField>

    <ResponseField name="scheduleAt" type="string">
      The scheduled time for the record in ISO 8601 format.
    </ResponseField>

    <ResponseField name="description" type="string">
      Additional information or details about the record.
    </ResponseField>

    <ResponseField name="associated" type="null">
      Details about any associated entity, if applicable.
    </ResponseField>

    <ResponseField name="assignee" type="object">
      Details about the assignee of the record:

      <Expandable title="assignee">
        <ResponseField name="_id" type="string">
          Unique identifier for the assignee.
        </ResponseField>

        <ResponseField name="name" type="string">
          The name of the assignee.
        </ResponseField>

        <ResponseField name="avatar" type="string">
          URL or information about the assignee's avatar.
        </ResponseField>

        <ResponseField name="email" type="string">
          Email address of the assignee.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="status" type="object">
      Details about the status of the record:

      <Expandable title="status">
        <ResponseField name="_id" type="string">
          Unique identifier for the status.
        </ResponseField>

        <ResponseField name="color" type="string">
          Hex color code representing the status color.
        </ResponseField>

        <ResponseField name="name" type="string">
          The name of the status.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="sourceDetails" type="string">
      Additional details about the source of the record.
    </ResponseField>

    <ResponseField name="source" type="object">
      Details about the source of the record:

      <Expandable title="source">
        <ResponseField name="_id" type="string">
          Unique identifier for the source.
        </ResponseField>

        <ResponseField name="name" type="string">
          The name of the source.
        </ResponseField>

        <ResponseField name="color" type="string">
          Hex color code representing the source color.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdBy" type="object">
      Details about the creator of the record:

      <Expandable title="createdBy">
        <ResponseField name="_id" type="string">
          Unique identifier for the creator.
        </ResponseField>

        <ResponseField name="name" type="string">
          The name of the creator.
        </ResponseField>

        <ResponseField name="avatar" type="string">
          URL or information about the creator's avatar.
        </ResponseField>

        <ResponseField name="email" type="string">
          Email address of the creator.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="completedTime" type="string">
      The timestamp when the record was completed in ISO 8601 format.
    </ResponseField>

    <ResponseField name="activityLostReason" type="null">
      Reason for any lost activity, if applicable.
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      The timestamp when the record was created in ISO 8601 format.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200-Success theme={null}
  {
      "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"
          }
      ]
  }
  ```

  ```json 401-Unauthorised theme={null}
  {
    "status": false,
    "message": "No token provided"
  }
  ```
</ResponseExample>