properties

Get a Property

Get a property by its unique identifier.

get/v1/properties/{id}

Path parameters

idstring required

The unique identifier for the property

Response

The property was retrieved

idstring required

The unique identifier for the property.

namestring required

The name of the property.

resource_type'donation' | 'deposit' required

The API resource that the property is associated with.

property_type'text' | 'enum' | 'user' | 'boolean' | 'date' required

The data type of a property.

total_option_countinteger

The total number of options for enum and user properties. When this is greater than the length of options, use the List Property Options endpoint to paginate through all options.

Example response

{
  "id": "prop_01j8rs605a4gctmbm58d87mvsj",
  "name": "Donation Purpose",
  "property_type": "text"
}

Changes

Changed in 4 of the 41 revisions of this API.25545

Jun 29, 2026b87f7738d3361025See the full diff
- ▲
  removed the required property code from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 500 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 500 status
  response-required-property-removed
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 400
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 401
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 403
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 404
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 500
  response-media-type-name-specialized
- ○
  added the required property detail to the response with the 400 status
  response-required-property-added
- ○
  added the required property detail to the response with the 401 status
  response-required-property-added
- ○
  added the required property detail to the response with the 403 status
  response-required-property-added
- ○
  added the required property detail to the response with the 404 status
  response-required-property-added
- ○
  added the required property detail to the response with the 500 status
  response-required-property-added
- ○
  added the required property status to the response with the 400 status
  response-required-property-added
- ○
  added the required property status to the response with the 401 status
  response-required-property-added
- ○
  added the required property status to the response with the 403 status
  response-required-property-added
- ○
  added the required property status to the response with the 404 status
  response-required-property-added
- ○
  added the required property status to the response with the 500 status
  response-required-property-added
- ○
  added the required property title to the response with the 400 status
  response-required-property-added
- ○
  added the required property title to the response with the 401 status
  response-required-property-added
- ○
  added the required property title to the response with the 403 status
  response-required-property-added
- ○
  added the required property title to the response with the 404 status
  response-required-property-added
- ○
  added the required property title to the response with the 500 status
  response-required-property-added
- ○
  added the required property type to the response with the 400 status
  response-required-property-added
- ○
  added the required property type to the response with the 401 status
  response-required-property-added
- ○
  added the required property type to the response with the 403 status
  response-required-property-added
- ○
  added the required property type to the response with the 404 status
  response-required-property-added
- ○
  added the required property type to the response with the 500 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 29, 2026c65f43c5ad905See the full diff
- ●
  removed the optional property details from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 500 status
  response-optional-property-removed
Jun 25, 2026f89b4f376e9415See the full diff
- ○
  added the optional property details/items/debug to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 500 status
  response-optional-property-added
Jun 25, 202690671617b825155See the full diff
- ▲
  the code response's property type/format changed from number/ to string/ for status 400
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 401
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 403
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 404
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 500
  response-property-type-changed
- ▲
  removed the required property error from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 500 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 500 status
  response-required-property-removed
- ○
  added the optional property details to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history