Skip to main content

List Folders

GET /v1/profiles/{profileId}/folders

Request

curl -X GET "http://client-omni-api.argosidentity.com/v1/profiles/{profileId}/folders?sort=createdAt&order=desc" \
  -H "x-api-key: your-api-key-here"

Query Parameters

ParameterTypeDefaultDescription
searchstringSearch by folder name
sortstringcreatedAtSort field: name, createdAt, updatedAt
orderstringdescSort order: asc, desc
cursorstringPagination cursor
limitnumber10Items per page (max 100)

Response

{
  "count": 2,
  "nextCursor": null,
  "items": [
    {
      "id": "fld_default001",
      "profileId": "pf_a1b2c3d4",
      "name": "default",
      "isDefault": true,
      "itemsCount": 2,
      "createdAt": "2026-03-15T10:00:00Z",
      "updatedAt": "2026-03-15T10:00:00Z"
    },
    {
      "id": "fld_xyz789",
      "profileId": "pf_a1b2c3d4",
      "name": "Supporting Documents",
      "isDefault": false,
      "itemsCount": 1,
      "createdAt": "2026-03-15T10:30:00Z",
      "updatedAt": "2026-03-15T10:30:00Z"
    }
  ]
}

Get Folder by ID

GET /v1/folders/{folderId}
curl -X GET "http://client-omni-api.argosidentity.com/v1/folders/{folderId}" \
  -H "x-api-key: your-api-key-here"
{
  "id": "fld_default001",
  "profileId": "pf_a1b2c3d4",
  "name": "default",
  "isDefault": true,
  "itemsCount": 2,
  "items": [
    {
      "id": "item_abc123",
      "type": "file",
      "name": "business_registration.pdf",
      "contentType": "application/pdf",
      "sizeBytes": 245678,
      "createdAt": "2026-03-15T10:10:00Z"
    }
  ],
  "createdAt": "2026-03-15T10:00:00Z",
  "updatedAt": "2026-03-15T10:10:00Z"
}

Error Codes

StatusCodeDescription
404FOLDER_NOT_FOUNDFolder not found