List global address lists

Returns a list of all global address lists.

GET
https://api.katapult.io/core/v1/address_lists

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

page

Integer 1

per_page

Integer 30

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_lists: [ AddressList {
        id: String
        name: String
        global: Boolean
    } ]
}