# GetContacts Required Frends version: 5.7+ Required .NET version: 8.0 Compatible Agents: Unknown Source code: {% tabs %} {% tab title="Parameter: 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="Parameter: 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="Parameter: 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 %} | | {% tab title="Result: 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 }

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[1.0.0] - 2025-07-30 #### Added * Initial implementation {% endtab %} {% endtabs %}