Lectful Central icon

Lectful Central

Interact with the Lectful Central API for admin operations

Actions63

Overview

The "List Tenants" operation of the Lectful Central node retrieves a paginated list of tenants from the Lectful Central API. This is useful for administrators or systems that need to manage or audit tenant accounts within a multi-tenant environment. The node supports searching tenants by company name, first name, or last name, and allows control over pagination through page number and items per page.

Practical examples:

  • An admin dashboard fetching tenant lists to display in a UI.
  • Automated workflows that process or report on tenant data regularly.
  • Integration with other systems requiring tenant information synchronization.

Properties

Name Meaning
Authentication Mode Choose how to authenticate with the Lectful Central API:
- Use Stored Credentials
- Manual Configuration (provide base URL and API key manually)
Credentials Note Notice shown when using Manual Configuration mode explaining credential overrides.
Base URL Override Optional base URL to override the stored credential's base URL (without /api/v1).
API Key Override Optional API key to override the stored credential's API key.
Page Page number for pagination (default: 1).
Per Page Number of tenants to retrieve per page (default: 15).
Search Search string to filter tenants by company name, first name, or last name.

Output

The output is an array of JSON objects representing the API response for the tenant list request. Each item corresponds to one API response per input item processed.

  • The JSON structure contains tenant details as returned by the Lectful Central API under the /admin/tenants endpoint.
  • Pagination metadata may be included depending on the API response.
  • No binary data is output by this operation.

Example output snippet (conceptual):

{
  "data": [
    {
      "id": "tenant_123",
      "company_name": "Example Corp",
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@example.com",
      ...
    },
    ...
  ],
  "pagination": {
    "page": 1,
    "per_page": 15,
    "total_pages": 10,
    "total_items": 150
  }
}

Dependencies

  • Requires access to the Lectful Central API.
  • Authentication via either stored credentials configured in n8n or manual entry of base URL and API key.
  • The node expects the API to be reachable at the specified base URL with valid authentication tokens.
  • No additional external libraries beyond standard HTTP request helpers provided by n8n.

Troubleshooting

  • Missing or invalid credentials: If neither stored credentials nor manual overrides are properly set, the node will throw an error indicating missing credentials. Ensure credentials are configured correctly or manual parameters are provided.
  • Base URL Override required in manual mode: When using manual authentication mode, the base URL override must be provided; otherwise, an error is thrown.
  • API errors: Any API error responses will be surfaced as errors unless "Continue On Fail" is enabled, in which case error messages are returned in the output JSON.
  • Pagination parameters: Providing invalid page or per-page values may result in unexpected results or API errors.
  • Search parameter encoding: The search string is URL-encoded internally; ensure special characters are handled appropriately.

Links and References

Discussion