Skip to content

Commit 43c45ee

Browse files
committed
docs: record ID, user ID & WS ID
Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
1 parent 8349f53 commit 43c45ee

File tree

8 files changed

+22
-4
lines changed

8 files changed

+22
-4
lines changed

content/docs/developer-resources/rest-apis/index.mdx

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ Before making API calls, you'll need to identify and copy the relevant IDs requi
2727

2828
The Workspace ID identifies your entire workspace and is used for workspace-level API operations.
2929

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 (down chevron next to workspace name) in the left sidebar. Click on the ID to copy it to your clipboard.
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.
3131

32-
[//]: # (![Workspace ID]&#40;/img/v2/developer/workspace-id.png&#41;)
32+
![Workspace ID](/img/v2/developer/workspace-id-1.png)
3333

3434
Workspace ID can also be retrieved from Workspace settings.
3535

36-
[//]: # (![Workspace ID]&#40;/img/v2/developer/workspace-id-2.png&#41;)
36+
![Workspace ID](/img/v2/developer/workspace-id-2.png)
3737

3838
### Base ID
3939

@@ -74,12 +74,30 @@ Field ID can also be retrieved from `Details` > `Fields` editor
7474

7575
![Field ID](/img/v2/developer/field-id-2.png)
7676

77+
78+
### 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.
80+
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.
82+
83+
![Record ID](/img/v2/developer/record-id-1.png)
84+
85+
You can also find it in the URL when viewing a specific record (expanded record view).
86+
87+
![Record ID](/img/v2/developer/record-id-2.png)
88+
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.
90+
91+
![Record ID](/img/v2/developer/record-id-3.png)
92+
7793
### User ID
7894
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.
7995

8096
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.
8197

82-
[//]: # (![User ID]&#40;/img/v2/developer/user-id.png&#41;)
98+
![User ID](/img/v2/developer/user-id-1.png)
99+
100+
![User ID](/img/v2/developer/user-id-2.png)
83101

84102
### Data Source ID
85103
For External Data Sources connected to NocoDB (like Postgres / MySQL), the Data Source ID is additionally required to perform data API operations.
285 KB
Loading
58.4 KB
Loading
183 KB
Loading
159 KB
Loading
134 KB
Loading
275 KB
Loading
131 KB
Loading

0 commit comments

Comments
 (0)