CHchariot-giving
properties

Get a Property

Get a property by its unique identifier.

get/v1/properties/{id}

Request

  • Base URL
    https://sandboxapi.givechariot.com
  • URL
    https://sandboxapi.givechariot.com/v1/properties/{id}
  • Auth
    HTTP bearer

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

No recorded changes to this operation across all 12 revisions of this API.