Go to appAcademyWhat's new?
Back
Artisan IMG > Airtable (airtable) (8fbf07b0-8fe6-49c3-b56f-0b39b93a8f0f)
Airtable
OverviewNotes on using AirtableExample UsageOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Create records
Copy

Create multiple records of a table.

Sample Input

1
{
2
    "base_id": "appABC123XYZ",
3
    "table": "Customers",
4
    "records": [
5
        {
6
            "fields": {
7
                "Name": "John Doe",
8
                "Email": "john.doe@example.com",
9
                "Phone": "+1 555-1234",
10
                "Status": "Active"
11
            }
12
        },
13
        {
14
            "fields": {
15
                "Name": "Jane Smith",
16
                "Email": "jane.smith@example.com",
17
                "Phone": "+1 555-5678",
18
                "Status": "Pending"
19
            }
20
        }
21
    ]
22
}

Sample Output

1
{
2
    "records": [
3
        {
4
            "id": "recABC123",
5
            "fields": {
6
                "Name": "John Doe",
7
                "Email": "john.doe@example.com",
8
                "Phone": "+1 555-1234",
9
                "Status": "Active"
10
            },
11
            "createdTime": "2023-05-15T14:30:00.000Z"
12
        },
13
        {
14
            "id": "recDEF456",
15
            "fields": {
16
                "Name": "Jane Smith",
17
                "Email": "jane.smith@example.com",
18
                "Phone": "+1 555-5678",
19
                "Status": "Pending"
20
            },
21
            "createdTime": "2023-05-15T14:30:01.000Z"
22
        }
23
    ]
24
}

Delete record
Copy

Delete a record from a table.

Sample Input

1
{
2
    "base_id": "appABC123XYZ",
3
    "table": "Projects",
4
    "record_id": "recDEF456GHI"
5
}

Sample Output

1
{
2
    "deleted": true,
3
    "id": "recDEF456GHI"
4
}

Get record
Copy

Retrieve a record for a base.

Sample Input

1
{
2
    "base_id": "appABC123XYZ789",
3
    "table": "Customers",
4
    "record_id": "recDEF456GHI789"
5
}

Sample Output

1
{
2
    "id": "recDEF456GHI789",
3
    "fields": {
4
        "Name": "John Doe",
5
        "Email": "john.doe@example.com",
6
        "Phone": "(555) 123-4567",
7
        "Company": "Acme Corp",
8
        "Status": "Active"
9
    },
10
    "createdTime": "2023-04-15T09:30:00.000Z"
11
}

List records
Copy

List records for a base.

Sample Input

1
{
2
    "base_id": "appXXXXXXXXXXXXXX",
3
    "table": "Customers",
4
    "filter_by_formula": "AND({Status} = 'Active', {Age} > 30)",
5
    "max_records": 1000,
6
    "view": "All Customers",
7
    "sort": [
8
        {
9
            "field": "Last Name",
10
            "direction": "asc"
11
        },
12
        {
13
            "field": "First Name",
14
            "direction": "asc"
15
        }
16
    ],
17
    "page_size": 100
18
}

Sample Output

1
{
2
    "records": [
3
        {
4
            "id": "recXXXXXXXXXXXXXX",
5
            "fields": {
6
                "First Name": "John",
7
                "Last Name": "Doe",
8
                "Email": "john.doe@example.com",
9
                "Age": 35,
10
                "Status": "Active"
11
            },
12
            "createdTime": "2023-05-15T10:30:00.000Z"
13
        },
14
        {
15
            "id": "recYYYYYYYYYYYYYY",
16
            "fields": {
17
                "First Name": "Jane",
18
                "Last Name": "Smith",
19
                "Email": "jane.smith@example.com",
20
                "Age": 42,
21
                "Status": "Active"
22
            },
23
            "createdTime": "2023-05-16T14:45:00.000Z"
24
        }
25
    ]
26
}

Raw HTTP request (advanced)
Copy

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

Sample Input

1
{
2
    "method": "POST",
3
    "url": {
4
        "full_url": "https://api.airtable.com/v0/appXXXXXXXXXXXXXX/Table%20Name"
5
    },
6
    "headers": [
7
        {
8
            "key": "Authorization",
9
            "value": "Bearer YOUR_API_KEY"
10
        },
11
        {
12
            "key": "Content-Type",
13
            "value": "application/json"
14
        }
15
    ],
16
    "query_parameters": [
17
        {
18
            "key": "maxRecords",
19
            "value": "3"
20
        },
21
        {
22
            "key": "view",
23
            "value": "Grid view"
24
        }
25
    ],
26
    "body": {
27
        "raw": {
28
            "fields": {
29
                "Name": "John Doe",
30
                "Email": "john.doe@example.com",
31
                "Status": "Active"
32
            }
33
        }
34
    },
35
    "include_raw_body": true,
36
    "parse_response": "true"
37
}

Sample Output

1
{
2
    "response": {
3
        "status_code": 200,
4
        "headers": {
5
            "Content-Type": "application/json",
6
            "X-Request-Id": "req_XXXXXXXXXXXXXXXX"
7
        },
8
        "body": {
9
            "id": "recXXXXXXXXXXXXXX",
10
            "fields": {
11
                "Name": "John Doe",
12
                "Email": "john.doe@example.com",
13
                "Status": "Active"
14
            },
15
            "createdTime": "2023-05-10T15:30:00.000Z"
16
        }
17
    }
18
}

Update record
Copy

Update a record for a base.

Sample Input

1
{
2
    "base_id": "appABC123XYZ789",
3
    "table": "Projects",
4
    "record_id": "recDEF456GHI789",
5
    "fields": {
6
        "Project Name": "Website Redesign",
7
        "Status": "In Progress",
8
        "Due Date": "2023-08-15",
9
        "Assigned To": "John Doe",
10
        "Budget": 15000
11
    }
12
}

Sample Output

1
{
2
    "id": "recDEF456GHI789",
3
    "fields": {
4
        "Project Name": "Website Redesign",
5
        "Status": "In Progress",
6
        "Due Date": "2023-08-15",
7
        "Assigned To": "John Doe",
8
        "Budget": 15000
9
    },
10
    "createdTime": "2023-03-10T14:30:00.000Z"
11
}
Previous

Example Usage

Next

Operations