List Custom Form Template

List all (or one) custom field templates.

Endpoint URL

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

Authentication and rate limits

ItemDetails
Authentication methodOAuth 2.0 Bearer token
Rate limitRate 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
        }
    ]
}
Language
Click Try It! to start a request and see the response here!