PopoOpenPlatform Api icon

PopoOpenPlatform Api

POPO OpenPlatform API

Overview

The "搜索用户" (Search User) operation of the 用户 (User) resource in the PopoOpenPlatform Api node allows you to search for users within the POPO OpenPlatform system based on a provided search key. This is useful in scenarios where you need to look up user information dynamically, such as automating onboarding workflows, verifying user existence, or integrating with other systems that require user data retrieval by keyword.

Practical examples:

  • Automate employee lookup by name or email before assigning tasks.
  • Validate if a user exists before sending notifications or invitations.
  • Build integrations that sync user directories between POPO and other platforms.

Properties

Name Type Meaning
searchKey String The keyword used to search for users. This could be a name, email, etc.

Output

The output will be an array of JSON objects representing the users found matching the searchKey. Each object contains user details as returned by the POPO OpenPlatform API. The exact structure depends on the API response, but typically includes fields like user ID, name, email, and other profile information.

Example output:

[
  {
    "userId": "12345",
    "name": "张三",
    "email": "zhangsan@example.com",
    // ...other user fields
  }
]

Dependencies

  • External Service: Requires access to the POPO OpenPlatform API.
  • API Key/Credentials: You must configure the popoOpenPlatformApi credentials in n8n for authentication.

Troubleshooting

Common issues:

  • Invalid or missing credentials: Ensure your API credentials are correctly set up in n8n.
  • Empty results: If no users match the searchKey, the output array will be empty. Double-check your search term.
  • API errors: Errors from the POPO API (e.g., rate limits, permission denied) will be surfaced as node errors in n8n. Review the error message for details.

Error messages and resolutions:

  • "Authentication failed": Check your API credentials.
  • "Missing required parameter: searchKey": Make sure you provide a value for the Search Key property.
  • "Request failed with status code 4xx/5xx": Indicates an issue with the request or server; check network connectivity and API status.

Links and References

Discussion