Filter Master Data

GET

https://api.staple.io/v2/master-data/:sheetId

GET

/v2/master-data/:sheetId

curl https://api.staple.io/v2/master-data/sheetId \
     -H "x-api-key: <apiKey>"

200Filter Master Data

{
  "filterMasterDataSheet": {
    "data": [
      {
        "row_data": {
          "Account Name": "",
          "Address": "",
          "Bank": "",
          "Bank Account": "0125002320000503",
          "Credit Terms": "",
          "Email": "",
          "ISO Country Code": "GR",
          "Label1": "",
          "Label2": "",
          "Label3": "",
          "Label4": "",
          "Label5": "",
          "Telephone Number": "30 210 4278700",
          "Vendor Code": "0000203368",
          "Vendor Default Currency": "EUR",
          "Vendor GST Number": "",
          "Vendor Name": "VANOS SA",
          "Vendor Name Language": ""
        },
        "row_id": "4d48a9e9-2a25-4d8a-b3e3-a26c27df871b",
        "row_index": 3
      },
      {
        "row_data": {
          "Account Name": "",
          "Address": "Hotel Highway Garden, 1st Floor,Doo",
          "Bank": "",
          "Bank Account": "922020046360400",
          "Credit Terms": "",
          "Email": "",
          "ISO Country Code": "IN",
          "Label1": "",
          "Label2": "",
          "Label3": "",
          "Label4": "",
          "Label5": "",
          "Telephone Number": "91 484 4255 999",
          "Vendor Code": "0000100018",
          "Vendor Default Currency": "USD",
          "Vendor GST Number": "",
          "Vendor Name": "NS SHIP MANAGEMENT INDIA PRIVATE LI",
          "Vendor Name Language": ""
        },
        "row_id": "632a8a39-482f-4015-b07e-55f6c42df054",
        "row_index": 100
      }
    ]
  }
}

Purpose: Retrieve and filter master data records within a specific master data set using dynamic field-based queries

Description: This endpoint allows you to search and filter records within a master data collection (identified by master_data_id) for a given organization. You can query records by passing field names as query parameters with their corresponding values to match against.

Notes:

The endpoint accepts any field from the master data schema as a query parameter

Multiple query parameters can be combined to create complex filter conditions (treated as AND operations)

Returns all records that match ALL provided field-value pairs

Field names must exactly match the schema definition (case-sensitive)

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Path parameters

sheetIdstringRequired

Authentication

Path parameters

Response