API Reference

Katapult Core API

Resources & Endpoints

Get address list

Returns details for a address list.

GET
https://api.katapult.io/core/v1/address_lists/{address_list}

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

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

address_list Required

The address list to return.

 Address List Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

address_list_not_found

No address list was found matching any of the criteria provided in the arguments.

 404 Not Found

Returned Object

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?
    } ]
}