Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Account Settings → Get Roles

AI-generated

Summary

Retrieve the list of roles available in the user's Yext account, supporting batching and custom request options.

Inputs

  • Request Options — Configure request behaviors such as batching (items per batch and batch interval), SSL validation bypass, HTTP proxy, and request timeout.

Output shape

a list of role objects — each representing a role in the Yext account.

Supports batching of requests controlled by 'Items per Batch' and 'Batch Interval'. Output includes role data per the Yext Knowledge API response schema. Errors are returned in standard n8n error format.

Examples

Example 1: Fetch all roles with default request options.

No additional request options specified; defaults used.

Discussion