WAwafeq
Custom Fields

Retrieve custom field

Endpoint for retrieving a single custom field.

get/custom-fields/{id}/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/custom-fields/{id}/
  • Auth
    API key in header Authorization

Path parameters

idstring required

A unique value identifying this custom field.

Response

apply_toApplyToEnum[] required

The groups this custom field applies to.

View the enum reference

created_tsstring date-time required

The timestamp in UTC when the custom field was created.

field_type'TEXT' | 'LONG_TEXT' | 'NUMBER' | 'DATE' | 'SELECT' | 'LOOKUP' | 'CALCULATED' required

Data type of a custom field.

View the enum reference

idstring required

The unique identifier of the custom field.

is_activeboolean

Whether the custom field is active.

is_line_item_fieldboolean

Whether the custom field is set on line items instead of on the document.

modified_tsstring date-time required

The timestamp in UTC when the custom field was last modified.

namestring

The English name of the custom field.

name_arstring

The Arabic name of the custom field.

Changes

No recorded changes to this operation across all 2 revisions of this API.