How many contacts have this field set

GET/v1/contacts/fields/{field}/usage

Secret key — sk_… or sk_test_… · Base URL https://api.volanea.com

How many contacts have this custom field set to a non-null value.

Worth calling before DELETE /v1/contacts/fields/{field} — that endpoint is irreversible and project-wide, and this is the number it would affect.

Path parameters

  • fieldstringrequired

Response

Usage count.

  • fieldstring
  • countinteger

Errors

Every failure returns the standard envelope — branch on `code`, never on the wording of `error`.

  • 401Missing or invalid API key.
  • 422Request validation failed (code `validation_error`, 422).

Request

curl https://api.volanea.com/v1/contacts/fields/id_123/usage \
  -H "Authorization: Bearer sk_..."

Response

200 · application/json

{
  "success": true,
  "data": {
    "field": "<field>",
    "count": 1
  }
}

92 endpoints · OpenAPI document