Skip to content
Navigation

List Resources

List agendas using kind and active-state filters with stable keyset pagination.

  • Scope: agenda:resources:read
  • Credentials: an API key, a client-credentials token or a person's access token
  • Effect: read-only; safe to retry
  • Limits: response up to 8 MB
  • CLI: arbol agenda resources list · MCP tool: agenda_resources_list
GET
https://api.getarbol.com/v1/agenda/resources

Authorization

  • Authorization
    string
    required
    Bearer <token>, where the token is an API key, a client-credentials token or a person's access token with the scope agenda:resources:read. Get an API key.

Query parameters

  • cursor
    optional
    string

    Opaque cursor returned by pageInfo; omit it to request the first page.

  • direction
    optional
    forward
    or
    backward

    Direction to traverse the stable keyset ordering from the supplied cursor.

    default: "forward"
  • limit
    optional
    integer

    Maximum items returned in one page. Defaults to 25; larger reads require another cursor.

    maximum: 100 · minimum: 1 · default: 25
  • kind
    optional
    practitioner
    or
    assistant
    or
    room
    or
    chair
    or
    equipment
    or
    location
    +2 more

    Filter resources by the category used to satisfy offering requirements.

  • status
    optional
    active
    or
    inactive

    Filter the collection by the stored active or inactive lifecycle state; omit it to include both.

Returns

200

Successful operation.

JSON
  • success
    true
    required
  • data
    object
    required
    • data
      array of
      object
      required

      Items admitted by this resource contract within the verified organization.

      • capacity
        integer
        required

        Maximum concurrent units this resource or offering can accept.

      • details
        object
        required

        Bounded JSON configuration owned by this catalog record, including supported domain settings.

      • id
        string
        required

        Stable srs-prefixed Scheduling record identifier; ownership is checked in the authenticated organization.

        pattern: ^srs_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
      • kind
        practitioner
        or
        assistant
        or
        room
        or
        chair
        or
        equipment
        or
        location
        +2 more
        required

        Declared domain kind of this record or configuration element.

      • locationId
        string | null
        required

        The site it belongs to; null = not tied to one (covers every site).

        pattern: ^loc_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ · default: null
      • name
        string
        required

        Display name of this catalog or configuration record.

        maxLength: 160 · minLength: 1
      • object
        string
        required

        Stable resource discriminator identifying the response object kind.

      • schemaVersion
        number
        required

        Format version of this resource contract, distinct from its persisted record version.

      • status
        active
        or
        inactive
        required

        Lifecycle state controlling whether this record remains available to its domain consumers.

      • timezone
        string
        required

        IANA timezone used to interpret local working hours, appointment dates and age eligibility.

        maxLength: 120 · minLength: 1
      • updatedAt
        string
        required

        ISO 8601 instant with an explicit UTC or local offset; local-offset inputs are accepted.

        format: date-time
      • version
        integer
        required

        Persisted revision used to detect concurrent edits.

    • object
      string
      required

      Discriminator for a resource list response.

    • pageInfo
      object
      required

      Opaque navigation cursors for this page’s stable keyset order.

      • hasNextPage
        boolean
        required

        Whether a later page exists in the current ordering.

      • hasPreviousPage
        boolean
        required

        Whether an earlier page exists in the current ordering.

      • nextCursor
        string | null
        required

        Opaque cursor for the next page, or null when there is none.

      • previousCursor
        string | null
        required

        Opaque cursor for the previous page, or null when there is none.

  • error
    unknown
    required
  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

