Filtering - Stackone

List endpoints filter on parameters named after the field being matched. Each endpoint’s reference page lists the filters it accepts and where to send them. For example, returning only active accounts:

curl "https://api.stackone.com/v2/accounts?status=active" \
  -u "$STACKONE_API_KEY:"

Multiple values

A filter that accepts several values takes them comma-separated or repeated, and matches a record with any of them. These two requests are equivalent:

curl "https://api.stackone.com/v2/accounts?connector_key=workday,bamboohr" \
  -u "$STACKONE_API_KEY:"

curl "https://api.stackone.com/v2/accounts?connector_key=workday&connector_key=bamboohr" \
  -u "$STACKONE_API_KEY:"

Repeat the parameter when a value could itself contain a comma. Otherwise the two forms behave identically.

Filtering in the request body

The log list endpoints take their filters as a filters object in the JSON body rather than as query parameters, because the set does not fit in a URL. Here a filter that accepts several values takes a JSON array, so neither comma-separated form above applies. For example, server errors from two connectors:

curl -X POST "https://api.stackone.com/logs" \
  -u "$STACKONE_API_KEY:" \
  -H "Content-Type: application/json" \
  -d '{"filters": {"status_code": ["500", "502"], "connector_key": ["workday", "bamboohr"]}}'

Combining filters

Different filters narrow the result together, so a request carrying both returns only the records matching both:

curl "https://api.stackone.com/v2/accounts?connector_key=workday&status=active" \
  -u "$STACKONE_API_KEY:"