> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/hubspot/getcontacts.md). # GetContacts Retrieves contacts from HubSpot. Task version: 1.0.0 Required Frends version: 5.7+ Required .NET version: 8.0 Compatible Agents: Crossplatform Source code: ## Task Parameters {% tabs %} {% tab title="Input" %} | Name | Description | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | FilterQuery : `String` |

Optional. Filter query to narrow search results in a simple expression format: property operator 'value'

Default: -
Example: email eq ''

| | Properties : `String[]` |

Optional. Specific contact properties to retrieve.

Default: -
Example: new string\[] { "email", "firstname", "lastname", "company" }

| | Limit : `Int32` |

Optional. Maximum number of contacts to return.

Default: 100
Example: 50

| | After : `String` |

Optional. Paging cursor for fetching the next page.

Default: -
Example: "MjAyMy0wMS0wMVQwMDowMDowMC4wMDAtMTI6MDA"

| | {% endtab %} | | {% tab title="Connection" %} | Name | Description | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | 🗝ApiKey : `String` |

HubSpot Private App access token.

Default: -
Example: xxx-xxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

| | BaseUrl : `String` |

Base URL for the API.

Default: -
Example: .

| | {% endtab %} | | {% tab title="Options" %} | Name | Description | | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | IncludeArchived : `Boolean` |

Optional. Whether to include archived records. Default is false.

Default: False
Example: true

| | ThrowErrorOnFailure : `Boolean` |

Whether to throw an error on failure. True by default.

Default: True
Example: false

| | ErrorMessageOnFailure : `String` |

Overrides the error message on failure.

Default: -
Example: Failed to retrieve contacts.

| | {% endtab %} | | | {% endtabs %} | | ## Task Result | Name | Description | | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | Success : `Boolean` |

Indicates if the operation completed successfully.
Example: true

| | Contacts : `JToken` |

Array of contact objects.
Example: \[{ "id": "1", "properties": { "email": "", "firstname": "John" } }]

| | HasMore : `Boolean` |

Whether there are more results to retrieve.
Example: true

| | NextPageCursor : `String` |

Cursor for next page of results, if any.
Example: "MjAyMy0wMS0wMVQwMDowMDowMC4wMDAtMTI6MDA"

| | Error : `Error` |

Error that occurred during task execution.
Example: object { string Message, object { Exception Exception } AdditionalInfo }

| | Error.Message : `String` |

Summary of the error.
Example: Unable to retrieve contacts.

| | Error.AdditionalInfo : `Exception` |

Additional information about the error.
Example: object { Exception Exception }

| ## Task Changelog Changelog for Task Frends.HubSpot.GetContacts. ### \[1.0.0] - 2025-07-30 #### Added * Initial implementation --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.frends.com/tasks/tasks/hubspot/getcontacts.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.