curl --request POST \
  --url https://app.reechee.io/api/v1/opportunities/{id}/unlock-contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "field": "email"
}
'

{
  "success": true,
  "data": {
    "found": true,
    "value": "<string>",
    "source": "<string>",
    "credits_remaining": 123,
    "from_cache": true,
    "already_revealed": true,
    "reason": "<string>",
    "credit_refunded": true
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request"
  }
}

{
  "success": false,
  "error": {
    "code": "unauthorized",
    "message": "API key required"
  }
}

{
  "success": false,
  "error": {
    "code": "payment_required",
    "message": "API key spend cap reached",
    "details": {
      "reason": "spend_cap_reached",
      "spend_cap": 100,
      "spend_used": 100,
      "spend_remaining": 0,
      "credits_required": 1
    }
  }
}

{
  "success": false,
  "error": {
    "code": "forbidden",
    "message": "This API key has no spend cap. Set a per-key spend cap in Settings to enable credit-spending tools.",
    "details": {
      "reason": "spend_cap_required"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "not_found",
    "message": "Resource not found"
  }
}

{
  "success": false,
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded",
    "details": {
      "retry_after_seconds": 12,
      "limit": 60,
      "remaining": 0
    }
  }
}

Endpoints

Unlock a contact (1 credit)

Reveal the reviewer’s (or a buying-committee member’s) email or phone for an opportunity, via live enrichment. Spends 1 credit on a successful reveal; if no contact is found the credit is refunded and found is false.

Requires a spend budget on the credential (403 otherwise): a per-key spend cap for API keys, or the consent-time credit budget for OAuth connections. For a committee member, set target: committee and target_id (the member’s index from get_opportunity).

POST

opportunities

{id}

unlock-contact

curl --request POST \
  --url https://app.reechee.io/api/v1/opportunities/{id}/unlock-contact \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "field": "email"
}
'

{
  "success": true,
  "data": {
    "found": true,
    "value": "<string>",
    "source": "<string>",
    "credits_remaining": 123,
    "from_cache": true,
    "already_revealed": true,
    "reason": "<string>",
    "credit_refunded": true
  }
}

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "Invalid request"
  }
}

{
  "success": false,
  "error": {
    "code": "unauthorized",
    "message": "API key required"
  }
}

{
  "success": false,
  "error": {
    "code": "payment_required",
    "message": "API key spend cap reached",
    "details": {
      "reason": "spend_cap_reached",
      "spend_cap": 100,
      "spend_used": 100,
      "spend_remaining": 0,
      "credits_required": 1
    }
  }
}

{
  "success": false,
  "error": {
    "code": "forbidden",
    "message": "This API key has no spend cap. Set a per-key spend cap in Settings to enable credit-spending tools.",
    "details": {
      "reason": "spend_cap_required"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "not_found",
    "message": "Resource not found"
  }
}

{
  "success": false,
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded",
    "details": {
      "retry_after_seconds": 12,
      "limit": 60,
      "remaining": 0
    }
  }
}

Authorizations

Authorization

string

header

required

A paid-team API key, sent as Authorization: Bearer rch_live_…. Create and revoke keys in the app under Settings → API keys.

Path Parameters

string<uuid>

required

Opportunity id (uuid).

Body

application/json

field

enum<string>

required

Available options:

email,

phone

target

enum<string>

default:reviewer

Available options:

reviewer,

committee

target_id

integer

Committee member index (required when target is committee).

Response

The reveal result. found: true with the value when a contact was found (a credit was spent), or found: false when none exists (no credit kept).

success

boolean

required

data

object

required

Show child attributes