Contacts
/contacts/csv
Contacts CSV export
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Query Parameters
search?string
status?string
Value in
"active" | "inactive" | "pending"type?string
Value in
"owner" | "vendor"companyType?string
Value in
"c_corporation" | "limited_liability_company" | "partnership" | "s_corporation" | "trust_estate"isIndividual?boolean
ownershipPeriodId?string
Filter contacts by ownership period ID.
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidshortRefs?string
comma separated contact short refs
ids?string
Comma-separated contact IDs.
Format
vrp-csvResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.vrplatform.app/contacts/csv"{
"url": "string"
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"issues": [
{
"message": "string"
}
],
"context": null
}