Availity Configurations API
The Configurations API from Availity — 1 operation(s) for configurations.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/availity:availity-configurations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Availity Configurations API
version: 1.0.0
x-custom-api-description: The Availity Configurations 1.0.0 API is designed to streamline the integration of payer-specific requirements into healthcare applications.
description: 'Operations tagged Configurations across 2 of this provider''s published API definitions: availity-configurations-openapi.json, availity-configurations-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.availity.com/v1
security:
- oauth2:
- hipaa
tags:
- name: Configurations
paths:
/configurations:
get:
operationId: findConfigurations
parameters:
- description: The type of configuration.
in: query
name: type
required: true
schema:
type: string
- description: The subtype of the configuration.
in: query
name: subtypeId
schema:
type: string
- description: The Availity payer id of the configuration.
in: query
name: payerId
schema:
type: string
responses:
'200':
description: 200 OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResultSet'
application/xml:
schema:
$ref: '#/components/schemas/ResultSet'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Not Authorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
application/xml:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Retrieve configurations by type, sub-type, and payer.
tags:
- Configurations
servers:
- url: https://api.availity.com/v1
components:
schemas:
FieldError:
properties:
code:
description: A code for the error.
type: string
errorMessage:
description: The message associated with this error.
type: string
field:
description: The field or parameter associated with this error.
type: string
index:
description: The array index of the item associated with this error.
type: integer
type: object
FieldCondition:
properties:
containedIn:
description: Applies when the field value is in the list.
items:
type: string
type: array
equalTo:
description: Applies when the field value is equal to this value.
type: string
greaterEqual:
description: Applies when the field value is greater than or equal to this value.
type: string
greaterThan:
description: Applies when the field value is greater than this value.
type: string
lessEqual:
description: Applies when the field value is less than or equal to this value.
type: string
lessThan:
description: Applies when the field value is less than this value.
type: string
maxLength:
description: Max length.
type: integer
pattern:
description: Regular expression.
type: integer
values:
description: Possible values or link to possible values.
type: object
Configuration:
description: A payer specific input form display and validation configuration.
properties:
categoryId:
description: The configuration category id.
type: string
categoryValue:
description: The configuration category value.
type: string
elements:
additionalProperties:
$ref: '#/components/schemas/Element'
description: The elements that make up the form.
type: object
payerId:
description: The configuration payer id.
type: string
payerName:
description: The configuration payer name.
type: string
requiredFieldCombinations:
additionalProperties:
items:
items:
type: string
type: array
type: array
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.
type: object
settings:
additionalProperties:
type: string
description: Key-value settings.
type: object
sourceId:
description: The configuration source id.
type: string
subtypeId:
description: The configuration subtype id.
type: string
subtypeValue:
description: The configuration subtype value.
type: string
type:
description: The configuration type.
type: string
version:
description: The configuration version.
type: string
type: object
ErrorResponse:
properties:
developerMessage:
description: A more technical error message.
type: string
errors:
description: A list of detailed user friendly messages.
items:
$ref: '#/components/schemas/FieldError'
type: array
reasonCode:
description: A reason code.
type: integer
statusCode:
description: The status code.
type: integer
userMessage:
description: A high level error message.
type: string
type: object
ObjectType:
properties:
allowedWhen:
additionalProperties:
$ref: '#/components/schemas/FieldCondition'
description: Object type is allowed when one condition is true.
type: object
fieldValues:
additionalProperties:
$ref: '#/components/schemas/FieldCondition'
description: Object type discriminators.
type: object
label:
description: A label for this object type.
type: string
maxInstances:
description: Maximum number of instance of this type of object.
type: integer
minInstances:
description: Minimum number of instance of this type of object.
type: integer
notAllowedWhen:
additionalProperties:
$ref: '#/components/schemas/FieldCondition'
description: Object type is not allowed when one condition is true.
type: object
notRequiredWhen:
additionalProperties:
$ref: '#/components/schemas/FieldCondition'
description: Object type is not required when one condition is true.
type: object
required:
description: Required indicator.
type: boolean
requiredWhen:
additionalProperties:
$ref: '#/components/schemas/FieldCondition'
description: Object type is required when one condition is true.
type: object
type: object
Link:
properties:
href:
description: The URL.
type: string
type: object
ResultSet:
properties:
configurations:
description: list of configurations.
items:
$ref: '#/components/schemas/Configuration'
type: array
count:
description: Number of assets in the result set.
type: integer
limit:
description: Paging limit.
type: integer
links:
additionalProperties:
$ref: '#/components/schemas/Link'
description: Links.
type: object
offset:
description: Paging offset.
type: integer
totalCount:
description: Total number of assets.
type: integer
type: object
Element:
description: A form element.
properties:
allowed:
description: Allowed indicator.
type: boolean
allowedWhen:
additionalProperties:
$ref: '#/components/schemas/FieldCondition'
description: Field is allowed when one condition is true.
type: object
defaultValue:
description: A default value.
elements:
additionalProperties:
$ref: '#/components/schemas/Element'
description: Child elements
type: object
errorMessage:
description: An error message.
type: string
groups:
description: A list of groups.
items:
type: string
type: array
helpTopicId:
description: Help topic id.
type: string
hidden:
description: Hidden indicator.
type: boolean
information:
description: A list of information.
items:
type: string
type: array
label:
description: A human friendly label.
type: string
max:
description: Maximum date.
format: date-time
type: string
maxLength:
description: The max length.
type: integer
maxLengthWhen:
additionalProperties:
items:
$ref: '#/components/schemas/FieldCondition'
type: array
description: Conditional max lengths.
type: object
maxRepeats:
description: Number of times an item can repeat.
type: integer
min:
description: Minimum date.
format: date-time
type: string
minLength:
description: The minimum length.
type: integer
minRepeats:
description: Minimum number of repetitions.
type: integer
mode:
description: The mode.
enum:
- DropDown
- RadioGroup
type: string
notAllowedWhen:
additionalProperties:
$ref: '#/components/schemas/FieldCondition'
description: Field is not allowed when one condition is true.
type: object
notRequiredWhen:
additionalProperties:
$ref: '#/components/schemas/FieldCondition'
description: Field is not required when one condition is true.
type: object
objectTypes:
additionalProperties:
$ref: '#/components/schemas/ObjectType'
description: Object array item type prototype definitions.
type: object
order:
description: The order within the elements.
type: integer
pattern:
description: Regular expression.
type: string
patternWhen:
additionalProperties:
items:
$ref: '#/components/schemas/FieldCondition'
type: array
description: Conditional patterns.
type: object
repeats:
description: Item repeats indicator.
type: boolean
required:
description: Required indicator.
type: boolean
requiredWhen:
additionalProperties:
$ref: '#/components/schemas/FieldCondition'
description: Field is required when one condition is true.
type: object
type:
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
type: string
values:
description: A list of values.
valuesWhen:
additionalProperties:
items:
type: object
type: array
description: Conditional values.
type: object
type: object
securitySchemes:
oauth2:
type: oauth2
flows:
clientCredentials:
scopes:
healthcare-hipaa-transactions: Healthcare HIPAA Transactions
healthcare-hipaa-transactions-highvolume: Healthcare HIPAA Transactions High Volume
healthcare-hipaa-transactions-highvolume-standard: Standard
healthcare-hipaa-transactions-highvolume-unlimited: Unlimited
healthcare-hipaa-transactions-standard: Standard
rcm-coverages: RCM Coverages
rcm-coverages-standard: Standard
tokenUrl: https://api.availity.com/v1/token
x-refined-from:
- availity-configurations-openapi.json
- availity-configurations-openapi.yml