Community Create Account Sign in

Overview
API Reference

Community Create Account Sign in

API Reference Apps

Get constraint by ID

GET

GET

1 curl https://api.x.flatfile.com/v1/apps/appId/constraints/constraintId \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "data": {
3     "id": "id",
4     "appId": "appId",
5     "validator": "validator",
6     "createdAt": "2024-01-15T09:30:00Z",
7     "updatedAt": "2024-01-15T09:30:00Z",
8     "description": "description",
9     "function": "function",
10     "options": {
11       "key": "value"
12     },
13     "label": "label"
14   }
15 }

Returns a specific constraint

Path parameters

appIdstringRequired

ID of the app

constraintIdstringRequired

ID of the constraint

Headers

AuthorizationstringRequired

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

X-Disable-Hooks"true"Required

Response

This endpoint returns an object.

dataobject

Was this page helpful?

Get constraint versions