Get a Property | Chariot

Get a property by its unique identifier.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

The unique identifier for the property

Response

The property was retrieved

idstringRead-only

The unique identifier for the property.

namestring

The name of the property.

resource_typeenum

The API resource that the property is associated with.

Allowed values:

property_typeenum

The data type of a property.

Allowed values:

optionslist of objects or null

The first 25 options for enum and user properties. Use the List Property Options endpoint to paginate through all options.

total_option_countinteger or null

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.

1	import requests
2
3	url = "https://api.givechariot.com/v1/properties/property_01j8rs605a4gctmbm58d87mvsj"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": "property_01j8rs605a4gctmbm58d87mvsj",
3	"name": "Donation Purpose",
4	"resource_type": "donation",
5	"property_type": "text",
6	"options": [
7	{
8	"id": "string",
9	"name": "string",
10	"description": "string"
11	}
12	],
13	"total_option_count": 1
14	}

Authentication

Path parameters

Response

Errors