ContractsV3

Get all contracts

get/api/contracts/v3

Request

  • Base URL: https://api.taigabilling.com
  • URL: https://api.taigabilling.com/api/contracts/v3
  • Auth: HTTP bearer

Query parameters

page_tokenstring
limitinteger nullable

Max number of contracts returned. Defaults to 1000. Max is 1000.

type'professional' | 'institutional'

The type of contract

contracting_provider_idstring uuid
rendering_provider_idsContractsv3RenderingProviderid[]
payer_namesstring[]

Filter to contracts that include any of the included payer names.

statesState[]
contract_status'pending' | 'effective' | 'cancelled'

The status of the contract. Defaults to pending

sort'created_at' | 'payer_name' | 'payer_id' | 'billing_provider_name' | 'effective_date' | 'contract_status'

Potentially sort by a contract related attribute. Defaults to created_at

sort_direction'asc' | 'desc'

Direction of sort, defaulting to desc

Response

prev_page_tokenstring
next_page_tokenstring

Changes

No recorded changes to this operation across all 1 revision of this API.