Class XmlClient

XML API Client

Provides methods for calling legacy QuickBase XML API endpoints. Create using the createXmlClient() function.

Constructors

constructor

new XmlClient(caller: XmlCaller, options?: XmlClientOptions): XmlClient
Parameters
- caller: XmlCaller
- Optionaloptions: XmlClientOptions
Returns XmlClient
- Defined in src/xml/index.ts:273

Methods

addGroupToRole

addGroupToRole(appId: string, groupId: string, roleId: number): Promise<void>
Assign a group to a role.
Parameters
- appId: string
- groupId: string
- roleId: number
Returns Promise<void>
See
https://help.quickbase.com/docs/api-addgrouptorole
- Defined in src/xml/index.ts:483

addReplaceDBPage

addReplaceDBPage(
    appId: string,
    pageName: string,
    pageId: number | undefined,
    pageType: PageType,
    pageBody: string,
): Promise<AddReplaceDBPageResult>
Create or update a code page.
Parameters
- appId: string
- pageName: string
- pageId: number | undefined
- pageType: PageType
- pageBody: string
Returns Promise<AddReplaceDBPageResult>
See
https://help.quickbase.com/docs/api-addreplacedbpage
- Defined in src/xml/index.ts:691

addSubgroup

addSubgroup(groupId: string, subgroupId: string): Promise<void>
Add a subgroup to a group.
Parameters
- groupId: string
- subgroupId: string
Returns Promise<void>
See
https://help.quickbase.com/docs/api-addsubgroup
- Defined in src/xml/index.ts:523

addUserToGroup

addUserToGroup(
    groupId: string,
    userId: string,
    allowAdminAccess?: boolean,
): Promise<void>
Add a user to a group.
Parameters
- groupId: string
- userId: string
- OptionalallowAdminAccess: boolean
Returns Promise<void>
See
https://help.quickbase.com/docs/api-addusertogroup
- Defined in src/xml/index.ts:453

addUserToRole

addUserToRole(appId: string, userId: string, roleId: number): Promise<void>
Assign a user to a role.
Parameters
- appId: string
- userId: string
- roleId: number
Returns Promise<void>
See
https://help.quickbase.com/docs/api-addusertorole
- Defined in src/xml/index.ts:359

changeGroupInfo

changeGroupInfo(
    groupId: string,
    name?: string,
    description?: string,
    accountId?: string,
): Promise<void>
Change group information.
Parameters
- groupId: string
- Optionalname: string
- Optionaldescription: string
- OptionalaccountId: string
Returns Promise<void>
See
https://help.quickbase.com/docs/api-changegroupinfo
- Defined in src/xml/index.ts:431

changeManager

changeManager(appId: string, newManagerEmail: string): Promise<void>
Change the application manager.
Parameters
- appId: string
- newManagerEmail: string
Returns Promise<void>
See
https://help.quickbase.com/docs/api-changemanager
- Defined in src/xml/index.ts:577

changeRecordOwner

changeRecordOwner(
    tableId: string,
    recordId: number,
    newOwner: string,
): Promise<void>
Change the owner of a record.
Parameters
- tableId: string
- recordId: number
- newOwner: string
Returns Promise<void>
See
https://help.quickbase.com/docs/api-changerecordowner
- Defined in src/xml/index.ts:586

changeUserRole

changeUserRole(
    appId: string,
    userId: string,
    currentRoleId: number,
    newRoleId?: number,
): Promise<void>
Change a user's role.
Parameters
- appId: string
- userId: string
- currentRoleId: number
- OptionalnewRoleId: number
Returns Promise<void>
See
https://help.quickbase.com/docs/api-changeuserrole
- Defined in src/xml/index.ts:377

copyGroup

copyGroup(
    groupId: string,
    name?: string,
    description?: string,
    accountId?: string,
): Promise<CreateGroupResult>
Copy a group.
Parameters
- groupId: string
- Optionalname: string
- Optionaldescription: string
- OptionalaccountId: string
Returns Promise<CreateGroupResult>
See
https://help.quickbase.com/docs/api-copygroup
- Defined in src/xml/index.ts:417

copyMasterDetail

copyMasterDetail(
    tableId: string,
    options: {
        copyfid?: string | number;
        recurse?: boolean;
        relfids?: (string | number)[];
        rid: number;
    },
): Promise<CopyMasterDetailResult>
Copy a master record with its detail records.
Parameters
- tableId: string
- options: {
      copyfid?: string | number;
      recurse?: boolean;
      relfids?: (string | number)[];
      rid: number;
  }
