Skip to main content

List address list entries

GET 

/address_lists/address_list/entries

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

Scopes

  • address_lists
  • address_lists:read

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Query Parameters

    address_list[id] string

    The address list for which the entries should be returned.

    All 'address_list[]' params are mutually exclusive, only one can be provided.

    page integer

    Possible values: >= 1

    Default value: 1

    The page number to request. If not provided, the first page will be returned.

    per_page integer

    Possible values: >= 1

    Default value: 30

    The number of items to return per page. If not provided, the default value will be used.

Responses

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

Schema

    pagination

    object

    required

    current_page integer

    The current page

    total_pages integernullable

    The total number of pages

    total integernullable

    The total number of items across all pages

    per_page integer

    The number of items per page

    large_set boolean

    Is this a large set and therefore the total number of records cannot be returned?

    address_list_entries

    object[]

    required

    A list of all address list entries for the given address list.

  • Array [

  • id string
    address string

    Address or network.

    name string

    Optional name/comment.

  • ]

Loading...