Export contacts
Exports contacts as JSON or CSV, returning the serialized data and a count of exported records. The ids filter takes at most 1000 ids.
POST
Exports contacts as JSON or CSV, returning the serialized data and a count of exported records. The ids filter takes at most 1000 ids.
apiKeyheader
x-api-key<token>application/json- body
ids?array<>|nullformat?|nullfilters?|nullfields?array<string>|nullSuccess
application/json- response
data*stringformat*stringValue in
"json""csv"count*integerRange
0 <= value <= 9007199254740991import { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.contacts.export({});Example Response
{
"data": "string",
"format": "json",
"count": 0
}