List Custom Form Template

Endpoint URL

https://{{base_url}}/api/v2/custom-form-template

Authentication and rate limits

Item	Details
Authentication method	OAuth 2.0 Bearer token
Rate limit	Rate Limit

Requests Example

curl --request GET \
  --url 'https://{{base_url}}/api/v2/custom-form-template/?company=1' \
  --header 'Authorization: Bearer $BEARER_TOKEN'

curl --request GET \
  --url 'https://dashboard-api.revnue.com/api/v2/custom-field-template/$id/?company=1' \
  --header 'Authorization: Bearer $BEARER_TOKEN'

Query Parameters

company (integer) --
[REQUIRED]
The ID of the specific company your API is calling. For accounts with only one company, the default value is 1.
To lookup a specific company ID, see the List Company API.
id (integer) --
Optional if you want to list a specific custom form template ID. The id parameter is passed as part of the request url /custom-form-template/$id/.

Response Syntax

{
    "id": integer,
    "name": "string",
    "form_title": "string",
    "type":  "asset" | "contract" | "customer" | "supplier",
    "form_desc": "string",
    "is_active":  true|false,
    "is_default": true|false,
    "fields": [
        {
            "id": integer,
            "name": "string",
            "data_type": "date" | "money" | "number" | "text" | "attachment",
            "is_active": true|false,
            "order": integer
        }
    ]
}

Response Fields

id (integer) --
The ID of the custom form template.
name (string) --
The name of the custom form template.
form_title (string) --
The title of the custom form template.
type (string) --
The type of the custom form template.
form_desc (string) --
The description of the custom form template.
is_active (boolean) --
Whether the custom form template is active.
is_default (boolean) --
Whether the custom form template is set as default form.
fields (list) --
The list of the custom form properties.
- id (integer) --
  The ID of the custom form.
- name (string) --
  The name of the custom form.
- data_type (string) --
  The data type of the custom form.
- is_active (boolean) --
  Whether the custom form is active.
- order (integer) --
  The display order of the custom form.