API Reference

Katapult Core API

Resources & Endpoints

List address list entries

Returns a list of all address list entries for a given address list.

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

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 for which the entries should be returned.

 Address List Lookup None

page

Integer 1

per_page

Integer 30

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

permission_denied

The authenticated identity is not permitted to perform this action

 403 Forbidden

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    pagination: Pagination Details {
        current_page: Integer
        total_pages: Integer?
        total: Integer?
        per_page: Integer
        large_set: Boolean
    }
    address_list_entries: [ AddressListEntry {
        id: String
        address: String
        name: String
    } ]
}