Skip to content

Commit 8349f53

Browse files
committed
docs: various IDs
Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
1 parent d9fa602 commit 8349f53

File tree

10 files changed

+85
-5
lines changed

10 files changed

+85
-5
lines changed

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

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,76 @@ Additional information on the REST APIs is provided below.
1919
- 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.
2020

2121

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+
The Workspace ID identifies your entire workspace and is used for workspace-level API operations.
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 (down chevron next to workspace name) in the left sidebar. Click on the ID to copy it to your clipboard.
31+
32+
[//]: # (![Workspace ID]&#40;/img/v2/developer/workspace-id.png&#41;)
33+
34+
Workspace ID can also be retrieved from Workspace settings.
35+
36+
[//]: # (![Workspace ID]&#40;/img/v2/developer/workspace-id-2.png&#41;)
37+
38+
### Base ID
39+
40+
The Base ID is required for meta APIs and administrative operations. It identifies a specific database / base within your workspace.
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.
43+
44+
![Base ID](/img/v2/developer/base-id.png)
45+
46+
### Table ID
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.
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.
51+
52+
![Table ID](/img/v2/developer/table-id.png)
53+
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.
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.
58+
59+
![View ID](/img/v2/developer/view-id-1.png)
60+
61+
View ID can also be retrieved from view toolbar > more actions (...) menu
62+
63+
![View ID](/img/v2/developer/view-id-2.png)
64+
65+
66+
### 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.
68+
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.
70+
71+
![Field ID](/img/v2/developer/field-id-1.png)
72+
73+
Field ID can also be retrieved from `Details` > `Fields` editor
74+
75+
![Field ID](/img/v2/developer/field-id-2.png)
76+
77+
### User ID
78+
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.
79+
80+
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.
81+
82+
[//]: # (![User ID]&#40;/img/v2/developer/user-id.png&#41;)
83+
84+
### Data Source ID
85+
For External Data Sources connected to NocoDB (like Postgres / MySQL), the Data Source ID is additionally required to perform data API operations.
86+
87+
Data Source ID is the alphanumeric string with prefix `ds` (stands for data source). 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.
88+
89+
[//]: # (![Data Source ID]&#40;/img/v2/developer/data-source-id.png&#41;)
90+
91+
2292
## Rate Limits
2393
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.
2494

300 KB
Loading
222 KB
Loading
218 KB
Loading
259 KB
Loading
273 KB
Loading
429 KB
Loading
402 KB
Loading
262 KB
Loading

tsconfig.json

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22
"compilerOptions": {
33
"baseUrl": ".",
44
"target": "ESNext",
5-
"lib": ["dom", "dom.iterable", "esnext"],
5+
"lib": [
6+
"dom",
7+
"dom.iterable",
8+
"esnext"
9+
],
610
"allowJs": true,
711
"skipLibCheck": true,
812
"strict": true,
@@ -13,11 +17,15 @@
1317
"moduleResolution": "bundler",
1418
"resolveJsonModule": true,
1519
"isolatedModules": true,
16-
"jsx": "react-jsx",
20+
"jsx": "preserve",
1721
"incremental": true,
1822
"paths": {
19-
"@/.source": ["./.source/index.ts"],
20-
"@/*": ["./*"]
23+
"@/.source": [
24+
"./.source/index.ts"
25+
],
26+
"@/*": [
27+
"./*"
28+
]
2129
},
2230
"plugins": [
2331
{
@@ -33,5 +41,7 @@
3341
".next/types/**/*.ts",
3442
".next/dev/types/**/*.ts"
3543
],
36-
"exclude": ["node_modules"]
44+
"exclude": [
45+
"node_modules"
46+
]
3747
}

0 commit comments

Comments
 (0)