API Reference

Retrieve custom schema data

get
https://{env}.gainsystems.com/api/v1/custom/

Returns the records stored under a custom schema route, a page at a time. Each record's fields are nested under its own Data object, unlike the flat records POST /api/v1/custom/{apiRoute} accepts. See Custom Schema.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The configured custom schema route to read data from

Query Params
string

Opaque cursor identifying the page to return. Omit for the first page, then pass the NextCursor value from the previous response

integer
1 to 1000
Defaults to 100

Maximum number of records to return in one page, from 1 to 1000. Default 100. On endpoints that group records under an item (for example, policies and forecasts), the limit applies to item/location records, so a page can return fewer top-level items than Size

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated 3 months ago

Did this page help you?