CAcampfire
Company Objects

List Custom Fields

    List all custom fields for a given app and model.

    Supports including soft-deleted records for audit and recovery purposes.
    When include_deleted=true, returns ONLY deleted records instead of active records.
    Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp,
    and 'last_modified_at'. When 'false' or omitted, returns ONLY active records.
    This provides clean separation between active and deleted data.
get/ca/api/v1/custom-fields

Request

Query parameters

appstring

App name

include_deletedboolean

When set to 'true', returns ONLY deleted records instead of active records. Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp, and 'last_modified_at'. When 'false' or omitted, returns ONLY active records. This provides clean separation between active and deleted data.

is_activeboolean

Filter by active status

last_modified_at__gtestring

Filter for records modified on or after this timestamp. Format: ISO 8601 (e.g., '2024-01-01T00:00:00Z' or '2024-01-01'). Works with both active records and deleted records (filters by deletion time for deleted records).

last_modified_at__ltestring

Filter for records modified on or before this timestamp. Format: ISO 8601 (e.g., '2024-12-31T23:59:59Z' or '2024-12-31'). Works with both active records and deleted records (filters by deletion time for deleted records).

limitinteger

Number of results to return per page.

modelstring

Model name

offsetinteger

The initial index from which to return the results.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

No recorded changes to this operation across all 1 revision of this API.