Requests

All API access is over HTTPS. You should always verify the peer's SSL certificate.

Authentication Header

For subsequent requests, the JWT obtained from the initial authentication must be included in the Authorization header:

Accept-Version Header

To ensure that you are using API version 2.0, the Accept-Version header must be set to v2:

Request Data

If your request body contains data, it has to be sent as JSON.

Managing Lists

The responses of List endpoints can be sorted and filtered, with the following syntax. Note that attributes that can be used for filtering are different for each individual list endpoint and will be documented with each endpoint.

Sorting

You can specify a sort field with the ?sort parameter.

Examples

To sort ascending by created_at:

curl https://www.givve.com/api/card_orders?sort=created_at \ 
  -H 'Authorization: Bearer -- JWT --'

Prepending a - will sort descending:

curl https://www.givve.com/api/card_orders?sort=-created_at \ 
  -H 'Authorization: Bearer -- JWT --'

Multiple sort fields can be combined by ,. To sort by state and identical states by created_at (descending):

curl https://www.givve.com/api/card_orders?sort=state,-created_at \ 
  -H 'Authorization: Bearer -- JWT --'

Filtering

We provide several filters you can use to specify conditions that resources must satisfy to be selected. The filters are specified with the ?filter parameter.

Multiple filter parameters can be specified at once. The following request returns vouchers created after 2017-06-20 but before 2017-06-30.

curl -g https://www.givve.com/api/vouchers?filter[created_at][$gt]=2017-06-20&filter[created_at][$lt]=2017-06-30 \
  -H 'Accept-Version: v2' \
  -H 'Authorization: Bearer -- JWT --'

$in Filter

The $in filter selects resources where the value of an attribute equals any of the specified values.

?filter[attribute][$in]=value
?filter[attribute][$in]=value_1,value_2

$nin Filter

The $nin filter selects resources where the value of an attribute doesn't equal any of the specified values.

?filter[attribute][$nin]=value
?filter[attribute][$nin]=value_1,value_2

$gte Filter

The $gte filter selects resources where the value of an attribute is greater than or equal to the specified value.

?filter[attribute][$gte]=value

$lte Filter

The $lte filter selects resources where the value of an attribute is less than or equal to the specified value.

?filter[attribute][$lte]=value

$gt Filter

The $gt filter selects resources where the value of an attribute is greater than the specified value.

?filter[attribute][$gt]=value

$lt Filter

The $lt filter selects resources where the value of an attribute is less than the specified value.

?filter[attribute][$lt]=value

Authentication Header#

Accept-Version Header#

Request Data#

Managing Lists#

Sorting#

Examples#