Returns Promise<CopyMasterDetailResult>
See
https://help.quickbase.com/docs/api-copymasterdetail
- Defined in src/xml/index.ts:821

createGroup

createGroup(
    name: string,
    description?: string,
    accountId?: string,
): Promise<CreateGroupResult>
Create a new group.
Parameters
- name: string
- Optionaldescription: string
- OptionalaccountId: string
Returns Promise<CreateGroupResult>
See
https://help.quickbase.com/docs/api-creategroup
- Defined in src/xml/index.ts:395

deleteGroup

deleteGroup(groupId: string): Promise<void>
Delete a group.
Parameters
- groupId: string
Returns Promise<void>
See
https://help.quickbase.com/docs/api-deletegroup
- Defined in src/xml/index.ts:408

doQueryCount

doQueryCount(tableId: string, query?: string): Promise<DoQueryCountResult>
Get count of matching records without fetching data.
Parameters
- tableId: string
- Optionalquery: string
Returns Promise<DoQueryCountResult>
See
https://help.quickbase.com/docs/api-doquerycount
- Defined in src/xml/index.ts:757

executeXml

executeXml(dbid: string, action: string, body: string): Promise<string>
Execute a raw XML API request. Enforces read-only mode if enabled. This is exposed for direct XML API calls not covered by typed methods.
Parameters
- dbid: string
- action: string
- body: string
Returns Promise<string>
- Defined in src/xml/index.ts:311

fieldAddChoices

fieldAddChoices(
    tableId: string,
    fieldId: string | number,
    choices: string[],
): Promise<FieldAddChoicesResultWithAlias>
Add choices to a multiple-choice field.
Parameters
- tableId: string
- fieldId: string | number
- choices: string[]
Returns Promise<FieldAddChoicesResultWithAlias>
See
https://help.quickbase.com/docs/api-fieldaddchoices
- Defined in src/xml/index.ts:710

fieldRemoveChoices

fieldRemoveChoices(
    tableId: string,
    fieldId: string | number,
    choices: string[],
): Promise<FieldRemoveChoicesResultWithAlias>
Remove choices from a multiple-choice field.
Parameters
- tableId: string
- fieldId: string | number
- choices: string[]
Returns Promise<FieldRemoveChoicesResultWithAlias>
See
https://help.quickbase.com/docs/api-fieldremovechoices
- Defined in src/xml/index.ts:726

findDBByName

findDBByName(
name: string,
parentsOnly?: boolean,
): Promise<FindDBByNameResultWithAlias>
Find an app by name.
Parameters
- name: string
- OptionalparentsOnly: boolean
Returns Promise<FindDBByNameResultWithAlias>
See
https://help.quickbase.com/docs/api-finddbbyname
- Defined in src/xml/index.ts:619

genAddRecordForm

genAddRecordForm(
tableId: string,
fields?: { id: string | number; value: string }[],
): Promise<string>
Generate HTML form for adding a record.
Parameters
- tableId: string
- Optionalfields: { id: string | number; value: string }[]
Returns Promise<string>
See
https://help.quickbase.com/docs/api-genaddrecordform
- Defined in src/xml/index.ts:934

genResultsTable

genResultsTable(
    tableId: string,
    options?: {
        clist?: (string | number)[];
        format?: "structured" | "csv";
        options?: string;
        query?: string;
        slist?: (string | number)[];
    },
): Promise<string>
Generate HTML/JS/CSV table of query results.
Parameters
- tableId: string
- Optionaloptions: {
      clist?: (string | number)[];
      format?: "structured" | "csv";
      options?: string;
      query?: string;
      slist?: (string | number)[];
  }
Returns Promise<string>
See
https://help.quickbase.com/docs/api-genresultstable
- Defined in src/xml/index.ts:950

getAncestorInfo

getAncestorInfo(appId: string): Promise<GetAncestorInfoResult>
Get app copy/template lineage info.
Parameters
- appId: string
Returns Promise<GetAncestorInfoResult>
See
https://help.quickbase.com/docs/api-getancestorinfo
- Defined in src/xml/index.ts:860

getAppDTMInfo

getAppDTMInfo(appId: string): Promise<GetAppDTMInfoResultWithAlias>
Get modification timestamps (fast, no auth required).
Parameters
- appId: string
Returns Promise<GetAppDTMInfoResultWithAlias>
See
https://help.quickbase.com/docs/api-getappdtminfo
- Defined in src/xml/index.ts:851

getDBInfo