400

  • INVALID_INPUT: The request does not match the published schema.
  • WAITLIST_SERVICE_UNAVAILABLE: Correct serviceId using serviceId from bookingOfferings.list. Search a short service term such as neurología, then inspect the matching service name. Never invent an ID. No waiting-list entry was changed; correct this field and retry with the same consent.
  • WAITLIST_RESOURCE_UNAVAILABLE: The requested professional is not an active agenda for this service. Use resourceName for the requested professional or copy agendas[].id from bookingOfferings.list, never the offering id. If both are supplied, they must agree. No waiting-list entry was changed. Correct the reference with the same consent. If a verified provider professional is absent from Agenda, omit resourceName, clear resourceId and explicitly restrict the manual request to that professional in note.
  • WAITLIST_RESOURCE_AMBIGUOUS: More than one active agenda matches resourceName for this service. Read bookingOfferings.list and provide the complete requested professional name or its agendas[].id. No waiting-list entry was changed.
  • INVALID_APPOINTMENT_INTAKE: Correct the indicated patient or intake fields before booking.
  • INVALID_PATIENT_FIELDS: Correct the indicated patient fields before saving.
  • DURATION_CHANGE_OFF: This service does not allow changing appointment duration.
  • DURATION_NOT_ALLOWED: Select a duration allowed by this service.
  • STUDY_LENGTH_NOT_OFFERED: Select one of the study lengths this agenda offers.
  • INVALID_FILE_KIND: Select a supported attachment kind.
  • INVALID_FILE_NAME: Provide a valid attachment filename.
  • INVALID_ID_TOKEN: Provide a valid identity token.
  • INVALID_JSON: Send a valid JSON document.
  • INVALID_WINDOW: Provide a positive time window within the supported range.
  • UNEXPECTED_QUERY_PARAMETERS: Remove query parameters not declared by this operation.
  • INVALID_BODY: The request body could not be read. Send valid uncompressed JSON.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    required

    One of the following:

    • InvalidInputFailure
      INVALID_INPUT
      • code
        INVALID_INPUT
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required
        • issues
          optional
          array of
          object
          • path
            string
            required

            RFC 6901 JSON Pointer to the refused field; empty for the whole input.

            maxLength: 256
          • message
            string
            required
            maxLength: 256
    • AgendaWaitlistServiceUnavailableFailure
      WAITLIST_SERVICE_UNAVAILABLE
      • code
        WAITLIST_SERVICE_UNAVAILABLE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaWaitlistResourceUnavailableFailure
      WAITLIST_RESOURCE_UNAVAILABLE
      • code
        WAITLIST_RESOURCE_UNAVAILABLE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaWaitlistResourceAmbiguousFailure
      WAITLIST_RESOURCE_AMBIGUOUS
      • code
        WAITLIST_RESOURCE_AMBIGUOUS
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaInvalidAppointmentIntakeFailure
      INVALID_APPOINTMENT_INTAKE
      • code
        INVALID_APPOINTMENT_INTAKE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required
        • issues
          array of
          object
          required

          Up to 100 field refusals evaluated against the organization's current policy. No free-form message or submitted value is emitted.

          • code
            REQUIRED_FIELD
            or
            UNKNOWN_DOCUMENT_TYPE
            or
            UNKNOWN_CUSTOM_FIELD
            or
            INVALID_CUSTOM_FIELD
            required

            Finite organization-policy refusal. Resolve the named field and retry; submitted values are never included.

          • path
            array of
            required

            Path to the rejected input field, with at most eight segments. Unknown custom keys are represented by their parent fields path.

            One of the following:

            • string
            • integer
    • AgendaInvalidPatientFieldsFailure
      INVALID_PATIENT_FIELDS
      • code
        INVALID_PATIENT_FIELDS
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required
        • issues
          array of
          object
          required

          Up to 100 field refusals evaluated against the organization's current policy. No free-form message or submitted value is emitted.

          • code
            REQUIRED_FIELD
            or
            UNKNOWN_DOCUMENT_TYPE
            or
            UNKNOWN_CUSTOM_FIELD
            or
            INVALID_CUSTOM_FIELD
            required

            Finite organization-policy refusal. Resolve the named field and retry; submitted values are never included.

          • path
            array of
            required

            Path to the rejected input field, with at most eight segments. Unknown custom keys are represented by their parent fields path.

            One of the following:

            • string
            • integer
    • AgendaDurationChangeOffFailure
      DURATION_CHANGE_OFF
      • code
        DURATION_CHANGE_OFF
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaDurationNotAllowedFailure
      DURATION_NOT_ALLOWED
      • code
        DURATION_NOT_ALLOWED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaStudyLengthNotOfferedFailure
      STUDY_LENGTH_NOT_OFFERED
      • code
        STUDY_LENGTH_NOT_OFFERED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaInvalidFileKindFailure
      INVALID_FILE_KIND
      • code
        INVALID_FILE_KIND
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaInvalidFileNameFailure
      INVALID_FILE_NAME
      • code
        INVALID_FILE_NAME
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaInvalidIdTokenFailure
      INVALID_ID_TOKEN
      • code
        INVALID_ID_TOKEN
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaInvalidJsonFailure
      INVALID_JSON
      • code
        INVALID_JSON
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaInvalidWindowFailure
      INVALID_WINDOW
      • code
        INVALID_WINDOW
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaUnexpectedQueryParametersFailure
      UNEXPECTED_QUERY_PARAMETERS
      • code
        UNEXPECTED_QUERY_PARAMETERS
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaInvalidBodyFailure
      INVALID_BODY
      • code
        INVALID_BODY
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

