Menu

Contacts API - Lists

Elements that can be shared among more than one endpoint definition.

Retrieve a single list

Retrieve a single list

GET /contactdb/lists/{list_id}

This endpoint allows you to retrieve a single recipient list.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Path Parameters

list_id
string
required

Query String

list_id
integer

The ID of the list to retrieve.

Responses

object
id
integer

The reference ID of your list.

required
name
string

The name of your list. Must be unique against all other list and segment names.

required
recipient_count
integer

The count of recipients currently in the list.

required
{
  "id": 1,
  "name": "listname",
  "recipient_count": 0
}
object
errors
array[object]
message
string

the error message

field
string

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
object
errors
array[object]
message
string

the error message

field
string

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
object
errors
array[object]
message
string

the error message

field
string

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.