Skip to main content
GET
Get mock API data

Headers

mocklyapiauthtoken
string

Authentication token required for private endpoints. Can also be provided via query parameter.

Path Parameters

mockApiId
string<uuid>
required

Unique identifier for the mock API

Query Parameters

auth_token
string

Authentication token required for private endpoints. Can also be provided via header.

filters
string

URL-encoded filter conditions to apply on the mock data. Supports operators: $eq, $eqi, $ne, $nei. Multiple conditions are combined with AND logic.

order_by
string

Field name to sort results by. Supports nested paths using dot notation (e.g., 'profile.firstName').

order_direction
enum<string>
default:asc

Sort direction for the order_by field

Available options:
asc,
desc
limit
number

Maximum number of results to return. Must be 0 or greater.

Required range: x >= 0

Response

Successful response with mock data