Skip to main content

Get Multiple Entries API

Overview​

This API endpoint retrieves multiple entries in a source

Endpoint​

POST https://api.myboardtoday.com/app/:app_id/source/:source_id/entries

Path Parameters​

  • app_id (required): The unique identifier (uuid) of the app.
  • source_id (required): The unique identifier (uuid) of the source.
  • entry_id (required): The unique identifier (uuid) of the entry.

Query Parameters​

  • order_params (optional, Object, default empty): An object of key value pairs of field_name and order. order can only be either "asc" or "desc".

  • filter_params (optional, Array[Array[JSON]], default empty): An array of array of criteria to filter the data. The outter array denotes "OR" condition and the each element array denotes "AND" condition. For example, a filter_params value of

    [
        { "field": "name", "op": "=", "val": "James" },
        { "field": "age", "op": ">", "val": 30 }
    ],
    [{ "field": "name", "op": "=", "val": "Bond" }]
    ]

    means name="James" and age>30 or name="Bond"

    • Supported Filters:
      • "="
      • ">"
      • "<"
      • ">="
      • "<="
      • "not"
      • "in"
      • "not_in"
      • "contains"
      • "not_contains"
      • "starts_with"
      • "between"
      • "exists"
      • "arrayContainsField"

  • page_size (optional, integer, default 10): page size

  • page_token (optional, string, default empty): pagination token. This is typically returned as next_token or page_token from previous calls.

  • limit (optional, integer, default empty): only fetch limit amount of entries

  • fields (optional, Array[string], default empty): only fetch specific fields from each entry returned

  • use_named (optional, boolean, default false): if true, use named fields

  • mode (optional, string, default "entries_only"): it can be one of the supported modes: entries_only, schema_entries, key_fields, sample, object_schema_fields, schema_only.

  • ref (optional, Object, default empty): the fetch configuration for reference fields (single reference, multiple reference and multiple reference with count). It should be an object with [key]=entry field name and [value]=query parameter object.

Headers​

  • x-api-key (required): The API key for authentication.

Report Bugs, Request New Features, and Win $50 Every Month

We value your precious feedback. Please contact us when you find a bug or would like to request a new feature. (In the main panel, click on the bob logo on the top left corner, then in the Dropdown menu click on “contact for bugs or new features”). Every month we will select an “opinion leader” and reward him/her with $50 in cash.