API Reference

Query (v3)

post
https://api.fireberry.com/api/v3/query

Search, filter, sort, aggregate, and paginate records from any object using a structured JSON body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Please note

Use v3 query requests to search, filter, sort, aggregate, and paginate records from any object using a structured JSON body. For a detailed guide on all properties and examples, click here.

Body Params
int32
required

The numeric object type code to query.

fields
array of objects
required

The fields to include in the response. At least one field must be specified.

fields*
filter
array of objects

An array of condition groups. Groups are joined with AND logic between them.

filter
orderBy
array of objects

Fields to sort results by. When groupBy is present, all orderBy fields must also appear in the groupBy array.

orderBy
groupBy
array of objects

Fields to group results by. Required when using aggregation functions.

groupBy
int32
≥ 1
Defaults to 1

The page number to return.

int32
1 to 500
Defaults to 25

The number of records per page.

Responses

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago