Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
Use API_GetNumRecords to get the total number of records in the table. Invoke this call on a table-level dbid.
Request parameters
| Parameter | Value | Required? |
|---|---|---|
|
ticket |
A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call. |
yes, one of:
|
|
usertoken |
The user token is an alternative means of authentication, used for API access. User tokens cannot be used to access the Quickbase UI. |
yes, one of:
|
|
apptoken |
A valid application token. |
yes, if application tokens are being used by the application |
|
udata |
A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response. |
no |
Response values
| Element Name | Value |
|---|---|
|
action |
The originating request, for example, API_AddField. |
|
errcode |
Identifies the error code, if any. (See the Error Codes appendix for a list of possible error codes.) 0 indicates that no error was encountered. |
|
errtext |
Text that explains the error code. "No error" indicates that no error was encountered. |
|
udata |
Optional. Contains any udata value supplied in the request. |
|
num_records |
The total number of records in the table. |
Sample XML Request
POST https://target_domain/db/target_dbid
HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_GetNumRecords
<qdbapi>
<udata>mydata</udata>
<ticket>auth_ticket</ticket>
<apptoken>app_token</apptoken>
</qdbapi>
URL Alternative
https://target_domain/db/target_dbid?a=API_GetNumRecords
&ticket=auth_ticket&apptoken=app_token
where target_domain is the domain against which you are invoking this call, for example, quickbase.com. Read about this notation.
Sample response
<?xml version="1.0" ?>
<qdbapi>
<action>API_GetNumRecords</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<num_records>17</num_records>
</qdbapi>