401

UNAUTHORIZED: A valid access token is required.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    A valid access token is required.

    • code
      UNAUTHORIZED
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

403

  • FORBIDDEN: The token does not authorize this operation.
  • ID_TOKEN_MISMATCH: The identity token does not match the authenticated user.
  • NOT_FILE_UPLOADER: Only the uploader may delete this attachment.
  • NOT_NOTE_AUTHOR: Only the author may edit or delete this note.
  • ORIGIN_NOT_ALLOWED: This request origin is not allowed.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    required

    One of the following:

    • ForbiddenFailure
      FORBIDDEN
      • code
        FORBIDDEN
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaIdTokenMismatchFailure
      ID_TOKEN_MISMATCH
      • code
        ID_TOKEN_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaNotFileUploaderFailure
      NOT_FILE_UPLOADER
      • code
        NOT_FILE_UPLOADER
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaNotNoteAuthorFailure
      NOT_NOTE_AUTHOR
      • code
        NOT_NOTE_AUTHOR
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaOriginNotAllowedFailure
      ORIGIN_NOT_ALLOWED
      • code
        ORIGIN_NOT_ALLOWED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

404

RECORD_NOT_FOUND: The requested record does not exist.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The requested record does not exist.

    • code
      RECORD_NOT_FOUND
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

