SAsalesmessage
Contacts

Export contacts

Changed on

REQUIRED SCOPES <code>['contacts:read']</code><br> Exports the account's contacts to a CSV file. Under 1000 contacts the file is built right away and <code>url</code> holds the download link. From 1000 contacts the export is queued: <code>url</code> is null and <code>queued</code> is true. In both cases the link is also emailed to the user.

get/contacts/export

Request

  • Base URL
    https://api.salesmessage.com/pub/v2.3
  • URL
    https://api.salesmessage.com/pub/v2.3/contacts/export
  • Auth
    HTTP bearer

Query parameters

contact_columns[]string[]

Columns to export, in file order: contact fields (e.g. first_name, number, email, tags, created_at) or custom.<key> for custom fields. Default: first_name, last_name, number, email, created_at.

[
  "first_name"
]
sortBystring
Example:created_at

Contact column to sort by. Default: newest contacts first.

sortOrder'asc' | 'desc'
Example:desc

Sort direction.

searchstring

Search term, as in the Contacts list.

contactIds[]integer[]

Export only these contacts.

[
  1234
]

Response

OK

urlstring nullable

Download link; null when queued.

queuedboolean

True when the export is queued.

records_countinteger

Number of exported contacts.

Example response

{
  "url": "https://salesmessage.s3.us-west-2.amazonaws.com/app/users/1/files/export/export-2026-09-16.csv",
  "records_count": 42
}

Changes

  • ca61a01e9dadRevision changes
    • breaking

      the response's body type changed from array to object for status

    • info

      added the new optional query request parameter contactIds[]

    • info

      added the new optional query request parameter contact_columns[]

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortOrder

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status