Skip to main content
POST
/
v1
/
platform
/
listings
/
{model_key}
Search Your Records
curl --request POST \
  --url https://api-sandbox.finogates.com/v1/platform/listings/{model_key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": [
    {
      "field": "<string>",
      "op": "eq",
      "value": null
    }
  ],
  "sort": [
    {
      "field": "<string>",
      "dir": "desc"
    }
  ],
  "include": [
    "<string>"
  ],
  "search": "<string>",
  "cursor": "<string>",
  "include_deleted": false,
  "limit": 50
}
'
{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123,
  "row_count": 1,
  "limit": 2,
  "current_page": 2,
  "total_page_number": 1,
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
model_key
string
required

Body

application/json

Listing request supporting filters, sort, includes, search, and cursor pagination.

​
filters
ListingFilter · object[]
​
sort
ListingSort · object[]
​
include
string[]

Relationship paths to include.

​
search
string | null
​
cursor
string | null
​
include_deleted
boolean
default:false
​
limit
integer
default:50
Required range: 1 <= x <= 200

Response

Successful Response

Standard response wrapper for list responses.

Declare ListResponse[list[SomeModel]] to render the real data array schema in OpenAPI/Swagger; a bare ListResponse leaves data untyped.

​
status_code
integer
required

HTTP status code for the response.

​
data
any
required

Payload or error details.

​
query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.

​
row_count
integer
required

Total rows matching the request filters (not just this page).

Required range: x >= 0
​
limit
integer | null

Page size used for this response. Null for cursor-paginated endpoints.

Required range: x >= 1
​
current_page
integer | null

1-indexed page number for this response. Null for cursor-paginated endpoints.

Required range: x >= 1
​
total_page_number
integer | null

Total number of pages given the current limit. Null for cursor-paginated endpoints.

Required range: x >= 0
​
next_cursor
string | null

Cursor for the next page, if available.