PlatformDocs
MCP server

get_list

Returns one list with its contacts or companies, page by page.

View as Markdown

Get a list · Read-only

Returns one list with its contacts or companies, page by page. Returns 404 when the list is not one of this website's.

ConnectionAccount URL, team member URL or OAuth

Parameters

ParameterTypeRequiredAcceptsDescription
websiteIdstringYesanyWebsite ID from list_websites.
listTypestringYescontact, companycontact for lists of people, company for lists of companies.
listIdstringYesany_id from list_lists.
pagenumberNomin 1Page of items, starting at 1.
limitnumberNomin 1Items per page.

Tool definition

What your assistant receives from tools/list:

{
  "name": "get_list",
  "title": "Get a list",
  "annotations": {
    "title": "Get a list",
    "readOnlyHint": true,
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "websiteId": {
        "type": "string",
        "description": "Website ID from list_websites."
      },
      "listType": {
        "type": "string",
        "enum": [
          "contact",
          "company"
        ],
        "description": "contact for lists of people, company for lists of companies."
      },
      "listId": {
        "type": "string",
        "description": "_id from list_lists."
      },
      "page": {
        "type": "number",
        "minimum": 1,
        "description": "Page of items, starting at 1."
      },
      "limit": {
        "type": "number",
        "minimum": 1,
        "description": "Items per page."
      }
    },
    "required": [
      "websiteId",
      "listType",
      "listId"
    ]
  }
}

On this page