Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Staff → Get Many

AI-generated

Overview

This node interacts with the Magnet Customer API to retrieve multiple staff records. It supports pagination through 'page' and 'limit' parameters, allowing users to control the number of staff entries returned per request. This operation is useful for scenarios where a user needs to fetch a list of staff members, such as for displaying in a dashboard, syncing staff data with another system, or processing staff-related workflows.

Use Case Examples

  1. Fetching the first 15 staff members to display in a user interface.
  2. Retrieving staff data in batches for synchronization with an external HR system.

Properties

Name Meaning
Authentication Method of authentication to use for the API request, either API Token or OAuth2.
Page The page number of results to retrieve, used for pagination.
Limit Maximum number of staff records to return in one request, with a minimum value of 15.

Output

JSON

  • _id - Unique identifier of the staff member.
  • fullname - Full name of the staff member.
  • email - Email address of the staff member.
  • active - Boolean indicating if the staff member is currently active.
  • role - Role assigned to the staff member.
  • customFields - Custom fields associated with the staff member, if any.

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure correct authentication method is selected and credentials are valid to avoid authentication errors.
  • Verify that the 'page' and 'limit' parameters are set correctly to avoid empty or incomplete results.
  • If custom fields are not resolving correctly, check the 'Resolve Custom Fields' option and API permissions.

Discussion