Plain icon

Plain

Interact with Plain API

Actions23

Customer → Get

AI-generated

Overview

This node integrates with the Plain API to manage customer data and related entities. Specifically, for the Customer resource with the Get operation, it retrieves detailed information about a customer by their email address.

Typical use cases include:

  • Fetching customer details in workflows that require customer verification or enrichment.
  • Automating customer support processes by retrieving customer profiles based on email.
  • Integrating customer data into other systems or reports.

Example: Given a customer's email, the node queries the Plain API and returns the customer's ID, full name, short name, external ID, email verification status, and timestamps of creation and last update.

Properties

Name Meaning
Email The email address of the customer to retrieve. This is a required string input property.

Output

The output JSON object contains the customer details as returned by the Plain API, including:

  • id: Unique identifier of the customer.
  • email: Object containing:
    • email: The customer's email address.
    • isVerified: Boolean indicating if the email is verified.
    • verifiedAt.iso8601: Timestamp of when the email was verified.
  • fullName: Customer's full name.
  • shortName: Customer's short name or nickname.
  • externalId: External identifier associated with the customer.
  • createdAt.iso8601: Timestamp of customer creation.
  • updatedAt.iso8601: Timestamp of last update.

If the customer is not found, the output will be an empty object.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Plain API.
  • Relies on the Plain API GraphQL endpoint to perform queries and mutations.
  • No additional external dependencies are needed beyond the configured API credential.

Troubleshooting

  • Common issues:

    • Providing an invalid or unregistered email will result in no customer data returned (empty object).
    • Network or authentication errors if the API key is missing, invalid, or expired.
    • API rate limits may cause temporary failures.

  • Error messages:

    • Errors from the Plain API are thrown as node operation errors with descriptive messages.
    • If the email parameter is missing or empty, the node will throw an error because it is required.
    • If the API returns an error, the message from the API is propagated to help diagnose the issue.

  • Resolution tips:

    • Ensure the email input is correctly formatted and corresponds to an existing customer.
    • Verify the API key credential is properly set up and has necessary permissions.
    • Check network connectivity and Plain API service status.
    • Use "Continue On Fail" option in the node settings to handle errors gracefully in workflows.

Links and References

Discussion