FLfleetio
Custom Fields

List Custom Fields

Changed on

Returns a list of custom fields defined for your account.

For details, please see our guide on Custom Fields.

get/custom_fields

Request

Query parameters

start_cursorstring

The start cursor for Keyset pagination.

per_pageinteger

The number of records per page to return.

The fields, operations, and values to filter the records by.

id'asc' | 'desc'
created_at'asc' | 'desc'
updated_at'asc' | 'desc'

The fields and direction to sort the results by.

Response

OK

start_cursorstring nullable

The current start cursor of the records returned.

next_cursorstring nullable

The next cursor to retrieve the next page of records.

per_pageinteger

The maximum number of records returned.

estimated_remaining_countinteger

The number of remaining records including the returned records, up to a maximum of 500.

Example response

{
  "records": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "association_type": "contact|equipment|vehicle|vendor",
      "custom_object_key": "bill|accident",
      "calculated_custom_field_config": {
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "formula": "subtotal + tax",
        "variables": [
          "subtotal",
          "tax"
        ]
      }
    }
  ]
}

Changes

  • 49558d744bd7Revision changes
    • warning

      added the new currency enum value to the // response property for the response status

    • warning

      added the new number enum value to the // response property for the response status

    • info

      for the query request parameter per_page, the min was decreased from 2.00 to 1.00

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status