List Properties

List properties for your account.

get/v1/properties

Request

Base URL
https://sandboxapi.givechariot.com
URL
https://sandboxapi.givechariot.com/v1/properties
Auth
HTTP bearer

Query parameters

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

page_tokenstring

The cursor to use for pagination. If not set, the first page of results will be returned.

resource_type'donation' | 'deposit'

The API resource that the property is associated with.

The type of the resource that the properties are associated with.

Response

The response for Properties.list

next_page_tokenstring

A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

Example response

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

Changes

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