Contacts
Export Contacts Status
GET /v3/marketing/contacts/exports/{id}
Base url: https://api.sendgrid.com
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).
Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data.
Authentication
- API Key
Headers
Path Parameters
Responses
The export job's status. Allowed values: pending, ready, or failure.
The ISO8601 timestamp when the export was begun.
The ISO8601 timestamp when the export was updated.
The ISO8601 timestamp when the export was completed.
The ISO8601 timestamp when the exported file on S3 will expire.
One or more download URLs for the contact file if the status is ready.
A human readable message if the status is failure.
The URL of the previous page of results. If this field isn't present, you're at the start of the list.
format: uriThe URL of the current page of results.
format: uriThe URL of the next page of results. If this field isn't present, you're at the end of the list.
format: uriThe number of items in the entire list, i.e., across all pages.
The total number of exported contacts.
the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