409

  • PAYER_STAFF_ONLY: This payer requires booking by the organization team. Add the patient to the waitlist for review.
  • APPOINTMENT_NOT_REMINDABLE: Only an open future appointment with a patient email can receive a reminder.
  • APPOINTMENT_WITHOUT_PATIENT: Link a patient to this appointment before performing this action.
  • ARBOL_CATALOG_TOO_LARGE: The integration catalog exceeds the supported size. Narrow the catalog before retrying.
  • ARBOL_CONFIGURATION_REQUIRED: Configure the organization integration before using it.
  • NOTIFICATIONS_NOT_SET_UP: Patient emails need the notifications module turned on.
  • SAME_OFFERING: An agenda cannot take its own appointments.
  • SAME_SERVICE: A service cannot be merged into itself.
  • INVALID_HOLD_PAYLOAD: The held slot is malformed.
  • HOLD_NOT_ACTIVE: The hold is no longer active.
  • APPOINTMENT_CLOSED: A cancelled appointment cannot be edited.
  • APPOINTMENT_VERSION_MISMATCH: The appointment changed after it was loaded.
  • APPOINTMENT_NOT_MOVABLE: A closed appointment cannot be moved.
  • SERVICE_CHANGED: The new slot belongs to another service.
  • SCHEDULE_CHANGED: The selected time no longer matches the current schedule.
  • INVALID_AVAILABILITY_WINDOW: Availability windows must be positive and at most 31 days.
  • SERVICE_CAPACITY_EXCEEDED: This service already has as many appointments as it can run at once at that time.
  • RESOURCE_CAPACITY_EXCEEDED: The selected time is no longer available.
  • OVERBOOK_OUT_OF_RANGE: An overbooked appointment must start between yesterday and the booking horizon.
  • OVERBOOK_UNAVAILABLE: No active agenda can take this appointment.
  • STUDY_OVERBOOKING_NOT_ALLOWED: This study has an explicit capacity limit and requires an available ordinary slot.
  • INVALID_SLOT_TOKEN: Request a fresh available slot before booking.
  • BIRTH_DATE_REQUIRED: This service has an age rule: the patient's date of birth is required.
  • AGE_NOT_ELIGIBLE: The patient's age on that day is outside this service's age rule.
  • INTAKE_SETTINGS_VERSION_MISMATCH: Intake settings changed; reload before saving.
  • PAYER_NAME_TAKEN: Another payer already has that name.
  • PAYER_VERSION_MISMATCH: The payer changed; reload before saving.
  • LOCATION_VERSION_MISMATCH: The site changed after it was loaded.
  • PROFILE_VERSION_MISMATCH: The profile changed after it was loaded.
  • PROVIDER_DISABLED: Enable the provider integration before using it.
  • BINDING_VERSION_MISMATCH: Connection changed or is synchronizing; refresh and retry.
  • RESOURCE_VERSION_MISMATCH: The resource changed after it was loaded.
  • SCHEDULE_RULE_AGENDA_MISMATCH: The schedule rule belongs to another agenda.
  • SCHEDULE_RULE_EXPECTED_VERSION_REQUIRED: Expected version is required for an update.
  • SCHEDULE_RULE_VERSION_MISMATCH: The schedule rule changed after it was loaded.
  • SCHEDULE_RULES_CHANGED: The schedule changed after it was loaded.
  • SERVICE_VERSION_MISMATCH: The service changed after it was loaded.
  • OFFERING_VERSION_MISMATCH: The offering changed after it was loaded.
  • SAME_RESOURCE: An agenda cannot take its own appointments.
  • TARGET_INACTIVE: An archived agenda takes no appointments.
  • SLOT_REQUIRED: A hold or slot token is required.
  • ARBOL_SETTINGS_VERSION_MISMATCH: Arbol settings changed.
  • NOTIFICATION_SETTINGS_VERSION_MISMATCH: Notification settings changed; reload before saving.
  • ORGANIZATION_VERSION_MISMATCH: The organization changed; reload before saving.
  • PATIENT_DOCUMENT_TAKEN: Another patient has that document.
  • PATIENT_VERSION_MISMATCH: The patient changed after it was loaded.
  • DAILY_REPORT_TOO_LARGE: Daily report exceeds the supported size; no partial report was generated.
  • REPORT_SETTINGS_VERSION_MISMATCH: Report settings changed; reload before saving.
  • REPORT_NOTIFICATIONS_DISABLED: Enable the notifications module before sending a daily agenda.
  • REPORT_RECIPIENTS_REQUIRED: No eligible organization owner or additional delivery address is available for this agenda.
  • WAITLIST_ENTRY_VERSION_MISMATCH: The waitlist entry changed; reload before saving.
  • REMOVAL_JOB_CONFLICT: A removal is already active, or this idempotency key belongs to another decision.
  • FOLLOWUP_SETTINGS_VERSION_MISMATCH: Follow-up email settings changed; reload before saving.
  • FOLLOWUP_DISABLED: Turn this follow-up email on in the notification settings first.
  • FOLLOWUP_CONSENT_REQUIRED: The patient has not consented to this follow-up email for their current address.
  • PATIENT_EMAIL_REQUIRED: Record the patient's email before this action.
  • PATIENT_ARCHIVED: Restore the patient before this action.
  • RECALL_ALREADY_ACTIVE: The patient already has an active recall for this service.
  • RECALL_MONTH_PASSED: The recall's month has already passed.
  • RECALL_VISIT_REQUIRED: Enter the last visit: there is no attended appointment of this service for the patient.
  • RECALL_VISIT_IN_FUTURE: The last visit must be a past date.
  • RECALL_VERSION_MISMATCH: The recall changed after it was loaded.
  • SLOT_OFFER_NOT_ALLOWED: Only an open waiting-list entry of a registered patient can receive a slot offer.
  • SLOT_OFFER_MISMATCH: The slot belongs to another service or agenda than the entry asks for.
  • SLOT_OFFER_TOO_SOON: The slot starts too soon to hold it for the patient; offer a later one.
  • SLOT_OFFER_ALREADY_OPEN: This waiting-list entry already has an open slot offer.
  • SLOT_OFFER_CLOSED: The slot offer is no longer open.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    required

    One of the following:

    • AgendaPayerStaffOnlyFailure
      PAYER_STAFF_ONLY
      • code
        PAYER_STAFF_ONLY
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaAppointmentNotRemindableFailure
      APPOINTMENT_NOT_REMINDABLE
      • code
        APPOINTMENT_NOT_REMINDABLE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaAppointmentWithoutPatientFailure
      APPOINTMENT_WITHOUT_PATIENT
      • code
        APPOINTMENT_WITHOUT_PATIENT
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaArbolCatalogTooLargeFailure
      ARBOL_CATALOG_TOO_LARGE
      • code
        ARBOL_CATALOG_TOO_LARGE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaArbolConfigurationRequiredFailure
      ARBOL_CONFIGURATION_REQUIRED
      • code
        ARBOL_CONFIGURATION_REQUIRED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaNotificationsNotSetUpFailure
      NOTIFICATIONS_NOT_SET_UP
      • code
        NOTIFICATIONS_NOT_SET_UP
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaSameOfferingFailure
      SAME_OFFERING
      • code
        SAME_OFFERING
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaSameServiceFailure
      SAME_SERVICE
      • code
        SAME_SERVICE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaInvalidHoldPayloadFailure
      INVALID_HOLD_PAYLOAD
      • code
        INVALID_HOLD_PAYLOAD
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaHoldNotActiveFailure
      HOLD_NOT_ACTIVE
      • code
        HOLD_NOT_ACTIVE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaAppointmentClosedFailure
      APPOINTMENT_CLOSED
      • code
        APPOINTMENT_CLOSED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaAppointmentVersionMismatchFailure
      APPOINTMENT_VERSION_MISMATCH
      • code
        APPOINTMENT_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaAppointmentNotMovableFailure
      APPOINTMENT_NOT_MOVABLE
      • code
        APPOINTMENT_NOT_MOVABLE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaServiceChangedFailure
      SERVICE_CHANGED
      • code
        SERVICE_CHANGED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaScheduleChangedFailure
      SCHEDULE_CHANGED
      • code
        SCHEDULE_CHANGED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaInvalidAvailabilityWindowFailure
      INVALID_AVAILABILITY_WINDOW
      • code
        INVALID_AVAILABILITY_WINDOW
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaServiceCapacityExceededFailure
      SERVICE_CAPACITY_EXCEEDED
      • code
        SERVICE_CAPACITY_EXCEEDED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaResourceCapacityExceededFailure
      RESOURCE_CAPACITY_EXCEEDED
      • code
        RESOURCE_CAPACITY_EXCEEDED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaOverbookOutOfRangeFailure
      OVERBOOK_OUT_OF_RANGE
      • code
        OVERBOOK_OUT_OF_RANGE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaOverbookUnavailableFailure
      OVERBOOK_UNAVAILABLE
      • code
        OVERBOOK_UNAVAILABLE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaStudyOverbookingNotAllowedFailure
      STUDY_OVERBOOKING_NOT_ALLOWED
      • code
        STUDY_OVERBOOKING_NOT_ALLOWED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaInvalidSlotTokenFailure
      INVALID_SLOT_TOKEN
      • code
        INVALID_SLOT_TOKEN
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaBirthDateRequiredFailure
      BIRTH_DATE_REQUIRED
      • code
        BIRTH_DATE_REQUIRED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaAgeNotEligibleFailure
      AGE_NOT_ELIGIBLE
      • code
        AGE_NOT_ELIGIBLE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaIntakeSettingsVersionMismatchFailure
      INTAKE_SETTINGS_VERSION_MISMATCH
      • code
        INTAKE_SETTINGS_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaPayerNameTakenFailure
      PAYER_NAME_TAKEN
      • code
        PAYER_NAME_TAKEN
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaPayerVersionMismatchFailure
      PAYER_VERSION_MISMATCH
      • code
        PAYER_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaLocationVersionMismatchFailure
      LOCATION_VERSION_MISMATCH
      • code
        LOCATION_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaProfileVersionMismatchFailure
      PROFILE_VERSION_MISMATCH
      • code
        PROFILE_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaProviderDisabledFailure
      PROVIDER_DISABLED
      • code
        PROVIDER_DISABLED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaBindingVersionMismatchFailure
      BINDING_VERSION_MISMATCH
      • code
        BINDING_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaResourceVersionMismatchFailure
      RESOURCE_VERSION_MISMATCH
      • code
        RESOURCE_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaScheduleRuleAgendaMismatchFailure
      SCHEDULE_RULE_AGENDA_MISMATCH
      • code
        SCHEDULE_RULE_AGENDA_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaScheduleRuleExpectedVersionRequiredFailure
      SCHEDULE_RULE_EXPECTED_VERSION_REQUIRED
      • code
        SCHEDULE_RULE_EXPECTED_VERSION_REQUIRED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaScheduleRuleVersionMismatchFailure
      SCHEDULE_RULE_VERSION_MISMATCH
      • code
        SCHEDULE_RULE_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaScheduleRulesChangedFailure
      SCHEDULE_RULES_CHANGED
      • code
        SCHEDULE_RULES_CHANGED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaServiceVersionMismatchFailure
      SERVICE_VERSION_MISMATCH
      • code
        SERVICE_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaOfferingVersionMismatchFailure
      OFFERING_VERSION_MISMATCH
      • code
        OFFERING_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaSameResourceFailure
      SAME_RESOURCE
      • code
        SAME_RESOURCE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaTargetInactiveFailure
      TARGET_INACTIVE
      • code
        TARGET_INACTIVE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaSlotRequiredFailure
      SLOT_REQUIRED
      • code
        SLOT_REQUIRED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaArbolSettingsVersionMismatchFailure
      ARBOL_SETTINGS_VERSION_MISMATCH
      • code
        ARBOL_SETTINGS_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaNotificationSettingsVersionMismatchFailure
      NOTIFICATION_SETTINGS_VERSION_MISMATCH
      • code
        NOTIFICATION_SETTINGS_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaOrganizationVersionMismatchFailure
      ORGANIZATION_VERSION_MISMATCH
      • code
        ORGANIZATION_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaPatientDocumentTakenFailure
      PATIENT_DOCUMENT_TAKEN
      • code
        PATIENT_DOCUMENT_TAKEN
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaPatientVersionMismatchFailure
      PATIENT_VERSION_MISMATCH
      • code
        PATIENT_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaDailyReportTooLargeFailure
      DAILY_REPORT_TOO_LARGE
      • code
        DAILY_REPORT_TOO_LARGE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaReportSettingsVersionMismatchFailure
      REPORT_SETTINGS_VERSION_MISMATCH
      • code
        REPORT_SETTINGS_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaReportNotificationsDisabledFailure
      REPORT_NOTIFICATIONS_DISABLED
      • code
        REPORT_NOTIFICATIONS_DISABLED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaReportRecipientsRequiredFailure
      REPORT_RECIPIENTS_REQUIRED
      • code
        REPORT_RECIPIENTS_REQUIRED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaWaitlistEntryVersionMismatchFailure
      WAITLIST_ENTRY_VERSION_MISMATCH
      • code
        WAITLIST_ENTRY_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaRemovalJobConflictFailure
      REMOVAL_JOB_CONFLICT
      • code
        REMOVAL_JOB_CONFLICT
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaFollowupSettingsVersionMismatchFailure
      FOLLOWUP_SETTINGS_VERSION_MISMATCH
      • code
        FOLLOWUP_SETTINGS_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaFollowupDisabledFailure
      FOLLOWUP_DISABLED
      • code
        FOLLOWUP_DISABLED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaFollowupConsentRequiredFailure
      FOLLOWUP_CONSENT_REQUIRED
      • code
        FOLLOWUP_CONSENT_REQUIRED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaPatientEmailRequiredFailure
      PATIENT_EMAIL_REQUIRED
      • code
        PATIENT_EMAIL_REQUIRED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaPatientArchivedFailure
      PATIENT_ARCHIVED
      • code
        PATIENT_ARCHIVED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaRecallAlreadyActiveFailure
      RECALL_ALREADY_ACTIVE
      • code
        RECALL_ALREADY_ACTIVE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaRecallMonthPassedFailure
      RECALL_MONTH_PASSED
      • code
        RECALL_MONTH_PASSED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaRecallVisitRequiredFailure
      RECALL_VISIT_REQUIRED
      • code
        RECALL_VISIT_REQUIRED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaRecallVisitInFutureFailure
      RECALL_VISIT_IN_FUTURE
      • code
        RECALL_VISIT_IN_FUTURE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaRecallVersionMismatchFailure
      RECALL_VERSION_MISMATCH
      • code
        RECALL_VERSION_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaSlotOfferNotAllowedFailure
      SLOT_OFFER_NOT_ALLOWED
      • code
        SLOT_OFFER_NOT_ALLOWED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaSlotOfferMismatchFailure
      SLOT_OFFER_MISMATCH
      • code
        SLOT_OFFER_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaSlotOfferTooSoonFailure
      SLOT_OFFER_TOO_SOON
      • code
        SLOT_OFFER_TOO_SOON
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaSlotOfferAlreadyOpenFailure
      SLOT_OFFER_ALREADY_OPEN
      • code
        SLOT_OFFER_ALREADY_OPEN
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaSlotOfferClosedFailure
      SLOT_OFFER_CLOSED
      • code
        SLOT_OFFER_CLOSED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

