Skip to main content
GET
/
do-not-call
List DNC entries (or look up by phone)
curl --request GET \
  --url https://api.goyappr.com/do-not-call \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phone_number": "+972501234567",
      "reason": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "agents": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "type": "prompt",
          "flow_config": {
            "nodes": [
              {
                "id": "<string>",
                "name": "<string>",
                "position": {
                  "x": 123,
                  "y": 123
                },
                "agent_speaks_first": true,
                "greeting": "<string>",
                "is_literal": false,
                "next_step_id": "<string>",
                "auto_advance": true
              }
            ],
            "flow_config_version": "1",
            "metadata": {
              "custom_metadata_keys": [
                "<string>"
              ]
            }
          },
          "system_prompt": "<string>",
          "description": "<string>",
          "background_sound_volume": 0.3,
          "temperature": 1,
          "greeting_message": "<string>",
          "agent_speaks_first": true,
          "vad_stop_secs": 0.5,
          "vad_start_secs": 0.2,
          "vad_confidence": 0.7,
          "silence_timeout_secs": 60,
          "max_continuous_speech_secs": 120,
          "max_call_duration_secs": 600,
          "lead_memory_enabled": true,
          "is_active": true,
          "webhook_url": "<string>",
          "webhook_events": [],
          "extraction_parameters": [
            {
              "name": "customerName",
              "description": "The caller's full name as mentioned during the conversation"
            }
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.goyappr.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns every Do-Not-Call entry for your company, ordered by most-recently added. Phone numbers are stored in E.164. Use this to render a DNC management UI or to back-fill an external suppression list. Pass ?phone=... to look up a single entry instead of listing all. The number is normalized before lookup, so +972501234567, 972501234567, and 0501234567 all resolve to the same row. Required scope: do_not_call:read.

​
Example request

# List all
curl "https://api.goyappr.com/do-not-call" \
  -H "Authorization: Bearer $YAPPR_API_KEY"

# Lookup by phone
curl "https://api.goyappr.com/do-not-call?phone=+972501234567" \
  -H "Authorization: Bearer $YAPPR_API_KEY"

​
Example response

{
  "data": [
    {
      "id": "8c0e0f8a-1c11-4d3a-9a02-2b1e9d2f0001",
      "company_id": "fe493f11-0000-0000-0000-000000000001",
      "phone_number": "+972501234567",
      "reason": "Customer requested removal",
      "source": "api",
      "expires_at": null,
      "agents": [],
      "created_at": "2026-05-10T08:14:22.123Z"
    }
  ]
}
When ?phone=... is supplied the response is the single entry object directly (not wrapped in data).

​
Errors

HTTPCodeWhen
401INSUFFICIENT_SCOPEAPI key lacks do_not_call:read.
404—?phone=... was supplied and the number is not on the list.

Authorizations

​
Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Query Parameters

​
phone
string

Single-number lookup. Returns 404 if the number is not on the list.

Response

List of DNC entries (or one entry when phone is supplied)

​
data
object[]