You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/docs/developer-resources/rest-apis/index.mdx
+91Lines changed: 91 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,97 @@ Additional information on the REST APIs is provided below.
19
19
- When querying using v3 apis, see [v3 Where Clause](/docs/product-docs/developer-resources/rest-apis#v3-where-query-parameter) for a slight difference between the two version's where clause.
20
20
21
21
22
+
## Finding Your API IDs
23
+
24
+
Before making API calls, you'll need to identify and copy the relevant IDs required for constructing your endpoints. This section walks you through locating each essential identifier.
25
+
26
+
### Workspace ID
27
+
28
+
**Workspace ID** is an alphanumeric identifier prefixed with `w` (representing *workspace*) that uniquely identifies your workspace in NocoDB. It appears in the URL bar when viewing any base within the workspace.
29
+
30
+
You can also find it in the workspace context menu (accessible by clicking the workspace icon in the minibar). Click the ID to copy it to your clipboard.
**Base ID** is required for metadata APIs and administrative operations. It uniquely identifies a specific database (or base) within your workspace.
41
+
42
+
The Base ID is an alphanumeric identifier prefixed with `p` (representing *project*), visible in the URL when accessing any table or base-level settings. You can also find it in the base context menu (chevron next to the base name) in the left sidebar, where you can click the ID to copy it to your clipboard.
43
+
44
+
45
+
46
+
### Table ID
47
+
48
+
**Table ID** is the most commonly used identifier and is required for all data API calls. It uniquely identifies a specific table within your base.
49
+
50
+
The Table ID is an alphanumeric string prefixed with `m` (representing *model*), visible in the URL immediately after the Base ID when viewing a table. You can also find it in the table context menu (three dots next to the table name) in the left sidebar. Click the ID to copy it to your clipboard.
51
+
52
+
53
+
54
+
### View ID
55
+
**View ID** is used for view-specific API operations, such as fetching records from a particular view. It uniquely identifies a specific view within a table.
56
+
57
+
The View ID is an alphanumeric string prefixed with `v` (representing *view*), visible in the URL when a specific view is open. You can also find it in the view context menu (three dots next to the view name) in the left sidebar. Click the ID to copy it to your clipboard.
58
+
59
+
60
+
61
+
View ID can also be retrieved from view toolbar > more actions (3 dots) menu
62
+
63
+
64
+
65
+
### Field ID
66
+
**Field ID** is used for field-specific API operations, such as updating field properties. It uniquely identifies a specific column within a table.
67
+
68
+
The Field ID is an alphanumeric string prefixed with `c` (representing *column*), visible in the URL when viewing or editing a field’s settings. You can also find it in the field context menu (chevron next to the field name) in the field header bar. Click the ID to copy it to your clipboard.
69
+
70
+
71
+
72
+
Field ID can also be retrieved from `Details` > `Fields` editor
73
+
74
+
75
+
76
+
77
+
### Record ID
78
+
**Record ID** is used for record-specific API operations, such as retrieving or updating an individual record. It uniquely identifies a specific row within a table.
79
+
80
+
By default, the Record ID is a numeric value starting from 1. You can display the **ID** field (which corresponds to the Record ID) by opening the **Fields** menu in the toolbar and enabling **Show System Fields**.
81
+
82
+
83
+
84
+
You can also find it in the URL when viewing a specific record (expanded record view).
85
+
86
+
87
+
88
+
You can also access the Record ID in formulas by selecting **ID** from the list of available fields in the formula editor or by using the `RECORD_ID()` function.
89
+
90
+
91
+
92
+
### User ID
93
+
**User ID** is used for user-specific API operations, such as retrieving user details. It uniquely identifies a specific user within your workspace or organization.
94
+
95
+
The User ID is an alphanumeric string prefixed with `u` (representing *user*). You can find it on either the **Workspace Members** page or the **Base Members** page by clicking the three dots menu next to a user’s name. Click the ID to copy it to your clipboard.
96
+
97
+
98
+
99
+
100
+
101
+
### Data Source ID
102
+
For external data sources connected to NocoDB (such as Postgres or MySQL), the **Data Source ID** is additionally required to perform data API operations.
103
+
104
+
The Data Source ID is an alphanumeric string that uniquely identifies the connected data source. You can find it in the context menu by clicking the three dots next to the data source name in the left sidebar. Click the ID to copy it to your clipboard.
NocoDB APIs are rate-limited to ensure fair usage and optimal performance for all users. The default rate limit is set to **5 requests per second per user**. These limits are the same across all plans.
0 commit comments