Teachworks icon

Teachworks

Student and Customer operations in Teachworks

Actions6

Overview

The Teachworks Students - Search operation allows you to search for student records in Teachworks based on a variety of criteria. This node is useful when you need to filter or locate specific students by attributes such as name, contact information, school, grade, subject, customer type, status, and more.

Common scenarios:

  • Finding all students with a particular last name or email address.
  • Filtering students by their school, grade, or subject.
  • Retrieving active, inactive, or prospective students.
  • Paginating through large lists of students.

Practical examples:

  • Retrieve all students named "John" in grade 10 at "Central High School".
  • List all inactive students for follow-up.
  • Find students associated with a specific customer ID.

Properties

Name Meaning
Search Options A collection of filters to narrow down the student search. Each option below can be set individually:
— Customer ID Filter students by their associated customer ID.
— First Name Filter students by their first name.
— Last Name Filter students by their last name.
— Email Filter students by their email address.
— Phone Number Filter students by their phone number.
— School Filter students by their school name.
— Grade Filter students by their grade level.
— Subject Filter students by their subject.
— Customer type Filter by customer type. Options: Family, Independent.
— Status Filter by student status. Options: Active, Inactive, Prospective.
— Direction Sort the results. Options: Ascending, Descending.
— Page The page number for paginated results (useful for navigating large result sets).
— Per Page The number of results per page (controls how many students are returned in one request).

Output

The output will be a JSON array where each item represents a student matching the search criteria. Each student object typically contains fields such as:

{
  "id": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "phone_number": "string",
  "school": "string",
  "grade": "string",
  "subject": "string",
  "customer_id": "string",
  "type": "family|independent",
  "status": "active|inactive|prospective",
  ...
}

Note: The exact structure may include additional fields depending on the Teachworks API response.

Dependencies

  • External Service: Requires access to the Teachworks API.
  • API Key: You must configure Teachworks API credentials in n8n under the credential type teachworksApi.
  • n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

  • Invalid Credentials: If your API key is incorrect or missing, you may receive authentication errors. Ensure your Teachworks API credentials are correctly configured in n8n.
  • No Results Returned: If your search criteria are too restrictive, no students may match. Try broadening your filters.
  • Pagination Issues: If you do not specify Page and Per Page, you may get only the default number of results. Adjust these values to retrieve more data.
  • Error Messages:
    • "401 Unauthorized": Check your API credentials.
    • "400 Bad Request": One or more input parameters may be invalid; review your search options.
    • "429 Too Many Requests": You have hit the API rate limit; try again later.

Links and References

Discussion