415

  • APPLICATION_JSON_REQUIRED: Send the request as application/json.
  • FILE_CONTENT_MISMATCH: The uploaded content does not match its declared file type.
  • UNSUPPORTED_CONTENT_ENCODING: Send an uncompressed request body.
  • UNSUPPORTED_FILE_TYPE: Select a supported attachment file type.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    required

    One of the following:

    • AgendaApplicationJsonRequiredFailure
      APPLICATION_JSON_REQUIRED
      • code
        APPLICATION_JSON_REQUIRED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaFileContentMismatchFailure
      FILE_CONTENT_MISMATCH
      • code
        FILE_CONTENT_MISMATCH
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaUnsupportedContentEncodingFailure
      UNSUPPORTED_CONTENT_ENCODING
      • code
        UNSUPPORTED_CONTENT_ENCODING
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaUnsupportedFileTypeFailure
      UNSUPPORTED_FILE_TYPE
      • code
        UNSUPPORTED_FILE_TYPE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

426

UPGRADE_REQUIRED: Open the live channel with a WebSocket upgrade.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    Open the live channel with a WebSocket upgrade.

    • code
      UPGRADE_REQUIRED
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

429

RATE_LIMITED: The request rate limit was exceeded. Try again later.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The request rate limit was exceeded. Try again later.

    • code
      RATE_LIMITED
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      true
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

