Actions6
- Customer Actions
- Student Actions
Overview
The Teachworks Customers node for n8n enables you to search for customer records in the Teachworks platform based on a variety of criteria. This is particularly useful for automating workflows that require filtering or retrieving customer data, such as syncing customer lists, segmenting users for marketing, or preparing reports.
Practical examples:
- Find all customers with a specific email address.
- Retrieve customers from a particular city or country.
- Filter customers by status (active/inactive) or type (family/independent).
- Paginate through large sets of customer data.
Properties
| Name | Meaning |
|---|---|
| Search Options | A collection of fields to filter your customer search. Includes: - First Name: Customer's first name - Last Name: Customer's last name - Email: Customer's email address - Phone Number: Customer's phone number - City: Customer's city - State: Customer's state - Country: Customer's country - Zip Code: Customer's zip/postal code - Customer type: Type of customer; options: Family, Independent - Status: Customer status; options: Active, Inactive - Direction: Sort order; options: Ascending, Descending - Page: Page number for pagination - Per Page: Number of results per page |
Output
The node outputs a list of customer records matching the specified search criteria. Each output item contains customer details as returned by the Teachworks API. The structure typically includes fields such as:
{
"id": "12345",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone_number": "+1234567890",
"city": "New York",
"state": "NY",
"country": "USA",
"zip": "10001",
"type": "family",
"status": "active"
// ...other fields provided by Teachworks
}
- The actual fields may vary depending on the Teachworks API response.
- The output is always in JSON format; binary data is not produced by this operation.
Dependencies
- External Service: Requires access to the Teachworks API.
- API Key: You must configure Teachworks API credentials in n8n under the name
teachworksApi. - Environment: No additional environment variables are required beyond standard n8n credential setup.
Troubleshooting
Common issues:
- Invalid Credentials: If the API key is missing or incorrect, authentication errors will occur. Ensure your Teachworks API credentials are correctly set up in n8n.
- No Results Returned: If your search filters are too restrictive, no customers may be found. Try broadening your search criteria.
- Pagination Issues: If you request a page number that exceeds available pages, the result may be empty.
- API Rate Limits: Excessive requests may trigger rate limiting by Teachworks. Monitor your usage if you encounter unexpected failures.
Error messages and resolutions:
- 401 Unauthorized: Check your Teachworks API credentials.
- 400 Bad Request: Review your input parameters for typos or invalid values.
- 500 Internal Server Error: This indicates an issue on the Teachworks side; try again later or contact Teachworks support.