Returns details for a address list.
If successful, this endpoint will return a 200 OK status.
One of the following scopes are required to use this endpoint.
The following arguments are supported for this endpoint.
Name | Type | Default Value |
---|---|---|
address_list Required The address list to return. |
Address List Lookup | None |
The following errors may occur during this request.
Details | HTTP status |
---|---|
No address list was found matching any of the criteria provided in the arguments. |
404 Not Found |
When the request is successful, you can expect an object matching the specification below to be returned.
{ address_list: AddressList { id: String name: String global: Boolean entries: [ AddressListEntry { id: String address: String name: String } ] } annotations: [ KeyValue { key: String value: String? } ] }