getDBInfo(dbid: string): Promise<DBInfo>
Get app/table metadata.
Parameters
- dbid: string
Returns Promise<DBInfo>
See
https://help.quickbase.com/docs/api-getdbinfo
- Defined in src/xml/index.ts:628

getDBPage

getDBPage(appId: string, pageIdOrName: string | number): Promise<string>
Get stored code page content.
Parameters
- appId: string
- pageIdOrName: string | number
Returns Promise<string>
See
https://help.quickbase.com/docs/api-getdbpage
- Defined in src/xml/index.ts:683

getDBVar

getDBVar(appId: string, varName: string): Promise<string>
Get an application variable value.
Parameters
- appId: string
- varName: string
Returns Promise<string>
See
https://help.quickbase.com/docs/api-getdbvar
- Defined in src/xml/index.ts:662

getGroupRole

getGroupRole(appId: string, groupId: string): Promise<GetGroupRoleResult>
Get roles assigned to a group in an app.
Parameters
- appId: string
- groupId: string
Returns Promise<GetGroupRoleResult>
See
https://help.quickbase.com/docs/api-getgrouprole
- Defined in src/xml/index.ts:475

getNumRecords

getNumRecords(tableId: string): Promise<number>
Get total record count for a table.
Parameters
- tableId: string
Returns Promise<number>
See
https://help.quickbase.com/docs/api-getnumrecords
- Defined in src/xml/index.ts:636

getRecordAsHTML

getRecordAsHTML(
    tableId: string,
    options: {
        dfid?: string | number;
        jht?: boolean;
        key?: string;
        rid?: number;
    },
): Promise<string>
Get a record rendered as HTML.
Parameters
- tableId: string
- options: { dfid?: string | number; jht?: boolean; key?: string; rid?: number }
Returns Promise<string>
See
https://help.quickbase.com/docs/api-getrecordashtml
- Defined in src/xml/index.ts:973

getRecordInfo

getRecordInfo(
tableId: string,
recordId: number,
): Promise<GetRecordInfoResultWithAlias>
Get a record with field metadata.
Parameters
- tableId: string
- recordId: number
Returns Promise<GetRecordInfoResultWithAlias>
See
https://help.quickbase.com/docs/api-getrecordinfo
- Defined in src/xml/index.ts:765

getRecordInfoByKey

getRecordInfoByKey(
tableId: string,
keyValue: string,
): Promise<GetRecordInfoResultWithAlias>
Get a record by key field value.
Parameters
- tableId: string
- keyValue: string
Returns Promise<GetRecordInfoResultWithAlias>
See
https://help.quickbase.com/docs/api-getrecordinfo
- Defined in src/xml/index.ts:775

getRoleInfo

getRoleInfo(appId: string): Promise<GetRoleInfoResult>
Get all roles defined in an application.
Parameters
- appId: string
Returns Promise<GetRoleInfoResult>
See
https://help.quickbase.com/docs/api-getroleinfo
- Defined in src/xml/index.ts:331

getSchema

getSchema(dbid: string): Promise<GetSchemaResultWithAlias>
Get comprehensive app/table metadata.
Parameters
- dbid: string
Returns Promise<GetSchemaResultWithAlias>
See
https://help.quickbase.com/docs/api-getschema
- Defined in src/xml/index.ts:648

getUserInfo

getUserInfo(email?: string): Promise<UserInfo>
Get user information by email.
Parameters
- Optionalemail: string
Returns Promise<UserInfo>
See
https://help.quickbase.com/docs/api-getuserinfo
- Defined in src/xml/index.ts:545

getUserRole

getUserRole(
    appId: string,
    userId?: string,
    includeGroups?: boolean,
): Promise<GetUserRoleResult>
Get roles for a specific user.
Parameters
- appId: string
- OptionaluserId: string
- OptionalincludeGroups: boolean
Returns Promise<GetUserRoleResult>
See
https://help.quickbase.com/docs/api-getuserrole
- Defined in src/xml/index.ts:347

getUsersInGroup

getUsersInGroup(
groupId: string,
includeManagers?: boolean,
): Promise<GetUsersInGroupResult>
Get users and managers in a group.
Parameters
- groupId: string
- OptionalincludeManagers: boolean
Returns Promise<GetUsersInGroupResult>
See
https://help.quickbase.com/docs/api-getusersingroup
- Defined in src/xml/index.ts:445

grantedDBs

