> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# appmixer.zoho.crm.ListRecords

- Component: `appmixer.zoho.crm.ListRecords`
- Kind: Action
- Version: 2.0.0
- Visibility: Public
- Connector: [appmixer.zoho.crm 2.4.5](https://connectors.appmixer.com/connector/appmixer.zoho.crm/2.4.5.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.zoho.crm/2.4.5/component/appmixer.zoho.crm.ListRecords>

When triggered, returns a list of records for specified module.

## Properties

_No properties defined._

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Module (`moduleName`) | select | Module |
| IDs (`ids`) | text | Specify the IDs seperated by comma to filter reocords. |
| Send all records at once (`allAtOnce`) | toggle | Set it to true to send all records in one message. If false, it will send one message per each record. Order of the records is not guaranteed. |

## Output ports

### Port `out`

Variables are loaded dynamically from `/component/appmixer/zoho/crm/ListRecords?outPort=out`.

## Full metadata (component.json)

```json
{
  "name": "appmixer.zoho.crm.ListRecords",
  "author": "Zulkafil Tabish <zulkafil@client.io>",
  "description": "When triggered, returns a list of records for specified module.",
  "version": "2.0.0",
  "private": false,
  "auth": {
    "service": "appmixer:zoho"
  },
  "quota": {
    "manager": "appmixer:zoho",
    "resources": "requests",
    "maxWait": 5000,
    "scope": {
      "userId": "{{userId}}"
    }
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "moduleName": {
            "type": "string",
            "enun": [
              "Leads",
              "Accounts",
              "Contacts",
              "Deals",
              "Campaigns",
              "Tasks",
              "Cases",
              "Events",
              "Calls",
              "Solutions",
              "Products",
              "Vendors",
              "Price Books",
              "Quotes",
              "Sales Orders",
              "Purchase Orders",
              "Invoices",
              "Custom",
              "Activities"
            ]
          },
          "ids": {
            "type": "string"
          },
          "allAtOnce": {
            "type": "boolean"
          }
        },
        "required": [
          "moduleName"
        ]
      },
      "inspector": {
        "inputs": {
          "moduleName": {
            "type": "select",
            "label": "Module",
            "index": 1,
            "tooltip": "Module",
            "defaultValue": "Contacts",
            "options": [
              {
                "label": "Contacts",
                "value": "Contacts"
              },
              {
                "label": "Leads",
                "value": "Leads"
              },
              {
                "label": "Accounts",
                "value": "Accounts"
              },
              {
                "label": "Deals",
                "value": "Deals"
              },
              {
                "label": "Campaigns",
                "value": "Campaigns"
              },
              {
                "label": "Tasks",
                "value": "Tasks"
              },
              {
                "label": "Cases",
                "value": "Cases"
              },
              {
                "label": "Events",
                "value": "Events"
              },
              {
                "label": "Calls",
                "value": "Calls"
              },
              {
                "label": "Solutions",
                "value": "Solutions"
              },
              {
                "label": "Products",
                "value": "Products"
              },
              {
                "label": "Vendors",
                "value": "Vendors"
              },
              {
                "label": "Price Books",
                "value": "Price Books"
              },
              {
                "label": "Quotes",
                "value": "Quotes"
              },
              {
                "label": "Sales Orders",
                "value": "Sales Orders"
              },
              {
                "label": "Purchase Orders",
                "value": "Purchase Orders"
              },
              {
                "label": "Invoices",
                "value": "Invoices"
              },
              {
                "label": "Activities",
                "value": "Activities"
              }
            ]
          },
          "ids": {
            "type": "text",
            "label": "IDs",
            "index": 2,
            "tooltip": "Specify the IDs seperated by comma to filter reocords."
          },
          "allAtOnce": {
            "type": "toggle",
            "label": "Send all records at once",
            "tooltip": "Set it to true to send all records in one message. If false, it will send one message per each record. Order of the records is not guaranteed.",
            "defaultValue": false,
            "index": 3
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "source": {
        "url": "/component/appmixer/zoho/crm/ListRecords?outPort=out",
        "data": {
          "properties": {
            "generateOutputPortOptions": true
          },
          "messages": {
            "in/moduleName": "inputs/in/moduleName",
            "in/allAtOnce": "inputs/in/allAtOnce"
          }
        }
      }
    }
  ],
  "properties": {
    "schema": {
      "properties": {
        "generateOutputPortOptions": {
          "type": "boolean"
        }
      }
    }
  },
  "icon": "(data URI omitted)"
}
```
