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
+19-20Lines changed: 19 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,48 +25,47 @@ Before making API calls, you'll need to identify and copy the relevant IDs requi
25
25
26
26
### Workspace ID
27
27
28
-
The Workspace ID identifies your entire workspace and is used for workspace-level API operations.
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
29
30
-
Workspace ID is the alphanumeric string with prefix `w` (stands for workspace) that appears in the URL when viewing any base within your workspace. It can also be found in the Workspace context menu (click on workspace icon in minibar). Click on the ID to copy it to your clipboard.
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.
The Base ID is required for meta APIs and administrative operations. It identifies a specific database / base within your workspace.
40
+
**Base ID** is required for metadata APIs and administrative operations. It uniquely identifies a specific database (or base) within your workspace.
41
41
42
-
Base ID is the alphanumeric string with prefix `p` (stands for project) that appears in the URL when viewing any table or base-level settings. It can also be found in the Base context menu (chevron next to base name) in the left sidebar. Click on the ID to copy it to your clipboard.
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
43
44
44
45
45
46
46
### Table ID
47
47
48
-
The Table ID is the most frequently used identifier and is required for all data API calls. It uniquely identifies a specific table within your base.
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
49
50
-
Table ID is the alphanumeric string with prefix `m` (stands for model) that appears after base ID in the URL when viewing a table. It can also be found in Table context menu (three dots next to table name) in the left sidebar. Click on the ID to copy it to your clipboard.
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
51
52
52
53
53
54
54
### View ID
55
-
The View ID is used for view-specific API operations, such as retrieving records from a particular view. It uniquely identifies a specific view within a table.
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
56
57
-
View ID is the alphanumeric string with prefix `v` (stands for view) that appears in the URL when viewing a specific view. It can also be found in the View context menu (three dots next to view name) in the left sidebar. Click on the ID to copy it to your clipboard.
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
58
59
59
60
60
61
-
View ID can also be retrieved from view toolbar > more actions (...) menu
61
+
View ID can also be retrieved from view toolbar > more actions (3 dots) menu
62
62
63
63
64
64
65
-
66
65
### Field ID
67
-
The Field ID is used for field-specific API operations, such as updating field properties. It uniquely identifies a specific column within a table.
66
+
**Field ID** is used for field-specific API operations, such as updating field properties. It uniquely identifies a specific column within a table.
68
67
69
-
Field ID is the alphanumeric string with prefix `c` (stands for column) that appears in the URL when viewing or editing a specific field's settings. It can also be found in the field context menu (chevron next to field name) in field header bar. Click on the ID to copy it to your clipboard.
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.
70
69
71
70
72
71
@@ -76,33 +75,33 @@ Field ID can also be retrieved from `Details` > `Fields` editor
76
75
77
76
78
77
### Record ID
79
-
The Record ID is used for record-specific API operations, such as retrieving or updating a particular record. It uniquely identifies a specific row within a table.
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.
80
79
81
-
Record ID (by default) is a numeric value starting from 1. You can enable "ID" field (corresponds to Record ID) from "Fields" menu in the toolbar by clicking on Show System fields.
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**.
82
81
83
82
84
83
85
84
You can also find it in the URL when viewing a specific record (expanded record view).
86
85
87
86
88
87
89
-
You can also retrieve Record ID when constructing formulas using the formula editor by selecting "ID" from the list of available fields OR by using the `RECORD_ID()` function.
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.
90
89
91
90
92
91
93
92
### User ID
94
-
The User ID is used for user-specific API operations, such as retrieving user details. It uniquely identifies a specific user within your workspace / organization.
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.
95
94
96
-
User ID is the alphanumeric string with prefix `u` (stands for user). You can retrieve it from either workspace members page or base members page by clicking on the three dots menu associated with user's name. Click on the ID to copy it to your clipboard.
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.
97
96
98
97
99
98
100
99
101
100
102
101
### Data Source ID
103
-
For External Data Sources connected to NocoDB (like Postgres / MySQL), the Data Source ID is additionally required to perform data API operations.
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.
104
103
105
-
Data Source ID is the alphanumeric string. You can retrieve it from the context menu by clicking on the three dots next to data source name in the left sidebar. Click on the ID to copy it to your clipboard.
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.
0 commit comments