> 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).

# Get Record

- Component: `appmixer.zoho.bigin.GetRecord`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.zoho.bigin 1.0.0](https://connectors.appmixer.com/connector/appmixer.zoho.bigin/1.0.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.zoho.bigin/1.0.0/component/appmixer.zoho.bigin.GetRecord>

Get a record of a Bigin module by its ID.

## Properties

_No properties defined._

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Module (`module`) | select | The Bigin module. Companies are `Accounts` and pipeline records (deals) are `Pipelines` in the API. |
| Record ID (`recordId`) | text | The ID of the record, for example `2034020000000489022`. |
| Fields (`fields`) | text | Comma separated field API names to return, for example `Last_Name,Email` (at most 50). Leave empty to return the fields of the module (the first 50 from its field metadata). |

## Output ports

### Port `out`

Variables are loaded dynamically from `/component/appmixer/zoho/bigin/GetRecord?outPort=out&ignoreAuth=true`.

## Full metadata (component.json)

```json
{
  "name": "appmixer.zoho.bigin.GetRecord",
  "label": "Get Record",
  "description": "Get a record of a Bigin module by its ID.",
  "author": "Appmixer <info@appmixer.com>",
  "version": "1.0.0",
  "auth": {
    "service": "appmixer:zoho:bigin"
  },
  "quota": {
    "manager": "appmixer:zoho:bigin",
    "resources": "requests",
    "scope": {
      "userId": "{{userId}}"
    }
  },
  "properties": {
    "schema": {
      "properties": {
        "generateOutputPortOptions": {
          "type": "boolean"
        }
      }
    }
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "module": {
            "type": "string",
            "enum": [
              "Contacts",
              "Pipelines",
              "Accounts",
              "Products",
              "Tasks",
              "Events",
              "Calls"
            ]
          },
          "recordId": {
            "type": "string"
          },
          "fields": {
            "type": "string"
          }
        },
        "required": [
          "module",
          "recordId"
        ]
      },
      "inspector": {
        "inputs": {
          "module": {
            "type": "select",
            "index": 1,
            "label": "Module",
            "defaultValue": "Contacts",
            "tooltip": "The Bigin module. Companies are <code>Accounts</code> and pipeline records (deals) are <code>Pipelines</code> in the API.",
            "options": [
              {
                "label": "Contacts",
                "value": "Contacts"
              },
              {
                "label": "Pipelines",
                "value": "Pipelines"
              },
              {
                "label": "Companies",
                "value": "Accounts"
              },
              {
                "label": "Products",
                "value": "Products"
              },
              {
                "label": "Tasks",
                "value": "Tasks"
              },
              {
                "label": "Events",
                "value": "Events"
              },
              {
                "label": "Calls",
                "value": "Calls"
              }
            ]
          },
          "recordId": {
            "type": "text",
            "index": 2,
            "label": "Record ID",
            "tooltip": "The ID of the record, for example <code>2034020000000489022</code>."
          },
          "fields": {
            "type": "text",
            "index": 3,
            "label": "Fields",
            "tooltip": "Comma separated field API names to return, for example <code>Last_Name,Email</code> (at most 50). Leave empty to return the fields of the module (the first 50 from its field metadata)."
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "source": {
        "url": "/component/appmixer/zoho/bigin/GetRecord?outPort=out&ignoreAuth=true",
        "data": {
          "properties": {
            "generateOutputPortOptions": true
          },
          "messages": {
            "in/module": "inputs/in/module",
            "in/recordId": "0"
          }
        }
      }
    }
  ],
  "icon": "(data URI omitted)"
}
```
