Skip to main content
GET
List Certificates
Lists the exemption certificates on file for your customers, newest first, including those still in review or rejected.
  • Filters combine with AND. Repeat a filter to match any of its values, for example ?status=needs_review&status=rejected.
  • jurisdiction also matches places under it: USA.S-IL finds a certificate that covers USA.S-IL.M-CHICAGO.
  • status combines the review and the dates. needs_review and rejected certificates exempt nothing, whatever their dates say. Treat the list of values as open, because Taxwire can add more.
  • Certificates of deleted customers, and emailed certificates not yet linked to a customer, are left out.
See Listing certificates for examples.

Authorizations

X-API-Key
string
header
required

Query Parameters

limit
integer
default:100

Page size, between 1 and 1000.

Required range: 1 <= x <= 1000
starting_after
string | null

Return certificates after this one. Pass the id of the last certificate from the previous page to fetch the next page.

customer_id
string[] | null

Only certificates belonging to these customers. At most 100 values.

Maximum array length: 100
exemption_type
enum<string>[] | null

Only certificates with these exemption types.

Available options:
agriculture,
direct_pay,
driveaway,
govt_exempt_org,
manufacturing,
resale,
other
status
enum<string>[] | null

Only certificates with these statuses.

Available options:
valid,
expired,
not_yet_active,
needs_review,
rejected
jurisdiction
string[] | null

Only certificates covering these jurisdictions, given as political paths. A path also matches the jurisdictions under it: USA.S-IL matches a certificate for USA.S-IL.M-CHICAGO. At most 100 values.

Maximum array length: 100

Response

Successful Response

List envelope for GET /certificates, cursor-paged by id.

has_more
boolean
required

More results available

Examples:

true

false

object
string
default:list
url
string
default:/certificates
data
CertificateResource · object[]

A page of certificates, newest first.