Saved Queries

See Saved Queries on how to create a saved query. The URL can be found on the Execute Query screen.

get
Use Access Token to Call Cinchy APIs

https://<Cinchy Web URL>/API/MyDomain/MyQuery
To access any Cinchy Saved Query API, pass the access token received from the Bearer Token Request in the Authorization header, prefixed by "Bearer".
Request
Response
Request
Headers
Authorization
required
string
Bearer <token goes here>
Query Parameters
WrapSingleRecordInArray
optional
boolean
Default is true. Add this parameter and set to false if you want single record results returned as an object instead of within an array.
@param
optional
string
If you have parameters in your query, you pass them in directly as query parameters.
CompressJSON
optional
boolean
Default is true. Add this parameter and set to false if you want the JSON that is returned to be expanded rather than having the schema being returned separately.
Response
200: OK

Example

%40 is the URL encoded version of @, if you are passing them in as parameters you will need to include the %40 in front of your parameter name.