logo

Retrieve TaxJar credentials

Retrieves a list of TaxJar credentials.

SecuritySecretApiKey or JWT
Request
query Parameters
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

q
string

Use this field to perform a partial search of text fields.

Responses
200

List of TaxJar credentials retrieved.

Response Schema: application/json
Array
apiToken
required
string <password>

TaxJar API token.

hash
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

status
string

Status of the credential.

Enum: Description
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

deactivationTime
string <date-time>

Date and time when the credential is deactivated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/credential-hashes/taxjar
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Create a TaxJar credential