Get constraints

GET

https://api.x.flatfile.com/v1/apps/:appId/constraints

GET

/v1/apps/:appId/constraints

1 import { FlatfileClient } from "@flatfile/api";
2 
3 const client = new FlatfileClient({ token: "YOUR_TOKEN" });
4 await client.apps.getConstraints("appId");

Try it

200Retrieved

1 {
2   "data": [
3     {
4       "id": "id",
5       "appId": "appId",
6       "validator": "validator",
7       "createdAt": "2024-01-15T09:30:00Z",
8       "updatedAt": "2024-01-15T09:30:00Z",
9       "description": "description",
10       "function": "function",
11       "options": {
12         "key": "value"
13       },
14       "label": "label"
15     },
16     {
17       "id": "id",
18       "appId": "appId",
19       "validator": "validator",
20       "createdAt": "2024-01-15T09:30:00Z",
21       "updatedAt": "2024-01-15T09:30:00Z",
22       "description": "description",
23       "function": "function",
24       "options": {
25         "key": "value"
26       },
27       "label": "label"
28     }
29   ]
30 }

Returns constraints for an app

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

appIdstringRequired

ID of the app

Query Parameters

includeBuiltinsbooleanOptional

Whether to include built-in constraints

Response

This endpoint returns an object.

datalist of objects

Authentication

Path Parameters

Headers

Query Parameters

Response