Skip to content
DonorIntel Knowledge Base

List Custom Fields

GET
/v1/custom-fields/

List custom field definitions. Filter by entity_type to use the schema cache.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
entity_type
Any of:
string

Filter by entity type (e.g. donor, gift)

active_only
Active Only
boolean
default: true
limit
Limit

Records per page

integer
default: 50 >= 1 <= 200

Records per page

after
Any of:
string

Cursor from previous page’s next_cursor

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

PaginatedResponse[TenantFieldSchemaSummary]
object
data
required
Data
Array<object>
TenantFieldSchemaSummary

Lightweight projection for use in list / picker responses.

object
id
required
Id
string format: uuid
field_key
required
Field Key
string
label
required
Label
string
field_type
required
FieldType

Supported custom field types. These drive both validation logic and frontend component rendering. Adding a new type here requires matching handling in validator.py.

string
Allowed values: text textarea number currency date boolean select multi_select url
is_required
required
Is Required
boolean
sort_order
required
Sort Order
integer
is_active
required
Is Active
boolean
pagination
required
PaginationMeta

Pagination metadata included in list responses.

object
has_more
required
Has More
boolean
next_cursor
Any of:
string
total
Any of:
integer
meta
ResponseMeta

Metadata included in every response envelope.

object
request_id
Any of:
string
organization_id
Any of:
string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object