Skip to main content
GET
Reveal a secret field

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Path Parameters

id
string
required

The contact's internal ID.

Query Parameters

field_name
string
required

The name of the encrypted field to reveal.

public_key
string

Required only when your org has require_public_encryption_key enabled. Base64-encoded public key used for re-encryption.

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Response

The decrypted field value.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

The decrypted value of one encrypted field. Returns an empty string when the field holds no value.