appCustomFieldDefinitions

Requires at least one of the permissions customers:customer:read, payments:collection:read, products:product:read, purchase:debit_note:read, purchase:grn:read, purchase:payment:read, purchase:purchase_invoice:read, purchase:purchase_order:read, sales:credit_note:read, sales:quote:read, sales:sales_invoice:read, sales:sales_order:read, sales:shipment:read or suppliers:supplier:read.

The calling app's own custom fields (its namespace, archived included). Needs read_custom_fields.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query AppCustomFieldDefinitions {
  appCustomFieldDefinitions {
    id
    type
    appAccess
    archived
    carryForward
    defaultValue
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query AppCustomFieldDefinitions {\n  appCustomFieldDefinitions {\n    id\n    type\n    appAccess\n    archived\n    carryForward\n    defaultValue\n  }\n}"
}
EOF

Response:

{
  "data": {
    "appCustomFieldDefinitions": [
      {
        "id": "id",
        "type": "string",
        "appAccess": "string",
        "archived": true,
        "carryForward": true,
        "defaultValue": {}
      }
    ]
  }
}

appCustomFieldDefinitions: [CustomFieldDefinition!]!

Type

CustomFieldDefinition object

A field the organization added to one kind of record.