Browse API reference

List all backgrounds

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

Returns a paginated list of all the available backgrounds with optional filtering.

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 backgrounds by.

sort_order

string

The order to sort the backgrounds in.

fields

array

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

team

string

Filters the results to only those backgrounds that are assigned to this team ID.

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 background.

Example"bg_eg"

objectstring

The object type. Always background.

Allowed valuesbackground

accountstring

The Intelliprint account ID that the background belongs to.

Example"acc_eg"

namestring

A user-friendly name for this background. This name is used for the selection menu in the dashboard print editor.

Example"Company Letterhead"

fileobject

namestring

The name of the file uploaded as the background.

Example"eg_file.pdf"

sizeinteger<int64>

The size of the file uploaded as the background in bytes.

Example1024000

teamobject

The team that the background is available to. Can be set to null to make the background available to everyone.

pdfstring<uri>

A URL to a PDF example of the background. This is a signed URL that will expire after 1 hour.

Example"https://cdn.storage.com/intelliprint/backgrounds/bg_ID.pdf"

createdinteger<int64>

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

Example response

200 · Successful response

JSON

{
  "object": "list",
  "data": [
    {
      "id": "bg_eg",
      "object": "background",
      "account": "acc_eg",
      "name": "Company Letterhead",
      "file": {
        "name": "eg_file.pdf",
        "size": 1024000
      },
      "team": null,
      "pdf": "https://cdn.storage.com/intelliprint/backgrounds/bg_ID.pdf",
      "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"
  }
}