Get address list entry

Returns details for an address list entry.

GET

https://api.katapult.io/core/v1/address_list_entries/{address_list_entry}

If successful, this endpoint will return a 200 OK status.

Scopes

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_entry Required The address list entry to return.	Address List Entry Lookup	None

Name

Type

Default Value

address_list_entry Required

The address list entry to return.

None

The following errors may occur during this request.

Details	HTTP status
address_list_entry_not_found No address list entry was found matching any of the criteria provided in the arguments.	404 Not Found

Details

HTTP status

No address list entry 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_entry: AddressListEntry {
        id: String
        address: String
        name: String
    }
}