Skip to main content
GET
/
v1
/
schemas
/
{schemaId}
/
required-inputs
Required inputs for a schema
curl --request GET \
  --url https://robodialer-service-api-9nc4t1p9.uc.gateway.dev/v1/schemas/{schemaId}/required-inputs \
  --header 'Authorization: Bearer <token>'
{
  "schemaId": "fWxzG4nqtpHsJxS5Lm3q",
  "requiredInputs": {
    "fields": [
      "beginningDateOfService",
      "billingProviderName",
      "billingProviderTaxId",
      "claimChargeAmount",
      "memberId",
      "patientDateOfBirth",
      "patientFirstName",
      "patientLastName",
      "payerName",
      "phoneNumber",
      "renderingProviderName",
      "renderingProviderNpi"
    ]
  },
  "optionalInputs": {
    "fields": [
      "memberId2"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token obtained from the /v1/auth endpoint

Path Parameters

​
schemaId
string
required

The schema ID (from GET /v1/schemas). Must be non-blank, ≤1500 characters, contain no /, and must not start with _ or ..

Response

Sorted list of required input field names for this schema.

Success response from GET /v1/schemas/{schemaId}/required-inputs. Carries both required and optional input field lists; the two are disjoint — if a name is required by any source, it appears only in requiredInputs.fields.

​
schemaId
string
required

Echoes the path parameter.

​
requiredInputs
object
required
​
optionalInputs
object
required