Skip to main content
GET
curl

Authorizations

X-Api-Key
string
header
required

Your API key, sent as the value of the X-Api-Key header. In the dashboard, go to Integrations and open Deliveryman API Keys to create one.

Query Parameters

contact_list_uid
string
required

UID of the contact list.

Minimum string length: 1

Response

Success

uid
string
required

UID of this contact list.

Maximum string length: 255
workspace_id
integer
required
read-only

ID of workspace this contact list belongs to.

name
string
required

Name of the contact list.

Maximum string length: 300
created_on
string<date-time>
required
read-only

Timestamp of when the contact list was created. ISO format date string in UTC timezone.

field_mappings
object[]
required
read-only

How the list's columns map to contact fields.

is_deletable
boolean
required
read-only

False while the list is used by a campaign that is created, scheduled, running or paused.

status
string

Current status of the contact list: uploading while contacts are being imported, verifying while email addresses are being verified, active when it's ready to use, or failed if the import failed.

Maximum string length: 100
source
string

Source of the contact list.

Maximum string length: 300
available_columns
any

List of columns available in the contact list.

has_unsubscribe_column
boolean

Indicates if the contact list contains an unsubscribe column.

unsubscribe_column_name
string | null

Name of the unsubscribe column, if present.

Maximum string length: 300
contacts_count
integer

Number of contacts in the contact list.

Required range: 0 <= x <= 2147483647
email_verification_status
enum<string>

Status of email address verification for this list.

  • processing - Processing
  • completed - Completed
  • skipping - Skipping
  • skipped - Skipped
  • failed - Failed
  • N/A - Not Applicable
Available options:
processing,
completed,
skipping,
skipped,
failed,
N/A