Browse API reference

List all mailing lists

gethttps://api.intelliprint.net/v1/mailing_lists

Returns a paginated list of all the available mailing lists.

Parameters

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", "recipients"]. 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.

Example"mal_eg"

objectstring

The object type. Always mailing_list.

Allowed valuesmailing_list

accountstring

The Intelliprint account ID that the mailing list belongs to.

Example"acc_eg"

namestring

A user-friendly name for this mailing list. This name is displayed in the dashboard.

Example"Black Friday Leads"

recipientsinteger

The number of recipients present in the mailing list. This value is updated automatically when recipients are added or removed from the mailing list.

Example1000

variablesarray of object

An array of the dynamic fields present in the mailing list. Dynamic fields are used to tailor templates uniquely for each recipient.

Array of object.

namestring

The name of the dynamic field. This is the value without the curly braces. For example, if the dynamic field is {exampleA}, the name will be exampleA.

Example"salutation"

longest_address_linestring

This is the longest address line present across all recipients in the mailing list. We keep track of this to ensure the address box on postcard templates is large enough to fit the longest address.

Example"123 Main St, Anytown, Anyplace"

address_validationobject

Address validation is a value-added service that we offer to ensure your mailings are only charged for and sent to real, deliverable addresses. Please contact us at hello@intelliprint.net to enable this service for your account.

requestedboolean

Whether address validation has been requested for the mailing list.

Defaultfalse

Examplefalse

completedboolean

Whether all addresses in the mailing list have been validated.

Defaultfalse

Examplefalse

recipientsobject

The number of recipients that have passed or failed address validation.

passedinteger

The number of recipients that have passed address validation.

Default0

Example0

failedinteger

The number of recipients that have failed address validation.

Default0

Example0

createdinteger<int64>

The UNIX timestamp of when the mailing list 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?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_lists.list({
  limit: 10,
  skip: 0
})

Example response

200 · Successful response

JSON

{
  "object": "list",
  "data": [
    {
      "id": "mal_eg",
      "object": "mailing_list",
      "account": "acc_eg",
      "name": "Black Friday Leads",
      "recipients": 1000,
      "variables": [
        {
          "name": "salutation"
        }
      ],
      "longest_address_line": "123 Main St, Anytown, Anyplace",
      "address_validation": {
        "requested": false,
        "completed": false,
        "recipients": {
          "passed": 0,
          "failed": 0
        }
      },
      "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"
  }
}