Skip to main content
GET
/
accounts
/
self
/
ai
/
custom-fields
List AI custom field definitions
curl --request GET \
  --url https://restapi.fax.plus/v3/accounts/self/ai/custom-fields \
  --header 'Authorization: Bearer <token>'
{
  "records": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Invoice Number",
      "instructions": "Extract the invoice or reference number from the document",
      "enabled": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://apidoc.fax.plus/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

OAuth2 Authorization Grant

Response

Response containing a list of custom field definitions

List of AI custom field definitions

records
object[]

List of custom field definitions