Skip to main content
POST
/
contacts
/
reveal
Reveal contacts
curl --request POST \
  --url https://storeinspect.com/api/v1/contacts/reveal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_ids": [
    "<string>"
  ]
}
'
{
  "object": "<string>",
  "credits": {
    "spent": 1,
    "remaining": 1
  },
  "data": [
    {
      "id": "<string>",
      "object": "<string>",
      "full_name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "title": "<string>",
      "role": "<string>",
      "linkedin_url": "<string>",
      "charged": true,
      "emails": [
        {
          "email": "<string>",
          "status": "<string>",
          "type": "<string>",
          "is_primary": true
        }
      ],
      "phones": [
        {
          "phone": "<string>",
          "type": "<string>",
          "is_primary": true
        }
      ],
      "store": {
        "id": "<string>",
        "domain": "<string>",
        "name": "<string>"
      },
      "revealed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "request_id": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Optional key used to safely retry a contact reveal request without spending credits twice.

Maximum string length: 255

Body

application/json
contact_ids
string[]
required
Required array length: 1 - 10 elements
Pattern: ^ct_[A-Za-z]+_[A-Za-z]{16}$

Response

Full contact data for contacts revealed with shared contact credits.

object
string
required
Allowed value: "contact_reveal_result"
credits
object
required
data
object[]
required
request_id
string
required