Operations (sample payloads)

Main operations

Create records

Create multiple records of a table. Sample Input

{
    "base_id": "appABC123XYZ",
    "table": "Customers",
    "records": [
        {
            "fields": \{
                "Name": "John Doe",
                "Email": "john.doe@example.com",
                "Phone": "+1 555-1234",
                "Status": "Active"
            \}
        },
        {
            "fields": \{
                "Name": "Jane Smith",
                "Email": "jane.smith@example.com",
                "Phone": "+1 555-5678",
                "Status": "Pending"
            \}
        }
    ]
}

Sample Output

{
    "records": [
        {
            "id": "recABC123",
            "fields": \{
                "Name": "John Doe",
                "Email": "john.doe@example.com",
                "Phone": "+1 555-1234",
                "Status": "Active"
            \},
            "createdTime": "2023-05-15T14:30:00.000Z"
        },
        {
            "id": "recDEF456",
            "fields": \{
                "Name": "Jane Smith",
                "Email": "jane.smith@example.com",
                "Phone": "+1 555-5678",
                "Status": "Pending"
            \},
            "createdTime": "2023-05-15T14:30:01.000Z"
        }
    ]
}

Delete record

Delete a record from a table. Sample Input

\{
    "base_id": "appABC123XYZ",
    "table": "Projects",
    "record_id": "recDEF456GHI"
\}

Sample Output

\{
    "deleted": true,
    "id": "recDEF456GHI"
\}

Get record

Retrieve a record for a base. Sample Input

\{
    "base_id": "appABC123XYZ789",
    "table": "Customers",
    "record_id": "recDEF456GHI789"
\}

Sample Output

{
    "id": "recDEF456GHI789",
    "fields": \{
        "Name": "John Doe",
        "Email": "john.doe@example.com",
        "Phone": "(555) 123-4567",
        "Company": "Acme Corp",
        "Status": "Active"
    \},
    "createdTime": "2023-04-15T09:30:00.000Z"
}

List records

List records for a base. Sample Input

{
    "base_id": "appXXXXXXXXXXXXXX",
    "table": "Customers",
    "filter_by_formula": "AND({Status} = 'Active', {Age} > 30)",
    "max_records": 1000,
    "view": "All Customers",
    "sort": [
        \{
            "field": "Last Name",
            "direction": "asc"
        \},
        \{
            "field": "First Name",
            "direction": "asc"
        \}
    ],
    "page_size": 100
}

Sample Output

{
    "records": [
        {
            "id": "recXXXXXXXXXXXXXX",
            "fields": \{
                "First Name": "John",
                "Last Name": "Doe",
                "Email": "john.doe@example.com",
                "Age": 35,
                "Status": "Active"
            \},
            "createdTime": "2023-05-15T10:30:00.000Z"
        },
        {
            "id": "recYYYYYYYYYYYYYY",
            "fields": \{
                "First Name": "Jane",
                "Last Name": "Smith",
                "Email": "jane.smith@example.com",
                "Age": 42,
                "Status": "Active"
            \},
            "createdTime": "2023-05-16T14:45:00.000Z"
        }
    ]
}

Raw HTTP request (advanced)

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication. Sample Input

{
    "method": "POST",
    "url": {
        "full_url": "https://api.airtable.com/v0/appXXXXXXXXXXXXXX/Table%20Name"
    },
    "headers": [
        \{
            "key": "Authorization",
            "value": "Bearer YOUR_API_KEY"
        \},
        \{
            "key": "Content-Type",
            "value": "application/json"
        \}
    ],
    "query_parameters": [
        \{
            "key": "maxRecords",
            "value": "3"
        \},
        \{
            "key": "view",
            "value": "Grid view"
        \}
    ],
    "body": {
        "raw": {
            "fields": \{
                "Name": "John Doe",
                "Email": "john.doe@example.com",
                "Status": "Active"
            \}
        }
    },
    "include_raw_body": true,
    "parse_response": "true"
}

Sample Output

{
    "response": {
        "status_code": 200,
        "headers": \{
            "Content-Type": "application/json",
            "X-Request-Id": "req_XXXXXXXXXXXXXXXX"
        \},
        "body": {
            "id": "recXXXXXXXXXXXXXX",
            "fields": \{
                "Name": "John Doe",
                "Email": "john.doe@example.com",
                "Status": "Active"
            \},
            "createdTime": "2023-05-10T15:30:00.000Z"
        }
    }
}

Update record

Update a record for a base. Sample Input

{
    "base_id": "appABC123XYZ789",
    "table": "Projects",
    "record_id": "recDEF456GHI789",
    "fields": \{
        "Project Name": "Website Redesign",
        "Status": "In Progress",
        "Due Date": "2023-08-15",
        "Assigned To": "John Doe",
        "Budget": 15000
    \}
}

Sample Output

{
    "id": "recDEF456GHI789",
    "fields": \{
        "Project Name": "Website Redesign",
        "Status": "In Progress",
        "Due Date": "2023-08-15",
        "Assigned To": "John Doe",
        "Budget": 15000
    \},
    "createdTime": "2023-03-10T14:30:00.000Z"
}