Skip to main content
GET
List Gift Custom Fields
Each value comes back with its customFieldName, value, and responseType, plus the customCollectionName when the field belongs to a collection.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

giftId
integer<int64>
required

The ID of the gift.

Query Parameters

Filter
string

A free-text search term applied to the custom field names and values in the results.

Skip
integer<int32>

The number of records to skip before the first record returned. Use it with take to page through the results.

Take
integer<int32>

The maximum number of records to return in this page of results.

SortBy
enum<string>

Field to sort by (case-insensitive). Valid options: createddate, createddatetimeutc, customfield, customfieldname, id, modifieddatetimeutc, name, response, type, value

Available options:
createddate,
createddatetimeutc,
customfield,
customfieldname,
id,
modifieddatetimeutc,
name,
response,
type,
value
Descending
boolean

The direction to sort the results. Set to true to sort in descending order.

IncludeDetails
boolean

When true, includes the related records for each item in the response. Not every list has extra records to return, and it can slow down large result sets.

Response

OK

A page of custom field responses with the total number that match the request.

items
object[]

The custom field responses in this page of results.

total
integer<int32>

The total number of custom field responses that match the request. Use it with skip and take to page through the full set.

Last modified on July 28, 2026