JOjoincandidhealth
v3

Get all tasks

Changed on
get/api/tasks/v3

Request

  • Base URL
    https://pre-api.joincandidhealth.com
  • URL
    https://pre-api.joincandidhealth.com/api/tasks/v3
  • Auth
    HTTP bearer

Query parameters

limitinteger

Defaults to 100

page_tokenstring
status'finished' | 'addressed_by_provider_group' | 'sent_to_provider_group' | 'open' | 'blocked' | 'waiting_for_review' | 'in_progress'
statusesstring

Only return tasks with a status that matches one in this comma-separated list.

task_type'CUSTOMER_DATA_REQUEST' | 'CLAIM_SUBMISSION_RUN_VALIDATIONS_FAILURE' | 'CLAIM_SUBMISSION_SUBMIT_CLAIM_FAILURE' | 'CLAIM_SUBMISSION_TRANSFORM_FAILURE' | 'CODE_CLAIM' | 'CODE_CLAIM_REVIEW' | 'ELIGIBILITY' | 'CLAIM_FOLLOW_UP' | 'REJECTION_RESOLUTION' | 'PAYER_CONFIGURATION_ERROR' | 'DENIAL_RESOLUTION' | 'MISSING_ENROLLMENT' | 'CHARGE_CAPTURE_UPDATE'
task_typesstring

Only return tasks with a task_type that matches one in this comma-separated list.

categoriesstring

Only return tasks with categories that match one in this comma-separated list.

updated_sincestring date-time

Only return tasks updated on or after this date-time

encounter_idstring uuid

Only return tasks associated with this encounter

search_termstring

Query tasks by encounter_id, claim_id, task_id, or external_id

assigned_to_idstring uuid

Only return tasks assigned to this user

date_of_service_minstring date

The minimum date of service for the linked encounter

date_of_service_maxstring date

The maximum date of service for the linked encounter

billing_provider_npistring

The NPI of the billing provider associated with the task's claim

sort'updated_at:asc' | 'updated_at:desc' | 'patient_name:asc' | 'patient_name:desc' | 'patient_external_id:asc' | 'patient_external_id:desc' | 'payer_name:asc' | 'payer_name:desc' | 'payer_id:asc' | 'payer_id:desc' | 'status:asc' | 'status:desc' | 'task_type:asc' | 'task_type:desc' | 'category:asc' | 'category:desc' | 'agg_updated_at:asc' | 'agg_updated_at:desc' | 'date_of_service:asc' | 'date_of_service:desc' | 'blocks_claim_submission:asc' | 'blocks_claim_submission:desc'

Defaults to updated_at:desc

Response

Response with status 200

prev_page_tokenstring
next_page_tokenstring

Changes

  • 24b2d80d577aRevision changes
    • breaking

      the query request parameter sort was restricted to a list of enum values

    • breaking

      the query request parameter status was restricted to a list of enum values

    • breaking

      the query request parameter task_type was restricted to a list of enum values

    • breaking

      the response's body type changed from no type to object for status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security OAuthScheme was added to the API

    • info

      added the new enum value CHARGE_CAPTURE_UPDATE to the query request parameter task_type

    • info

      added the new enum value CLAIM_FOLLOW_UP to the query request parameter task_type

    • info

      added the new enum value CLAIM_SUBMISSION_RUN_VALIDATIONS_FAILURE to the query request parameter task_type

    • info

      added the new enum value CLAIM_SUBMISSION_SUBMIT_CLAIM_FAILURE to the query request parameter task_type

    • info

      added the new enum value CLAIM_SUBMISSION_TRANSFORM_FAILURE to the query request parameter task_type

    • info

      added the new enum value CODE_CLAIM to the query request parameter task_type

    • info

      added the new enum value CODE_CLAIM_REVIEW to the query request parameter task_type

    • info

      added the new enum value CUSTOMER_DATA_REQUEST to the query request parameter task_type

    • info

      added the new enum value DENIAL_RESOLUTION to the query request parameter task_type

    • info

      added the new enum value ELIGIBILITY to the query request parameter task_type

    • info

      added the new enum value MISSING_ENROLLMENT to the query request parameter task_type

    • info

      added the new enum value PAYER_CONFIGURATION_ERROR to the query request parameter task_type

    • info

      added the new enum value REJECTION_RESOLUTION to the query request parameter task_type

    • info

      added the new enum value addressed_by_provider_group to the query request parameter status

    • info

      added the new enum value agg_updated_at:asc to the query request parameter sort

    • info

      added the new enum value agg_updated_at:desc to the query request parameter sort

    • info

      added the new enum value blocked to the query request parameter status

    • info

      added the new enum value blocks_claim_submission:asc to the query request parameter sort

    • info

      added the new enum value blocks_claim_submission:desc to the query request parameter sort

    • info

      added the new enum value category:asc to the query request parameter sort

    • info

      added the new enum value category:desc to the query request parameter sort

    • info

      added the new enum value date_of_service:asc to the query request parameter sort

    • info

      added the new enum value date_of_service:desc to the query request parameter sort

    • info

      added the new enum value finished to the query request parameter status

    • info

      added the new enum value in_progress to the query request parameter status

    • info

      added the new enum value open to the query request parameter status

    • info

      added the new enum value patient_external_id:asc to the query request parameter sort

    • info

      added the new enum value patient_external_id:desc to the query request parameter sort

    • info

      added the new enum value patient_name:asc to the query request parameter sort

    • info

      added the new enum value patient_name:desc to the query request parameter sort

    • info

      added the new enum value payer_id:asc to the query request parameter sort

    • info

      added the new enum value payer_id:desc to the query request parameter sort

    • info

      added the new enum value payer_name:asc to the query request parameter sort

    • info

      added the new enum value payer_name:desc to the query request parameter sort

    • info

      added the new enum value sent_to_provider_group to the query request parameter status

    • info

      added the new enum value status:asc to the query request parameter sort

    • info

      added the new enum value status:desc to the query request parameter sort

    • info

      added the new enum value task_type:asc to the query request parameter sort

    • info

      added the new enum value task_type:desc to the query request parameter sort

    • info

      added the new enum value updated_at:asc to the query request parameter sort

    • info

      added the new enum value updated_at:desc to the query request parameter sort

    • info

      added the new enum value waiting_for_review to the query request parameter status

    • info

      for the query request parameter sort, the type was generalized from no type to string

    • info

      for the query request parameter status, the type was generalized from no type to string

    • info

      for the query request parameter task_type, the type was generalized from no type to string

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 3a81ee81d4edRevision changes
    • info

      api operation id get_multi removed and replaced with v3_get_multi_4