Custom REST API

Reads from any JSON HTTP endpoint. For SaaS apps without a dedicated connector, internal APIs, and public datasets over HTTP.

Connect

Set the endpoint

URL: full URL with host and path (e.g. https://api.example.com/v1/transactions).
HTTP method: GET, POST, PUT, or DELETE.

Auth and headers

API key: optional. Sent as Authorization: Bearer <key>.
Custom headers: optional, JSON. Use this for non-Bearer auth (X-API-Key, basic auth, vendor specific) and for Content-Type, Accept.

{
  "X-API-Key": "your-key",
  "Accept": "application/json"
}

Test and save

Flitch sends the request and shows the parsed response. Confirm the array of records was found.

Field mapping

The response must be either:

A bare JSON array, or
An object with an array under a top level field ({ data: [...] }, { items: [...] }, etc.).

Each record becomes a row. Nested fields flatten with dot notation: { user: { name: "Ada" } } becomes user.name.

Refresh

Refresh is off by default. Every dashboard load runs a live request. Enable refresh to schedule a background refresh and serve from cache between runs. See Refresh.

Pagination is not configurable in the form. For paginated endpoints, point at a page large enough to cover what you need, or wrap behind an endpoint that returns everything. For OAuth secured APIs (where users sign in through a provider), use a dedicated connector or contact us about adding one.

Troubleshooting

401 Unauthorized. Check the API key or custom auth header. Test with curl first.

No array of records found. Response is JSON but the records array wasn't located. Check Test connection for the parsed response. Adjust the endpoint or contact us if the shape is exotic.

Timeout. Default 30 seconds. If your API takes longer, contact hello@flitch.io.