GuidesAPI ReferenceChangelogDiscussions
Log In
API Reference

List access grants on an address

  • Permission: ADDRESS_MANAGEMENT
  • Roles: extended_user, flex_management

Lists which customers may reach this address, joined with their name and email. A grant whose customer is not yet in our directory is still returned, with those fields absent. Note that role is filtered by Ampere rather than upstream, so meta.total counts the grants on the address before the role filter is applied.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

UUID of the address

Query Params
string
enum

Only return grants at this access level. Filtered by Ampere — amber’s connection filter has no role field.

Allowed:
boolean

Only return grants that are currently in effect (true) or only revoked ones (false). Omit for both.

number
1 to 1000
Defaults to 100

Max number of grants to return

number
≥ 0
Defaults to 0

Number of grants to skip (offset)

Responses

403

Forbidden — the caller's role lacks the required permission (ADDRESS_MANAGEMENT).

404

Address not found

502

The address service is unavailable or timed out. error is SERVICE_UNAVAILABLE.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json