Skip to main content

REST Explorer

REST Explorer is an integrated API testing tool built into the Developer Portal. Test your endpoints without leaving the browser.

Features

  • Visual Request Builder — Build requests using dropdowns and checkboxes
  • Multi-Tab Interface — Test multiple requests simultaneously
  • User Context — Test as different users or service accounts
  • Export Options — Copy as cURL or share URLs

Building Requests

HTTP Methods

Select from GET, POST, PUT, PATCH, or DELETE.

Entity Selection

Choose a collection, view, or query from the dropdown. The URL updates automatically.

Query Options

OptionDescription
PropertiesSelect which fields to return
SortingChoose sort field and direction
PaginationSet page size and number
CountInclude total count in metadata

Filtering

Build filters visually:

  1. Add conditions with property, operator, and value
  2. Combine with AND/OR logic
  3. Create nested groups for complex queries

Available operators:

  • Equals / Not equals
  • Contains / Starts with / Ends with
  • Greater than / Less than
  • Is empty / Is not empty

Request Body

For POST, PUT, and PATCH requests:

  • Full-featured JSON editor with syntax highlighting
  • Click Generate Example for sample data
  • Toggle system fields (id, created, updated)

User Context

The Current User Context control in the sidebar lets you test requests as different users. This is a global setting that affects REST Explorer, Data Explorer, and Function Testing.

OptionDescription
System UserFull access with "Skip roles" enabled (default)
UnauthenticatedTest public/anonymous access
API UsersTest as specific end users or service accounts

Options

OptionDescription
Skip Security PolicyBypass relationship-based restrictions
Skip RolesIgnore role-based access control (auto-enabled for System user)

Tokens are automatically generated when you select a user. Use this to test access control and data visibility for different user types.

Response View

Responses display with:

  • Syntax highlighting
  • Color-coded status (green for 2xx, red for 4xx/5xx)
  • Execution time in milliseconds
  • Total count (if enabled)

Export Options

ActionDescription
Copy URLCopy the complete request URL
Copy as cURLGenerate cURL command for terminal use