Plain icon

Plain

Interact with Plain API

Actions23

Tenant → Get

AI-generated

Overview

This node interacts with the Plain API to manage tenants and other related resources. Specifically, for the Tenant - Get operation, it retrieves tenant details by either Tenant ID or External ID. This is useful in scenarios where you need to fetch tenant information for further processing, reporting, or integration workflows.

Practical examples include:

  • Fetching tenant details to synchronize with another system.
  • Retrieving tenant metadata before performing updates or linking customers.
  • Using tenant info to filter or route data in automation workflows.

Properties

Name Meaning
Get By Method to identify the tenant. Options: Tenant ID, External ID.
Tenant ID The unique identifier of the tenant (used if "Get By" is set to "Tenant ID").
External ID The external identifier of the tenant (used if "Get By" is set to "External ID").

Output

The output JSON contains the tenant's detailed information as returned by the Plain API, including:

  • id: Unique tenant identifier.
  • name: Tenant name.
  • externalId: External identifier of the tenant.
  • url: URL associated with the tenant.
  • createdAt.iso8601: Creation timestamp in ISO 8601 format.
  • updatedAt.iso8601: Last update timestamp in ISO 8601 format.

If no tenant is found, the output will be an empty object {}.

No binary data output is produced by this operation.

Dependencies

  • Requires a valid API key credential configured in n8n to authenticate with the Plain API.
  • Uses GraphQL queries/mutations to interact with the Plain API endpoints.
  • The node depends on internal helper functions (plainApiRequest) to perform API requests.

Troubleshooting

  • Error: Tenant identifier data is incomplete
    Occurs if the required tenant identification parameter is missing or malformed. Ensure that when selecting "Get By", the corresponding ID field is filled correctly.

  • API errors from Plain API
    If the API returns an error message, it will be thrown as a node operation error. Check the error message for details such as invalid IDs or permission issues.

  • Empty result
    If the tenant does not exist for the given ID or external ID, the output will be empty. Verify the correctness of the input identifiers.

  • Authentication failures
    Make sure the API key credential is properly set up and has sufficient permissions to query tenant data.

Links and References

Discussion