Menu

Contacts

Export Contacts Status

Export Contacts Status

GET /marketing/contacts/exports/{id}

This endpoint can be used to check the status of a contact export job.

To use this call, you will need the id from the "Export Contacts" call.

If you would like to download a list, take the id that is returned from the "Export Contacts" endpoint and make an API request here to get the urls. Once you have the list of URLs, make a GET request on each URL to download your CSV file(s).

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Path Parameters

id
string
required

Responses

object
id
string
required
status
string

The export job's status. Allowed values: pending, ready, or failure.

Allowed Values: pending, ready, failure
required
created_at
string

The ISO8601 timestamp when the export was begun.

required
updated_at
string

The ISO8601 timestamp when the export was updated.

required
completed_at
string

The ISO8601 timestamp when the export was completed.

expires_at
string

The ISO8601 timestamp when the exported file on S3 will expire.

required
urls
array[string]

One or more download URLs for the contact file if the status is ready.

message
string

A human readable message if the status is failure.

_metadata
object
prev
string

The URL of the previous page of results. If this field isn't present, you're at the start of the list.

format: uri
self
string

The URL of the current page of results.

format: uri
next
string

The URL of the next page of results. If this field isn't present, you're at the end of the list.

format: uri
count
number

The number of items in the entire list, i.e., across all pages.

contact_count
integer

The total number of exported contacts.

object
errors
array[object]
message
string
field
string
error_id
string
parameter
string
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"
    }
  ]
}
object
errors
array[object]
message
string

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.