List Custom Field Template

Endpoint URL

https://dashboard-api.revnue.com/api/v2/custom-field-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://dashboard-api.revnue.com/api/v2/custom-field-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 field template ID. The id parameter is passed as part of the request url /custom-field-template/$id/.

Response Syntax

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

Response Fields

id (integer) --
The ID of the custom field template.
name (string) --
The name of the custom field template.
is_active (boolean) --
Whether the custom field template is active.
type (string) --
The type of the custom field template.
fields (list) --
The list of the custom field properties.
- id (integer) --
  The ID of the custom field.
- name (string) --
  The name of the custom field.
- data_type (string) --
  The data type of the custom field.
- is_active (boolean) --
  Whether the custom field is active.
- order (integer) --
  The display order of the custom field.