List Access Keys

An access key provides authentication to use the Taxcloud API.

Note: Currently, keys generated via the TaxCloud web app do not include the necessary scopes to interact with the Management API. To request access, contact our support team.

Query parameters

limitlongOptionalDefaults to 20

Maximum results per page

cursorstringOptional

The position from where the page should start. This can be found in the result of a previous api call and should be used on subsequent api calls to get the next group of records

ascendingbooleanOptionalDefaults to false

Whether you want the results to be ascending.

sortByenumOptionalDefaults to id

The field you want to sort by.

Allowed values:

Response

itemslist of objects

limitlong

Maximum results per page

$schemastringOptionalformat: "uri"

A URL to the JSON Schema for this object.

nextCursorstringOptional

1	{
2	"items": [
3	{
4	"apiKey": "apiKey",
5	"createdAt": "2024-01-15T09:30:00Z",
6	"grants": [
7	{
8	"audience": "audience",
9	"id": 1000000,
10	"scopes": [
11	"scopes"
12	]
13	}
14	],
15	"id": 1000000,
16	"name": "name",
17	"updatedAt": "2024-01-15T09:30:00Z",
18	"$schema": "https://example.com/mgmt/schemas/AccessKeyResponse.json"
19	}
20	],
21	"limit": 1000000,
22	"$schema": "https://example.com/mgmt/schemas/ListResultAccessKeyResponse.json",
23	"nextCursor": "nextCursor"
24	}

Headers

Query parameters

Response

Errors

1	curl https://api.v3.taxcloud.com/mgmt/accesskeys \
2	-H "X-API-KEY: <apiKey>"