Function getAssistants

  • Retrieves the list of assistants. The result can be filtered, sorted, and paginated.

    Parameters

    • query: {
          countTotal?: boolean;
          limit?: number;
          next?: string;
          prev?: string;
          sort?:
              | "NAME"
              | "-NAME"
              | "DESCRIPTION"
              | "-DESCRIPTION"
              | "CREATED"
              | "-CREATED"
              | "UPDATED"
              | "-UPDATED";
      }

      an object with query parameters

      • OptionalcountTotal?: boolean

        Optional parameter to request total count for query.

      • Optionallimit?: number

        The number of assistants to get.

      • Optionalnext?: string

        Optional parameter to request the next page.

      • Optionalprev?: string

        Optional parameter to request the previous page.

      • Optionalsort?:
            | "NAME"
            | "-NAME"
            | "DESCRIPTION"
            | "-DESCRIPTION"
            | "CREATED"
            | "-CREATED"
            | "UPDATED"
            | "-UPDATED"

        Optional resource field name to sort on, case insensitive, e.g. name. Can be prefixed with - to set descending order; defaults to ascending.

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetAssistantsHttpResponse>

    GetAssistantsHttpError