grantedDBs(
    options?: {
        adminOnly?: boolean;
        excludeParents?: boolean;
        includeAncestors?: boolean;
        parentsOnly?: boolean;
        realmAppsOnly?: boolean;
        withEmbeddedTables?: boolean;
    },
): Promise<GrantedDBsResultWithAlias>
List all apps/tables the user can access.
Parameters
- Optionaloptions: {
      adminOnly?: boolean;
      excludeParents?: boolean;
      includeAncestors?: boolean;
      parentsOnly?: boolean;
      realmAppsOnly?: boolean;
      withEmbeddedTables?: boolean;
  }
Returns Promise<GrantedDBsResultWithAlias>
See
https://help.quickbase.com/docs/api-granteddbs
- Defined in src/xml/index.ts:603

grantedDBsForGroup

grantedDBsForGroup(groupId: string): Promise<GrantedDBsForGroupResultWithAlias>
Get apps a group can access.
Parameters
- groupId: string
Returns Promise<GrantedDBsForGroupResultWithAlias>
See
https://help.quickbase.com/docs/api-granteddbsforgroup
- Defined in src/xml/index.ts:514

grantedGroups

grantedGroups(
userId?: string,
adminOnly?: boolean,
): Promise<GrantedGroupsResult>
Get groups a user belongs to.
Parameters
- OptionaluserId: string
- OptionaladminOnly: boolean
Returns Promise<GrantedGroupsResult>
See
https://help.quickbase.com/docs/api-grantedgroups
- Defined in src/xml/index.ts:506

importFromCSV

importFromCSV(
    tableId: string,
    options: {
        clist?: (string | number)[];
        decimalPercent?: boolean;
        mergeFieldId?: string | number;
        recordsCsv: string;
        skipFirst?: boolean;
    },
): Promise<ImportFromCSVResult>
Bulk import/update records from CSV data.
Parameters
- tableId: string
- options: {
      clist?: (string | number)[];
      decimalPercent?: boolean;
      mergeFieldId?: string | number;
      recordsCsv: string;
      skipFirst?: boolean;
  }
Returns Promise<ImportFromCSVResult>
See
https://help.quickbase.com/docs/api-importfromcsv
- Defined in src/xml/index.ts:785

provisionUser

provisionUser(
    appId: string,
    email: string,
    firstName: string,
    lastName: string,
    roleId?: number,
): Promise<ProvisionUserResult>
Create a new unregistered user.
Parameters
- appId: string
- email: string
- firstName: string
- lastName: string
- OptionalroleId: number
Returns Promise<ProvisionUserResult>
See
https://help.quickbase.com/docs/api-provisionuser
- Defined in src/xml/index.ts:553

realm

realm(): string
Get the realm name

Returns string
- Defined in src/xml/index.ts:319

removeGroupFromRole

removeGroupFromRole(
    appId: string,
    groupId: string,
    roleId: number,
    allRoles?: boolean,
): Promise<void>
Remove a group from a role.
Parameters
- appId: string
- groupId: string
- roleId: number
- OptionalallRoles: boolean
Returns Promise<void>
See
https://help.quickbase.com/docs/api-removegroupfromrole
- Defined in src/xml/index.ts:492

removeSubgroup

removeSubgroup(groupId: string, subgroupId: string): Promise<void>
Remove a subgroup from a group.
Parameters
- groupId: string
- subgroupId: string
Returns Promise<void>
See
https://help.quickbase.com/docs/api-removesubgroup
- Defined in src/xml/index.ts:532

removeUserFromGroup

removeUserFromGroup(groupId: string, userId: string): Promise<void>
Remove a user from a group.
Parameters
- groupId: string
- userId: string
Returns Promise<void>
See
https://help.quickbase.com/docs/api-removeuserfromgroup
- Defined in src/xml/index.ts:466

removeUserFromRole

removeUserFromRole(appId: string, userId: string, roleId: number): Promise<void>
Remove a user from a role.
Parameters
- appId: string
- userId: string
- roleId: number
Returns Promise<void>
See
https://help.quickbase.com/docs/api-removeuserfromrole
- Defined in src/xml/index.ts:368

runImport

runImport(tableId: string, importId: number): Promise<ImportFromCSVResult>
Execute a saved import definition.
Parameters
- tableId: string
- importId: number
Returns Promise<ImportFromCSVResult>
See
https://help.quickbase.com/docs/api-runimport
- Defined in src/xml/index.ts:812

sendInvitation

sendInvitation(appId: string, userId: string, userText?: string): Promise<void>
Send invitation email to a user.
Parameters
- appId: string
- userId: string
- OptionaluserText: string
Returns Promise<void>
See
https://help.quickbase.com/docs/api-sendinvitation
- Defined in src/xml/index.ts:568

setDBVar

