Skip to main content
Solved

Request Error With returnFieldsByFieldId in POST Request For List Records Endpoint

  • July 3, 2025
  • 5 replies
  • 165 views
C

Hi,

 

I’m new on using this product and we are trying to integrate this into our system. I managed to setup the api and make some requests however, during my testing in the list records api with `POST` method. I was trying to use this parameter `returnFieldsByFieldId` in the request body but got an error stating this..

```

{

 "error": {

      "type": "INVALID_REQUEST_UNKNOWN",

      "message": "Invalid request: parameter validation failed. Check your request data."

  }

}

```

Mentioned parameter works with `GET` request. Tried a bunch of boolean equivalent for this parameter like

-  1
-  true
-  True
-  TRUE

Hoping someone can help. TIA.

Best answer by djseeds

Hi ​@crmonlineau_mike,

I am able to use the returnFieldsByFieldId parameter in a POST request. Please see the below command for an example request using this parameter.

curl -X POST \
  "https://api.airtable.com/v0/YOUR_BASE_ID/YOUR_TABLE_NAME/listRecords" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "returnFieldsByFieldId": true,
    "maxRecords": 3
  }'

 

    5 replies

    djseeds
    Forum|alt.badge.img+7
    • djseeds
    • Inspiring
    • Answer
    • July 3, 2025

    Hi ​@crmonlineau_mike,

    I am able to use the returnFieldsByFieldId parameter in a POST request. Please see the below command for an example request using this parameter.

    curl -X POST \
      "https://api.airtable.com/v0/YOUR_BASE_ID/YOUR_TABLE_NAME/listRecords" \
      -H "Authorization: Bearer YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "returnFieldsByFieldId": true,
        "maxRecords": 3
      }'

     

    DJ, Lead Developer at BaseQL
    TheTimeSavingCo
    Forum|alt.badge.img+31

    The List records endpoint only takes GET, and so it erroring out when you do a POST makes sense, right?  Sorry, think I’m not understanding something.  https://airtable.com/developers/web/api/list-records

    What’re you trying to do with your request?

    Adam, Airtable Consultant - thetimesaving.company
    C

    Hi,

    I was trying out this particular note
     

    Note Airtable's API only accepts request with a URL shorter than 16,000 characters. Encoded formulas may cause your requests to exceed this limit. To fix this issue you can instead make a POST request to /v0/{baseId}/{tableIdOrName}/listRecords while passing the parameters within the body of the request instead of the query parameters.

     

    I was trying out to list down the records for a particular table using the POST method as suggested in the note just to avoid the URL limitations. Here is a sample request that i’m doing.
     

    curl -X POST \

      --location 'https://api.airtable.com/v0/[baseId]/[tableId]/listRecords' \

      --header 'Authorization: Bearer [truncated]' \

      --header 'Content-Type: application/x-www-form-urlencoded' \

      --data-urlencode 'fields%5B%5D=fldaqbAq8L8EeN92J' \

      --data-urlencode 'sort%5B0%5D%5Bfield%5D=fldaqbAq8L8EeN92J'

      --data-urlencode 'returnFielddsByFieldId=1' \

      --data-urlencode 'fields%5B%5D=fldaqbAq8L8EeN92J' \

      --data-urlencode 'sort%5B0%5D%5Bfield%5D=fldaqbAq8L8EeN92J'



    Thanks

    C

    Hi,

    I think, i already understand now. kudos ​@djseeds. I was using a wrong content type for my payload. I tried using json as suggested and it works.

    Thank you so much 🙏

    R
    Forum|alt.badge.img+1
    • rose42snowden
    • New Participant
    • August 13, 2025

    Hello,
    The returnFieldsByFieldId parameter is exclusively supported for GET requests when listing records. It is not designed to be used with POST requests, which explains the "Invalid request: parameter validation failed" error you're encountering. For POST requests, you'll need to structure your request body according to the API's specifications for that method, which typically involve sending data to be created or updated, not for controlling the format of the returned fields  mymilestonecard 

    Terms & ConditionsAccessibility statement