| Purpose | Endpoint |
|---|---|
| Folders in a profile | GET /v1/profiles/{profileId}/folders |
| A single folder, with its items | GET /v1/folders/{folderId} |
List folders
GET /v1/profiles/{profileId}/folders
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
search | string | Partial match on the folder name | |
sort | string | createdAt | name · createdAt · updatedAt |
order | string | desc | asc · desc |
cursor | string | The nextCursor from the previous response | |
limit | number | 10 | Items per page (max 100) |
curl "https://client-omni-api.argosidentity.com/v1/profiles/pf_6h4y8s2f0v9n/folders?sort=createdAt&order=asc" \
-H "x-api-key: your-api-key-here"
Response
{
"count": 2,
"nextCursor": null,
"items": [
{
"id": "fd_9pq2mklt83bx",
"profileId": "pf_6h4y8s2f0v9n",
"name": "default",
"isDefault": true,
"itemsCount": 3,
"createdAt": "2026-09-10T05:32:47.118Z",
"updatedAt": "2026-09-10T05:35:41.330Z"
},
{
"id": "fd_5t9j1r4b7m2q",
"profileId": "pf_6h4y8s2f0v9n",
"name": "Supporting documents",
"isDefault": false,
"itemsCount": 0,
"createdAt": "2026-09-10T06:00:12.004Z",
"updatedAt": "2026-09-10T06:00:12.004Z"
}
]
}
| Field | Type | Description |
|---|---|---|
count | number | Number of items in this response |
nextCursor | string | null | Cursor for the next page. null on the last page |
items[].id | string | Folder ID (fd_ prefix) |
items[].profileId | string | Parent profile ID |
items[].name | string | Folder name |
items[].isDefault | boolean | Whether this is the default folder created with the profile |
items[].itemsCount | number | Number of items in the folder |
items[].createdAt | string | Creation time |
items[].updatedAt | string | Last update time |
Get a folder
GET /v1/folders/{folderId}
items array.
curl "https://client-omni-api.argosidentity.com/v1/folders/fd_9pq2mklt83bx" \
-H "x-api-key: your-api-key-here"
Response
{
"id": "fd_9pq2mklt83bx",
"profileId": "pf_6h4y8s2f0v9n",
"name": "default",
"isDefault": true,
"itemsCount": 3,
"items": [
{
"id": "item_axfkh2noof85",
"type": "text",
"name": "certificate of good standing",
"contentType": "text/plain",
"sizeBytes": 538,
"createdAt": "2026-09-10T05:35:31.412Z"
}
],
"createdAt": "2026-09-10T05:32:47.118Z",
"updatedAt": "2026-09-10T05:35:41.330Z"
}
| Field | Type | Description |
|---|---|---|
items[].id | string | Item ID (item_ prefix) |
items[].type | string | file · text · json |
items[].name | string | Item name |
items[].contentType | string | null | MIME type |
items[].sizeBytes | number | null | Size in bytes |
items[].createdAt | string | Creation time |
Error codes
| Status | Code | Description |
|---|---|---|
| 404 | OMNI_3005 | Profile not found (list) |
| 404 | OMNI_3009 | Folder not found (single folder) |