production
https://api.availity.com/availity
Custom API Endpoint
Paths
/configurations
get /configurations
Retrieve configurations by type, sub-type, and payer. May return abbreviated versions if multiple are found.
oauth2
oauth2
(oauth2 application)
Token URL
https://api.availity.com/v1/token
Scopes
hipaa
Realtime - Live HIPAA API
type
Required in query
string
The type of configuration.
subtypeId
Optional in query
string
The subtype of the configuration.
payerId
Optional in query
string
The Availity payer id of the configuration.
Accept
Optional in header
string
application/json
application/xml
application/xml
200
200 OK
400
Bad Request
401
Not Authorized
403
Forbidden
500
Internal Server Error
Example Request
Example Response
GET https://api.availity.com/availity/v1/configurations
Try this operation
Definitions
{
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"description": "Total number of assets."
},
"count": {
"type": "integer",
"description": "Number of assets in the result set."
},
"offset": {
"type": "integer",
"description": "Paging offset."
},
"limit": {
"type": "integer",
"description": "Paging limit."
},
"links": {
"type": "object",
"description": "Links.",
"additionalProperties": {
"$ref": "#/definitions/Link"
}
},
"configurations": {
"type": "array",
"description": "list of configurations.",
"items": {
"$ref": "#/definitions/Configuration"
}
}
}
}
{
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The URL."
}
}
}
A payer specific input form display and validation configuration.
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The configuration type."
},
"categoryId": {
"type": "string",
"description": "The configuration category id."
},
"categoryValue": {
"type": "string",
"description": "The configuration category value."
},
"subtypeId": {
"type": "string",
"description": "The configuration subtype id."
},
"subtypeValue": {
"type": "string",
"description": "The configuration subtype value."
},
"payerId": {
"type": "string",
"description": "The configuration payer id."
},
"payerName": {
"type": "string",
"description": "The configuration payer name."
},
"version": {
"type": "string",
"description": "The configuration version."
},
"sourceId": {
"type": "string",
"description": "The configuration source id."
},
"elements": {
"type": "object",
"description": "The elements that make up the form.",
"additionalProperties": {
"$ref": "#/definitions/Element"
}
},
"requiredFieldCombinations": {
"type": "object",
"description": "Each entry in the required field combinations defines a rule where all fields in at least one of the lists of fields must be provided.",
"additionalProperties": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"settings": {
"type": "object",
"description": "Key-value settings.",
"additionalProperties": {
"type": "string"
}
}
}
}
A form element.
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of element. Generally maps to type of UI element. Unsupported is not show. Boolean is a checkmark. Collection is a searchable REST backed drop down. Date is a date picker. Enumeration is a searchable inline drop down. Information is just text. Section is a grouper or container with text. Text is a standard text box. Number is generally a text box, but serialized as a numeric. Object is grouping like section but with additional metadata. ObjectArray is a repeating grouping with additional metadata.",
"enum": [
"Unsupported",
"Boolean",
"Collection",
"Date",
"Enumeration",
"Information",
"Section",
"Text",
"Number",
"Object",
"ObjectArray"
]
},
"label": {
"type": "string",
"description": "A human friendly label."
},
"order": {
"type": "integer",
"description": "The order within the elements."
},
"helpTopicId": {
"type": "string",
"description": "Help topic id."
},
"elements": {
"type": "object",
"description": "Child elements",
"additionalProperties": {
"$ref": "#/definitions/Element"
}
},
"errorMessage": {
"type": "string",
"description": "An error message."
},
"maxRepeats": {
"type": "integer",
"description": "Number of times an item can repeat."
},
"allowed": {
"type": "boolean",
"description": "Allowed indicator."
},
"required": {
"type": "boolean",
"description": "Required indicator."
},
"information": {
"type": "array",
"description": "A list of information.",
"items": {
"type": "string"
}
},
"groups": {
"type": "array",
"description": "A list of groups.",
"items": {
"type": "string"
}
},
"repeats": {
"type": "boolean",
"description": "Item repeats indicator."
},
"hidden": {
"type": "boolean",
"description": "Hidden indicator."
},
"minRepeats": {
"type": "integer",
"description": "Minimum number of repetitions."
},
"defaultValue": {
"description": "A default value."
},
"values": {
"description": "A list of values."
},
"valuesWhen": {
"type": "object",
"description": "Conditional values.",
"additionalProperties": {
"type": "array",
"items": {
"type": "object"
}
}
},
"min": {
"type": "string",
"format": "date-time",
"description": "Minimum date."
},
"max": {
"type": "string",
"format": "date-time",
"description": "Maximum date."
},
"pattern": {
"type": "string",
"description": "Regular expression."
},
"maxLength": {
"type": "integer",
"description": "The max length."
},
"minLength": {
"type": "integer",
"description": "The minimum length."
},
"maxLengthWhen": {
"type": "object",
"description": "Conditional max lengths.",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/FieldCondition"
}
}
},
"patternWhen": {
"type": "object",
"description": "Conditional patterns.",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/FieldCondition"
}
}
},
"mode": {
"type": "string",
"description": "The mode.",
"enum": [
"DropDown",
"RadioGroup"
]
},
"allowedWhen": {
"type": "object",
"description": "Field is allowed when one condition is true.",
"additionalProperties": {
"$ref": "#/definitions/FieldCondition"
}
},
"notAllowedWhen": {
"type": "object",
"description": "Field is not allowed when one condition is true.",
"additionalProperties": {
"$ref": "#/definitions/FieldCondition"
}
},
"requiredWhen": {
"type": "object",
"description": "Field is required when one condition is true.",
"additionalProperties": {
"$ref": "#/definitions/FieldCondition"
}
},
"notRequiredWhen": {
"type": "object",
"description": "Field is not required when one condition is true.",
"additionalProperties": {
"$ref": "#/definitions/FieldCondition"
}
},
"objectTypes": {
"type": "object",
"description": "Object array item type prototype definitions.",
"additionalProperties": {
"$ref": "#/definitions/ObjectType"
}
}
}
}
{
"type": "object",
"properties": {
"equalTo": {
"type": "string",
"description": "Applies when the field value is equal to this value."
},
"containedIn": {
"type": "array",
"description": "Applies when the field value is in the list.",
"items": {
"type": "string"
}
},
"greaterThan": {
"type": "string",
"description": "Applies when the field value is greater than this value."
},
"lessThan": {
"type": "string",
"description": "Applies when the field value is less than this value."
},
"greaterEqual": {
"type": "string",
"description": "Applies when the field value is greater than or equal to this value."
},
"lessEqual": {
"type": "string",
"description": "Applies when the field value is less than or equal to this value."
},
"maxLength": {
"type": "integer",
"description": "Max length."
},
"pattern": {
"type": "integer",
"description": "Regular expression."
},
"values": {
"description": "Possible values or link to possible values."
}
}
}
{
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "A label for this object type."
},
"minInstances": {
"type": "integer",
"description": "Minimum number of instance of this type of object."
},
"maxInstances": {
"type": "integer",
"description": "Maximum number of instance of this type of object."
},
"required": {
"type": "boolean",
"description": "Required indicator."
},
"allowedWhen": {
"type": "object",
"description": "Object type is allowed when one condition is true.",
"additionalProperties": {
"$ref": "#/definitions/FieldCondition"
}
},
"notAllowedWhen": {
"type": "object",
"description": "Object type is not allowed when one condition is true.",
"additionalProperties": {
"$ref": "#/definitions/FieldCondition"
}
},
"requiredWhen": {
"type": "object",
"description": "Object type is required when one condition is true.",
"additionalProperties": {
"$ref": "#/definitions/FieldCondition"
}
},
"notRequiredWhen": {
"type": "object",
"description": "Object type is not required when one condition is true.",
"additionalProperties": {
"$ref": "#/definitions/FieldCondition"
}
},
"fieldValues": {
"type": "object",
"description": "Object type discriminators.",
"additionalProperties": {
"$ref": "#/definitions/FieldCondition"
}
}
}
}
{
"type": "object",
"properties": {
"userMessage": {
"type": "string",
"description": "A high level error message."
},
"developerMessage": {
"type": "string",
"description": "A more technical error message."
},
"reasonCode": {
"type": "integer",
"description": "A reason code."
},
"statusCode": {
"type": "integer",
"description": "The status code."
},
"errors": {
"type": "array",
"description": "A list of detailed user friendly messages.",
"items": {
"$ref": "#/definitions/FieldError"
}
}
}
}
{
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "The field or parameter associated with this error."
},
"code": {
"type": "string",
"description": "A code for the error."
},
"errorMessage": {
"type": "string",
"description": "The message associated with this error."
},
"index": {
"type": "integer",
"description": "The array index of the item associated with this error."
}
}
}