For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocsAPI ReferenceChangelog
DocsAPI ReferenceChangelog
  • REST
    • Authentication
    • Platform
          • GETRetrieves a list of databases for an account
          • POSTAdd a new database
          • GETRetrieves a paginated list of databases for an account, with optional fuzzy search query
          • GETRetrieves a single database
          • DELDeletes database
          • GETGets a list of extra import fields
          • PUTSubmits a list of extra import fields
          • GETReturns a list of mapped fields in the file map
          • POSTSets a database primary key
    • Event-Driven Sync (EDRTS)
    • Content
    • FeedAMP Order
    • FeedAMP Order V2
    • FeedAMP Order Source
LogoLogo
RESTPlatformDatabase

Retrieves a paginated list of databases for an account, with optional fuzzy search query

GET
https://meta.feedonomics.com/api.php/accounts/:account_id/databases
GET
/api.php/accounts/:account_id/databases
$curl https://meta.feedonomics.com/api.php/accounts/1/databases \
>     -H "x-api-key: x-api-key" \
>     -H "Authorization: Bearer <token>"
200Database_retrievesAPaginatedListOfDatabasesForAnAccountWithOptionalFuzzySearchQuery_example
1[
2  {
3    "dbs": [
4      {
5        "account_id": "73",
6        "id": "1",
7        "name": "db one",
8        "paused": "0",
9        "google_service_account_id": "0",
10        "run_import_stats": "0",
11        "privacy_level": "admin",
12        "permissions": "write",
13        "scheduled_exports": 0,
14        "scheduled_imports": 0,
15        "trigger_count": 0,
16        "number_exported_in_last_day": 0,
17        "search_index": "",
18        "db_group_id": 0,
19        "db_group_name": "Ungrouped"
20      },
21      {
22        "account_id": "73",
23        "id": "130",
24        "name": "DATACEST_localhost_1631824972",
25        "paused": "0",
26        "google_service_account_id": "0",
27        "run_import_stats": "0",
28        "privacy_level": "admin",
29        "permissions": "write",
30        "scheduled_exports": 0,
31        "scheduled_imports": 0,
32        "trigger_count": 0,
33        "number_exported_in_last_day": 0,
34        "search_index": ",feed.csv,,kijiji_export.csv",
35        "db_group_id": 0,
36        "db_group_name": "Ungrouped"
37      }
38    ],
39    "pagination": {
40      "results_per_page": 50,
41      "page": 1,
42      "total_pages": 1,
43      "total_results": 2,
44      "query": "",
45      "paused": ""
46    }
47  }
48]
Was this page helpful?
Previous

Add a new database

Next

Retrieves a single database

Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idintegerRequired
ID of the account that the database is added to

Headers

x-api-keystringRequired

Query parameters

pageintegerOptional
Page number, begins at 1, defaults to 1 if not present
results_per_pageintegerOptional
How many dbs to return per page, defaults to 50 if not present
querystringOptional
A search query that will filter the list of dbs returned, a weighted fuzzy search.
pausedintegerOptional

Filters dbs that are paused or unpaused, defaults to all dbs (”)

Response

successful operation
account_idstring
idstring
namestring
pausedstring
google_service_account_idstring
run_import_statsstring
privacy_levelstring
permissionsstring
scheduled_exportsinteger
scheduled_importsinteger
trigger_countinteger
number_exported_in_last_dayinteger
search_indexstring
db_group_idinteger
db_group_namestring
total_pagesinteger
total_resultsinteger
results_per_pageinteger
pageinteger
querystring