Crate airtable_api

Source
Expand description

A rust library for interacting with the Airtable API.

For more information, the Airtable API is documented at airtable.com/api.

Example:

use airtable_api::{Airtable, Record};
use serde::{Deserialize, Serialize};

async fn get_records() {
    // Initialize the Airtable client.
    let airtable = Airtable::new_from_env();

    // Get the current records from a table.
    let mut records: Vec<Record<SomeFormat>> = airtable
        .list_records(
            "Table Name",
            "Grid view",
            vec!["the", "fields", "you", "want", "to", "return"],
        )
        .await
        .unwrap();

    // Iterate over the records.
    for (i, record) in records.clone().iter().enumerate() {
        println!("{} - {:?}", i, record);
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SomeFormat {
    pub x: bool,
}

Modules§

attachment_format_as_array_of_strings
attachment_format_as_string
barcode_format_as_string
deserialize_missing_timezone
deserialize_null_string
user_format_as_array_of_strings
user_format_as_string

Structs§

Airtable
Entrypoint for interacting with the Airtable API.
Attachment
AttachmentShort
Barcode
An airtable barcode.
BaseCollaborator
BaseInviteLink
Collaboration
Collaborations
Collaborator
DeleteUserResponse
The response returned from deleting a user. FROM: https://airtable.com/api/enterprise#enterpriseAccountUserDeleteUserByEmail
EnterpriseUser
EnterpriseUsersResponse
ErrorResponse
Full
InviteLinks
NewCollaborator
Record
An Airtable record.
Thumbnails
User
An airtable user.
UsersResponse
The response returned from listing users.
Workspace
WorkspaceCollaborator
WorkspaceCollaborators
WorkspaceInviteLink

Enums§

WorkspaceIncludes
Optional include flags that can be passed to [get_enterprise_workspace] to control fields are returned

Functions§

api_key_from_env
Get the API key from the AIRTABLE_API_KEY env variable.