Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions68

Overview

The "Get Many" operation for the "Custom Field Block" resource in this node retrieves multiple custom field blocks from the Magnet Customer API. Custom field blocks are likely groups or collections of custom fields associated with various features such as contacts, deals, organizations, or staff.

This operation is useful when you want to fetch a list of these blocks, possibly filtered and sorted according to specific criteria, to integrate or synchronize custom metadata structures within your workflows. For example, you might use it to dynamically load available custom field blocks for further processing or reporting in your automation.

Properties

Name Meaning
Authentication Method of authentication to use: API Token or OAuth2
Page The page number of results to retrieve (pagination)
Limit Maximum number of results to return per request
Filters Collection of filters to narrow down results:
- Feature: Filter blocks by feature type; options: Contact, Deal, Organization, Staff
- Emails Empty: Boolean filter to include only blocks with empty emails
- Phones Empty: Boolean filter to include only blocks with empty phones
- Interactions Empty: Boolean filter to include only blocks with empty interactions
Sort Sorting options for the results:
- Sort By: Field to sort by (e.g., email, name, createdAt)
- Sort Type: Direction of sorting; options: Ascending, Descending

Note: Several hidden properties related to "Life Cycle" and "Source" exist but are not exposed for user input in this operation.

Output

The output is an array of JSON objects representing the retrieved custom field blocks. Each object contains the data fields returned by the Magnet Customer API for a custom field block, which typically includes identifiers, names, associated features, and possibly metadata about contained custom fields.

No binary data output is indicated for this operation.

Dependencies

  • Requires access to the Magnet Customer API.
  • Requires either an API token credential or OAuth2 authentication configured in n8n.
  • The node uses internal helper functions to make authenticated HTTP requests to the API endpoints corresponding to custom field blocks.

Troubleshooting

  • Common issues:
    • Authentication failures due to invalid or expired API tokens or OAuth2 credentials.
    • Pagination parameters (page and limit) set incorrectly may result in no data or incomplete data.
    • Filters that do not match any records will return empty results.
  • Error messages:
    • Errors thrown by the API (e.g., unauthorized, bad request) will be surfaced as error messages.
    • If "Continue On Fail" is enabled, errors for individual items will be included in the output with an error field describing the issue.
  • Resolutions:
    • Verify API credentials and refresh tokens if necessary.
    • Adjust pagination and filter settings to valid values.
    • Check API documentation for correct usage of filter and sort fields.

Links and References

If you need details on other operations or resources, feel free to ask!

Discussion