Get Callouts

Retrieve callouts associated with an invoice

GET /callouts

cURL

curl --request GET \
     --url https://api.credira.com/v1/callouts?invoice_id=inv_987654321 \
     --header 'Authorization: Bearer YOUR_API_KEY' \
     --header 'Content-Type: application/json'

{
  "success": true,
  "data": [
    {
      "id": "callout_123456789",
      "invoice_id": "inv_987654321",
      "status": "scheduled",
      "type": "payment_reminder",
      "scheduled_time": "2024-01-20T10:00:00Z",
      "created_time": "2024-01-19T09:00:00Z",
      "updated_time": "2024-01-19T09:00:00Z",
      "target_contact": {
        "name": "John Doe",
        "email": "[e-mail]",
        "phone": "[phone]"
      },
      "actions": {
        "calls_enabled": true,
        "emails_enabled": false,
        "voice_agent_id": "agent_456789123"
      },
      "account_id": "acc_789123456",
      "priority": "high",
      "metadata": {
        "campaign_id": "camp_123",
        "department": "billing"
      }
    }
  ],
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789",
    "total_callouts": 1
  }
}

Retrieve all callouts associated with a specific invoice ID.

This endpoint returns an empty array if no callouts exist for the given invoice ID, or an array of callout objects if callouts are found.

Request

invoice_id · string · required

The unique identifier of the invoice to retrieve callouts for

Authorization · string · required

Bearer token for API authentication

cURL

curl --request GET \
     --url https://api.credira.com/v1/callouts?invoice_id=inv_987654321 \
     --header 'Authorization: Bearer YOUR_API_KEY' \
     --header 'Content-Type: application/json'

{
  "success": true,
  "data": [
    {
      "id": "callout_123456789",
      "invoice_id": "inv_987654321",
      "status": "scheduled",
      "type": "payment_reminder",
      "scheduled_time": "2024-01-20T10:00:00Z",
      "created_time": "2024-01-19T09:00:00Z",
      "updated_time": "2024-01-19T09:00:00Z",
      "target_contact": {
        "name": "John Doe",
        "email": "[e-mail]",
        "phone": "[phone]"
      },
      "actions": {
        "calls_enabled": true,
        "emails_enabled": false,
        "voice_agent_id": "agent_456789123"
      },
      "account_id": "acc_789123456",
      "priority": "high",
      "metadata": {
        "campaign_id": "camp_123",
        "department": "billing"
      }
    }
  ],
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789",
    "total_callouts": 1
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Missing required parameter: invoice_id"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Invoice not found"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}