Ir al contenido
Nuntius

Get Contact

Ver como Markdown
GET
/public/v1/contacts/{contact_id}
curl --request GET \
  --url https://api.nuntius.chat/public/v1/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Return a single live contact owned by the tenant.

Unknown/foreign/deleted -> 404.

Permiso necesario: tenant:contacts.read

Authorizations

Sección titulada «Authorizations»

Parameters

Sección titulada «Parameters»

Path Parameters

Sección titulada «Path Parameters»
contact_id
required
Contact Id
string format: uuid

Responses

Sección titulada «Responses»

200

Sección titulada «200»

Successful Response

Media typeapplication/json
PublicContactOut

A single contact, curated subset of the internal CustomerOut.

Drops signingEmail (INT-PANDADOC-1 internal-integration concern, meaningless to a third party reading/writing contacts generically).

object
id
required
Id
string
fullName
Any of:
string
phone
Any of:
string
email
Any of:
string
country
Any of:
string
phoneVerifiedAt
Any of:
string
emailVerifiedAt
Any of:
string
marketingOptOut
required
Marketingoptout
boolean
marketingOptOutAt
Any of:
string
origin
required
Origin
string
createdAt
required
Createdat
string

Examplegenerated

{
  "id": "example",
  "fullName": "example",
  "phone": "example",
  "email": "example",
  "country": "example",
  "phoneVerifiedAt": "example",
  "emailVerifiedAt": "example",
  "marketingOptOut": true,
  "marketingOptOutAt": "example",
  "origin": "example",
  "createdAt": "example"
}

422

Sección titulada «422»

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Examplegenerated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}