setDBVar(appId: string, varName: string, value: string): Promise<void>
Set an application variable value.
Parameters
- appId: string
- varName: string
- value: string
Returns Promise<void>
See
https://help.quickbase.com/docs/api-setdbvar
- Defined in src/xml/index.ts:670

setKeyField

setKeyField(tableId: string, fieldId: string | number): Promise<void>
Set the key field for a table.
Parameters
- tableId: string
- fieldId: string | number
Returns Promise<void>
See
https://help.quickbase.com/docs/api-setkeyfield
- Defined in src/xml/index.ts:742

signOut

signOut(): Promise<void>
Clear ticket cookie (browser-focused).

Returns Promise<void>
See
https://help.quickbase.com/docs/api-signout
- Defined in src/xml/index.ts:1000

userRoles

userRoles(appId: string): Promise<UserRolesResult>
Get all users in an application and their role assignments.
Parameters
- appId: string
Returns Promise<UserRolesResult>
See
https://help.quickbase.com/docs/api-userroles
- Defined in src/xml/index.ts:339

webhooksActivate

webhooksActivate(
tableId: string,
actionIds: string[],
): Promise<{ numChanged: number }>
Activate webhooks.
Parameters
- tableId: string
- actionIds: string[]
Returns Promise<{ numChanged: number }>
See
https://help.quickbase.com/docs/api-webhooks-activate
- Defined in src/xml/index.ts:903

webhooksCopy

webhooksCopy(tableId: string, actionId: string): Promise<{ actionId: string }>
Copy a webhook.
Parameters
- tableId: string
- actionId: string
Returns Promise<{ actionId: string }>
See
https://help.quickbase.com/docs/api-webhooks-copy
- Defined in src/xml/index.ts:921

webhooksCreate

webhooksCreate(tableId: string, options: WebhooksCreateOptions): Promise<void>
Create a webhook.
Parameters
- tableId: string
- options: WebhooksCreateOptions
Returns Promise<void>
See
https://help.quickbase.com/docs/api-webhooks-create
- Defined in src/xml/index.ts:872

webhooksDeactivate

webhooksDeactivate(
tableId: string,
actionIds: string[],
): Promise<{ numChanged: number }>
Deactivate webhooks.
Parameters
- tableId: string
- actionIds: string[]
Returns Promise<{ numChanged: number }>
See
https://help.quickbase.com/docs/api-webhooks-deactivate
- Defined in src/xml/index.ts:912

webhooksDelete

webhooksDelete(
tableId: string,
actionIds: string[],
): Promise<{ numChanged: number }>
Delete webhooks.
Parameters
- tableId: string
- actionIds: string[]
Returns Promise<{ numChanged: number }>
See
https://help.quickbase.com/docs/api-webhooks-delete
- Defined in src/xml/index.ts:894

webhooksEdit

webhooksEdit(
    tableId: string,
    actionId: string,
    options: WebhooksEditOptions,
): Promise<void>
Edit a webhook.
Parameters
- tableId: string
- actionId: string
- options: WebhooksEditOptions
Returns Promise<void>
See
https://help.quickbase.com/docs/api-webhooks-edit
- Defined in src/xml/index.ts:881

Class XmlClient

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns XmlClient

Methods

addGroupToRole

Parameters

Returns Promise<void>

See

addReplaceDBPage

Parameters

Returns Promise<AddReplaceDBPageResult>

See

addSubgroup

Parameters

Returns Promise<void>

See

addUserToGroup

Parameters

Returns Promise<void>

See

addUserToRole

Parameters

Returns Promise<void>

See

changeGroupInfo

Parameters

Returns Promise<void>

See

changeManager

Parameters

Returns Promise<void>

See

changeRecordOwner

Parameters

Returns Promise<void>

See

changeUserRole

Parameters

Returns Promise<void>

See

copyGroup

Parameters

Returns Promise<CreateGroupResult>

See

copyMasterDetail

Parameters

Returns Promise<CopyMasterDetailResult>

See

createGroup

Parameters

Returns Promise<CreateGroupResult>

See

deleteGroup

Parameters

Returns Promise<void>

See

doQueryCount

Parameters

Returns Promise<DoQueryCountResult>

See

executeXml

Parameters

Returns Promise<string>

fieldAddChoices

Parameters

Returns Promise<FieldAddChoicesResultWithAlias>

See

fieldRemoveChoices

Parameters

Returns Promise<FieldRemoveChoicesResultWithAlias>

See

findDBByName

Parameters

Returns Promise<FindDBByNameResultWithAlias>

See