500

INTERNAL_ERROR: The service could not complete the operation.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The service could not complete the operation.

    • code
      INTERNAL_ERROR
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

502

OUTCOME_UNKNOWN: The operation may have been applied; check its result before repeating it.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The operation may have been applied; check its result before repeating it.

    • code
      OUTCOME_UNKNOWN
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      false
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

503

  • UPSTREAM_UNAVAILABLE: The upstream service could not complete the request.
  • ARBOL_RESPONSE_TOO_LARGE: The integration response exceeds the supported size.
  • ARBOL_UNAVAILABLE: The integration service is temporarily unavailable. Retry later.
  • REMOVAL_WORKFLOW_UNAVAILABLE: Durable removal is unavailable here; use the bounded manual removal operations.
  • ARBOL_REFUSED: The integration service rejected this request. Review its configuration.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    required

    One of the following:

    • UpstreamUnavailableFailure
      UPSTREAM_UNAVAILABLE
      • code
        UPSTREAM_UNAVAILABLE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        true
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaArbolResponseTooLargeFailure
      ARBOL_RESPONSE_TOO_LARGE
      • code
        ARBOL_RESPONSE_TOO_LARGE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaArbolUnavailableFailure
      ARBOL_UNAVAILABLE
      • code
        ARBOL_UNAVAILABLE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        true
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaRemovalWorkflowUnavailableFailure
      REMOVAL_WORKFLOW_UNAVAILABLE
      • code
        REMOVAL_WORKFLOW_UNAVAILABLE
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

    • AgendaArbolRefusedFailure
      ARBOL_REFUSED
      • code
        ARBOL_REFUSED
        required

        The failure code, stable across releases.

      • message
        string
        required

        What went wrong, for people; it never contains input values.

      • retryable
        false
        required

        Whether repeating the same request may succeed.

      • data
        object
        required

        No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

504

UPSTREAM_TIMEOUT: The upstream service did not respond before its deadline.
JSON
  • success
    false
    required
  • data
    unknown
    required
  • error
    object
    required

    The upstream service did not respond before its deadline.

    • code
      UPSTREAM_TIMEOUT
      required

      The failure code, stable across releases.

    • message
      string
      required

      What went wrong, for people; it never contains input values.

    • retryable
      true
      required

      Whether repeating the same request may succeed.

    • data
      object
      required

      No fields.

  • metadata
    object
    required

    What every answer carries besides its data or error.

    • requestId
      string
      required

      Request correlation identifier, also sent as X-Request-Id.

Escribe para buscar…

↑↓ navegar↵ seleccionarEsc cerrar