v2

latestOpenAPI 3.0.02026-07-261859071.2 MB
Accounts

List current account members and pending invites

get/v1/accounts/me/members

Query parameters

searchstring

Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.

Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.

type'member' | 'invite'

Filter by account member list item type.

Filter by account member list item type.

role'OWNER' | 'ADMIN' | 'READ_WRITE' | 'READ_RUN' | 'READ_ONLY'

Filter by account role. Valid filters may produce no results for invites.

Filter by account role. Valid filters may produce no results for invites.

status'ACTIVE' | 'PENDING' | 'EXPIRED'

Filter by member or invite status. Valid filters may produce no results for some item types.

Filter by member or invite status. Valid filters may produce no results for some item types.

limitinteger

Page length. Omitted returns all matching members and invites.

Page length. Omitted returns all matching members and invites.

nextIdstring

Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.

Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.

Headers

x-checkly-accountstring uuid

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

Successful

lengthinteger required

Number of items returned in this page. This is not the total matching count.

nextIdstring nullable required

Opaque cursor for the next page. Null means there are no more results.