Browse API reference

List all recipients in a mailing list

gethttps://api.intelliprint.net/v1/mailing_lists/{mailing_list}/recipients

Returns a list of all the available mailing list recipients with pagination.

Parameters

Path

mailing_listrequired

string

The ID of the mailing list to retrieve recipients from.

Query

limit

integer

The number of objects to return in the response.

Example1

skip

integer

The number of objects to skip (For pagination).

Example0

sort_field

string

The field to sort the mailing lists by.

sort_order

string

The order to sort the mailing lists in.

fields

array

A filtered down list of fields to return in the response. Example: ["id", "name", "address.line"]. By default, all fields are returned.

Responses

Sample JSON for every response shape is in the right rail. Expand a row below to see every field this endpoint can return.

200Successful responseapplication/json

object

string

The object type. Always list.

Allowed valueslist

data

array of object

Array of object.

idstring

A globally unique identifier for the mailing list recipient.

Example"mal_rcp_eg"

objectstring

The type of the object. Always mailing_list_recipient.

Allowed valuesmailing_list_recipient

mailing_liststring

The ID of the mailing list that the recipient belongs to.

Example"mal_eg"

accountstring

The Intelliprint account ID that the mailing list belongs to.

Example"acc_eg"

addressobject

namestring

The name of the recipient.

Example"John Doe"

linestring

The complete address line for the recipient.

Example"123 Main St, Anytown, Anyplace"

postcodestring

The postal code of the address.

Example"AB1 2CD"

countrystring

The country code of the address. This is an ISO 3166-1 alpha-2 country code. Example: GB.

Default"GB"

Example"GB"

variablesobject

An arbitrary object of the dynamic fields for this recipient. Dynamic fields are used to tailor templates uniquely for each recipient.

address_validation_statusstring

The address validation status for this recipient's address. Address validation for a recipient is only performed if address validation has been requested for the mailing list.

Allowed valuespassedfailedpendingnot_requested

Default"not_requested"

createdinteger<int64>

The UNIX timestamp of when the mailing list recipient was created. We use UNIX timestamps to avoid timezone-based issues.

Example1761955200

total_available

integer<int64>

The total number of objects available that can be returned by the API using successive paginated requests.

Example100

has_more

boolean

Whether there are more objects available that can be requested in the next paginated request.

Exampletrue

400Example error responseapplication/json

error

object

messagestring

A human-readable message describing the error. You can display this to your users to help them understand what went wrong.

Example"Received unknown parameter: testmood (Did you mean testmode?)"

typestring

The general category of the error.

Allowed valuesinvalid_request_errorauthentication_errorpayment_errorrate_limitedinternal_error

Example"invalid_request_error"

codestring

A unique code for the specific error that occurred.

Allowed valuesparameter_invalidparameter_missingparameter_unknownbody_too_largebody_incorrect_formatno_api_keyinvalid_api_keylogged_outforbiddenpayment_errornot_foundrate_limitedrefusedinternal_error

Example"parameter_unknown"

paramstring

The parameter that caused the error, if applicable.

Example"testmood"

Request example

cURL

curl 'https://api.intelliprint.net/v1/mailing_lists/mailing-list-id/recipients?limit=10&skip=0' \ 
  -H 'Authorization: YOUR_API_KEY'

Node.js SDK

Node.js

import Intelliprint from 'intelliprint'
const ip = Intelliprint('your-api-key-here')

const list = await ip.mailing_list_recipients.list('mailing-list-id', {
  limit: 10,
  skip: 0
})

Example response

200 · Successful response

JSON

{
  "object": "list",
  "data": [
    {
      "id": "mal_rcp_eg",
      "object": "mailing_list_recipient",
      "mailing_list": "mal_eg",
      "account": "acc_eg",
      "address": {
        "name": "John Doe",
        "line": "123 Main St, Anytown, Anyplace",
        "postcode": "AB1 2CD",
        "country": "GB"
      },
      "variables": {
        "salutation": "Mr.",
        "internal_id": "12345",
        "loginURL": "https://abc.xyz/login"
      },
      "address_validation_status": "not_requested",
      "created": 1761955200
    }
  ],
  "total_available": 100,
  "has_more": true
}

400 · Example error response

JSON

{
  "error": {
    "message": "Received unknown parameter: testmood (Did you mean testmode?)",
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "param": "testmood"
  }
}