List account keys

get https://app.modzy.com/api/accounting/accounts/{accountId}/access-keys

This endpoint returns an account’s list of active API keys. It can be sorted by prefix, keyType, name, status, createdAt, updatedAt, lastActiveDateTime, user.firstName, user.lastName, and roles.identifier.

🚧
Roles
Projects cannot access this route.

📘
Filters and pagination
This collection route supports filters and pagination.

Path Params

accountId

string

required

The account’s identifier.

Query Params

prefix

string

Filters by a key’s prefix and returns similar matches

name

string

Filters by a key’s nickname and returns similar matches.

status

string

Filters by a key’s status and returns exact matches. Values can be Active, Inactive, Pending, Rejected, or Deleted.

description

string

Filters by a key’s description and returns similar matches.

roles.identifier

string

Filters by a role’s identifier and returns exact matches.

labels.identifier

string

Filters by a key’s type and priority. Values can be default and high_priority_job_execution.

user.identifier

string

Filters by a user’s identifier and returns similar matches.

user.externalIdentifier

string

Filters by a user’s email and returns similar matches.

user.firstName

string

Filters by a user’s first name and returns similar matches.

user.lastName

string

Filters by a user’s last name and returns similar matches.

user.email

string

Filters by a user’s email and returns similar matches.

user.title

string

Filters by a user’s title and returns similar matches.

user.status

string

Filters by a user’s status and returns similar matches.

user.visited

string

Filters by user’s that have or have not been seen in the User Management UI. Values can be true or false.

user.onboarded

string

Filters by user’s that have or have not visited their profile page. Values can be true or false.

Body Params

status

string

required

The API key’s status. Values can be Active, Inactive, Pending, Rejected, or Deleted.

Responses

Language

Credentials

Header

Request


xxxxxxxxxx
1
GET /api/accounting/accounts/demo_account/access-keys HTTP/1.1
2
Host: app.modzy.com
3
Authorization: ApiKey apiKey.modzy
4
Accept: application/json
5
Content-Type: application/json

Choose an example:

application/json

List account keys

🚧
Roles

📘
Filters and pagination

🚧Roles

📘Filters and pagination

200200

400400

🚧
Roles

📘
Filters and pagination