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
The address list for which the entries should be returned.
All 'address_list[]' params are mutually exclusive, only one can be provided.
Possible values: >= 1
Default value: 1
The page number to request. If not provided, the first page will be returned.
Possible values: >= 1
Default value: 30
The number of items to return per page. If not provided, the default value will be used.
Responses
- 200
- 400
- 403
- 404
- 429
- 503
Returns a list of all address list entries for a given address list
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
pagination
object
required
The current page
The total number of pages
The total number of items across all pages
The number of items per page
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.
Address or network.
Optional name/comment.
{
"pagination": {
"current_page": 0,
"total_pages": 0,
"total": 0,
"per_page": 0,
"large_set": true
},
"address_list_entries": [
{
"id": "string",
"address": "string",
"name": "string"
}
]
}
No API token was provided in the Authorization header. Ensure a token is provided prefixed with Bearer
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [missing_api_token
]
{
"code": "missing_api_token",
"description": "string",
"detail": {}
}
403 error response
- application/json
- Schema
- Example (from schema)
Schema
- UnauthorizedNetworkForAPITokenSchema
- InvalidAPITokenSchema
- InvalidCapabilitiesTokenSchema
- ScopeNotGrantedErrorSchema
- PermissionDeniedSchema
oneOf
Network is not allowed to access the API with this API token
Possible values: [unauthorized_network_for_api_token
]
detail
object
The IP address the request was received from
The API token provided was not valid (it may not exist or have expired)
Possible values: [invalid_api_token
]
detail
object
The capabilities token provided was not valid (either not valid, expired or not signed by the correct key)
Possible values: [invalid_capabilities_token
]
The scope required for this endpoint has not been granted to the authenticating identity
Possible values: [scope_not_granted
]
detail
ScopeNotGrantedError
The authenticated identity is not permitted to perform this action
Possible values: [permission_denied
]
detail
object
Additional information regarding the reason why permission was denied
{}
No address list was found matching any of the criteria provided in the arguments.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [address_list_not_found
]
{
"code": "address_list_not_found",
"description": "string",
"detail": {}
}
You have reached the rate limit for this type of request
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [rate_limit_reached
]
detail
object
The total number of requests per minute that are permitted
{
"code": "rate_limit_reached",
"description": "string",
"detail": {
"total_permitted": 0
}
}
The service is currently unavailable, please try again later
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [service_unavailable
]
{
"code": "service_unavailable",
"description": "string",
"detail": {}
}