Handling results

Pagination

Endpoints that return a list of resources are paginated. The response has the following format:

{
items: [ ... ]
item_count: 10
total_items: 15
page_count: 2
next: "https://api.abowire.com/v1/subscription?page=2&limit=10"
previous: ""
}

The next and previous fields are a handy way to make it easier for you to make the followup requests.

Query parameters

All list results in Abowire can receive some parameters that help you get the data in the way you need it.

Query parameter

Description

Options

sort

Define the order of the results

ASC or DESC

limit

Define how many results to return

1-100

output

Format in which to return the results

json or csv

filter

Add conditions to filter out results

See below

Filtering results

You can narrow down your search by filtering your results with the filter query parameter.

Filter

Example

Date from

filter[creation_date][from]

Date until

filter[creation_date][to]

Boolean

filter[is_active]=true

IsNull

filter[deleted]=isNull

isNotNull

filter[deleted]=isNotNull

Keyword

filter[name]=John