Nookal icon

Nookal

Interact with Nookal practice management system via GraphQL API

Actions14

Overview

This node integrates with the Nookal practice management system via its GraphQL API, allowing users to retrieve and manage various resources such as patients, appointments, practitioners, and locations. Specifically, for the Location resource with the Get All operation, the node fetches a list of all locations registered in the Nookal system.

This operation is useful when you want to obtain an overview of all physical or virtual locations associated with a medical practice, including their contact details and timezone information. For example, a healthcare administrator might use this node to synchronize location data into another system or generate reports on available clinic sites.

Properties

Name Meaning
Limit Max number of results to return. Accepts a number between 1 and 100. Defaults to 50.

Output

The output JSON contains a list of location objects under the locations.edges array. Each location object includes:

  • id: Unique identifier of the location.
  • name: Name of the location.
  • address: An object containing:
    • street
    • city
    • state
    • postcode
    • country
  • phone: Contact phone number.
  • email: Contact email address.
  • timezone: Timezone of the location.
  • createdAt: Timestamp when the location was created.
  • updatedAt: Timestamp when the location was last updated.

Additionally, pagination information is provided under pageInfo, which includes:

  • hasNextPage: Boolean indicating if more pages are available after the current one.
  • hasPreviousPage: Boolean indicating if there are pages before the current one.
  • startCursor: Cursor marking the start of the current page.
  • endCursor: Cursor marking the end of the current page.

This structure allows for efficient handling of large datasets with pagination support.

Dependencies

  • Requires an active connection to the Nookal practice management system via its GraphQL API.
  • Requires an API authentication token configured in n8n credentials (an OAuth2 API key credential).
  • The node depends on the internal helper function to make authenticated GraphQL requests to Nookal.

Troubleshooting

  • Invalid JSON in variables field: If using custom queries with variables, ensure that the JSON syntax is correct; otherwise, the node will throw an error.
  • Unknown operation errors: Selecting an unsupported operation for the Location resource will result in an error indicating the operation is unknown.
  • API Authentication Errors: Ensure that the API key or OAuth2 credentials are correctly set up and have sufficient permissions.
  • Limit out of range: The limit property must be between 1 and 100; values outside this range may cause errors or unexpected behavior.

Links and References

Discussion