GEThttps://core-api.heysadie.ai/capture-forms
limit offset assistantId success data captureForms id name trigger introMessage emailRecipients smsRecipients fields key question type action required options wait_for_response prompt properties isActive createdAt updatedAt total metadata timestamp version path error code message details fieldList capture forms
Try it in the API ExplorerExample request
Terminal
curl "https://core-api.heysadie.ai/capture-forms?limit=10&offset=0" \
-H "Authorization: ApiKey YOUR_API_KEY"Authentication
Authenticate with an API key in the Authorization header using the ApiKey scheme — see Authentication for how keys work and where to get them.
AuthorizationstringrequiredAPI key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.
X-Tenant-Idstring (uuid)optionalRequired when authenticating with an organization key — selects the tenant the request acts on. Omit with tenant keys.
Request
Query parameters
limitstringoptionalPage size. Default 50, maximum 500.
offsetstringoptionalItems to skip. Default 0.
assistantIdstringoptionalUUID of the assistant.
Responses
200
successbooleanrequireddataobjectoptionalShow 2 child properties
captureFormsobject[]requiredShow 12 item properties
idstringrequiredassistantIdstringrequirednamestringrequiredtriggerstringrequiredintroMessagestringrequiredemailRecipientsstring[] | nullrequiredsmsRecipientsstring[] | nullrequiredfieldsobject[]requiredShow 8 item properties
keystringrequiredquestionstringrequiredtypeenumrequiredAllowed values:
"string""number"actionstringoptionalrequiredbooleanoptionaloptionsstring[]optionalwait_for_responsebooleanoptionalpromptstringoptionalpropertiesanyrequiredisActiveboolean | nullrequiredcreatedAtstring (date-time) | string (date) | number | nullrequiredupdatedAtstring (date-time) | string (date) | number | nullrequiredtotalnumberrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional400
successbooleanrequirederrorobjectoptionalShow 3 child properties
codeenumrequiredAllowed values:
"VALIDATION_ERROR"messagestringrequireddetailsobject[]optionalShow 2 item properties
fieldstringrequiredmessagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional401
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequiredAllowed values:
"UNAUTHORIZED"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional403
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequiredAllowed values:
"FORBIDDEN"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional404
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequiredAllowed values:
"RESOURCE_NOT_FOUND"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional500
successbooleanrequirederrorobjectoptionalShow 2 child properties
codeenumrequiredAllowed values:
"INTERNAL_SERVER_ERROR"messagestringrequiredmetadataobjectoptionalShow 3 child properties
timestampstringrequiredversionstringrequiredpathstringoptional