List records
https://api.airtable.com/v0/apprRQruFO3GNsDQi/Events
To list records in Events, issue a GET request to the Events endpoint.
Returned records do not include any fields with "empty" values, e.g. ""
, []
, or false
.
You can use the following parameters to filter, sort, and format the results:
fields
array of strings
optional
Only data for fields whose names are in this list will be included in the result. If you don't need every field, you can use this parameter to reduce the amount of data transferred.
For example, to only return data from # and Name of the event, send these two query parameters:
fields%5B%5D=%23
fields%5B%5D=Name%20of%20the%20event
filterByFormula
string
optional
A formula used to filter records. The formula will be evaluated for each record, and if the result is not 0
, false
, ""
, NaN
, []
, or #Error!
the record will be included in the response.
If combined with view, only records in that view which satisfy the formula will be returned.
For example, to only include records where # isn't empty, pass in: NOT({#} = '')
maxRecords
number
optional
The maximum total number of records that will be returned in your requests. If this value is larger than pageSize
(which is 100 by default), you may have to load multiple pages to reach this total. See the Pagination section below for more.
pageSize
number
optional
The number of records returned in each request. Must be less than or equal to 100. Default is 100. See the Pagination section below for more.
sort
array of objects
optional
A list of sort objects that specifies how the records will be ordered. Each sort object must have a field
key specifying the name of the field to sort on, and an optional direction
key that is either "asc"
or "desc"
. The default direction is "asc"
.
The sort
parameter overrides the sorting of the view specified in the view
parameter. If neither the sort
nor the view
parameter is included, the order of records is arbitrary.
For example, to sort records by # in descending order, send these two query parameters:
sort%5B0%5D%5Bfield%5D=%23
sort%5B0%5D%5Bdirection%5D=desc
For example, to sort records by # in descending order, pass in:
[{field: "#", direction: "desc"}]
view
string
optional
The name or ID of a view in the Events table. If set, only the records in that view will be returned. The records will be sorted according to the order of the view unless the sort
parameter is included, which overrides that order. Fields hidden in this view will be returned in the results. To only return a subset of fields, use the fields
parameter.
cellFormat
string
optional
The format that should be used for cell values. Supported values are:
"json"
: cells will be formatted as JSON, depending on the field type.
"string"
: cells will be formatted as user-facing strings, regardless of the field type. Note: You should not rely on the format of these strings, as it is subject to change.
The default is "json"
.
timeZone
string
optional
The time zone that should be used to format dates when using "string"
as the cellFormat
. This parameter is required when using "string"
as the cellFormat
.
userLocale
string
optional
The user locale that should be used to format dates when using "string"
as the cellFormat
. This parameter is required when using "string"
as the `cellFormat.
Note: These parameters need to be URL encoded. If you are using airtable.js, they will be automatically encoded.
Pagination
The server returns one page of records at a time. Each page will contain pageSize
records, which is 100 by default.
If there are more records, the response will contain an offset
. To fetch the next page of records, include offset
in the next request's parameters.
Pagination will stop when you've reached the end of your table. If the maxRecords
parameter is passed, pagination will stop once you've reached this maximum.
To retrieve an existing record in Events table, issue a GET request to the record endpoint.
Any "empty" fields (e.g. "", [], or false) in the record will not be returned.
In attachment objects included in the retrieved record (Picture), only id, url, and filename are always returned. Other attachment properties may not be included.