Get a contact
Returns a contact with its identities, profile, tags, and metadata. Request: GET /v1/contacts/{id}. Scope: contacts:read.
GET
Returns a contact with its identities, profile, tags, and metadata.
apiKeyheader
x-api-key<token>id*stringMatch
^contact_[0-9a-hjkmnp-tv-z]{16,24}$Contact
application/json- response
id*ContactIdMatch
^contact_[0-9a-hjkmnp-tv-z]{16,24}$namespaceId*|nullname*stringdisplayName*string|nullavatar*string|nullstatus*stringValue in
"active""paused""blocked""archived"statusReason*string|nullexternalId*string|nullidentities*array<>profile*|nullpreferences*|nulltags*array<string>metadata*|nullimportProvenance*|nulladdedAt*string|nullcreatedAt*stringupdatedAt*stringimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.contacts.get({
"id": "example"
});Example Response
{
"id": "string",
"namespaceId": "string",
"name": "string",
"displayName": "string",
"avatar": "string",
"status": "active",
"statusReason": "string",
"externalId": "string",
"identities": [
{
"id": "string",
"type": "email",
"identifier": "string",
"verified": true,
"channels": [
{
"channel": "sms",
"reachability": "unknown",
"consent": {
"status": "opted_in",
"source": "string",
"capturedAt": "string",
"proof": {
"property1": "string",
"property2": "string"
}
}
}
]
}
],
"profile": {
"firstName": "string",
"lastName": "string",
"company": "string",
"jobTitle": "string",
"location": {
"country": "string",
"state": "string",
"city": "string",
"timezone": "string"
},
"customFields": {
"property1": "string",
"property2": "string"
},
"source": "api"
},
"preferences": {
"preferredChannels": [
"sms"
],
"language": "string",
"timezone": "string",
"notifications": {
"email": true,
"sms": true,
"whatsapp": true,
"quiet_hours": {
"start": "string",
"end": "string"
}
}
},
"tags": [
"string"
],
"metadata": {
"property1": "string",
"property2": "string"
},
"importProvenance": {
"first": {
"jobId": "string",
"topicId": "string",
"preset": "beehiiv",
"importedAt": "string",
"summary": {
"permissionAssumed": true,
"signupAt": {
"value": "string",
"kind": "time"
},
"sources": [
"string"
],
"omittedSources": 0
},
"evidence": [
{
"file": "string",
"row": -9007199254740991,
"declared": {
"kind": "status_column"
},
"suppressionFree": true,
"permissionBasis": "assumed",
"sourceStatus": "string",
"signupAt": "string",
"source": "string"
}
]
},
"latest": {
"jobId": "string",
"topicId": "string",
"preset": "beehiiv",
"importedAt": "string",
"summary": {
"permissionAssumed": true,
"signupAt": {
"value": "string",
"kind": "time"
},
"sources": [
"string"
],
"omittedSources": 0
},
"evidence": [
{
"file": "string",
"row": -9007199254740991,
"declared": {
"kind": "status_column"
},
"suppressionFree": true,
"permissionBasis": "assumed",
"sourceStatus": "string",
"signupAt": "string",
"source": "string"
}
]
}
},
"addedAt": "string",
"createdAt": "string",
"updatedAt": "string"
}