Skip to main content

​
List Profiles

GET /v1/workflows/{workflowId}/profiles

​
Request

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

​
Query Parameters

ParameterTypeDefaultDescription
searchstringSearch by profile name
sortstringcreatedAtSort field: name, createdAt, lastAnalysisAt
orderstringdescSort order: asc, desc
cursorstringPagination cursor from previous response
limitnumber10Items per page (max 100)

​
Response

{
  "count": 10,
  "nextCursor": "dXNlcjpVMDYxTkZUVDI",
  "items": [
    {
      "id": "pf_a1b2c3d4",
      "workflowId": "wf_7a3f9c2e",
      "name": "Acme Corp - KYB Verification",
      "description": "KYB verification for Acme Corp",
      "metadata": {
        "region": "KR",
        "riskProfile": "standard"
      },
      "itemsCount": 3,
      "foldersCount": 1,
      "lastAnalysisAt": "2026-03-15T10:30:00Z",
      "createdAt": "2026-03-15T10:00:00Z",
      "updatedAt": "2026-03-15T10:30:00Z"
    }
  ]
}
​
count
number
required
Total items in current response
​
nextCursor
string | null
required
Cursor for next page (null if no more results)
​
items[].id
string
required
Profile ID
​
items[].workflowId
string
required
Parent workflow ID
​
items[].name
string
required
Profile display name
​
items[].description
string | null
Profile description
​
items[].metadata
object | null
Custom metadata
​
items[].itemsCount
number
required
Total item count across all folders
​
items[].foldersCount
number
required
Folder count
​
items[].lastAnalysisAt
string | null
Last analysis time (ISO 8601)
​
items[].createdAt
string
required
Creation time (ISO 8601)
​
items[].updatedAt
string
required
Last update time (ISO 8601)
Use cursor-based pagination for consistent results. Pass the nextCursor value from the response as the cursor parameter in the next request.

​
Get Profile by ID

GET /v1/profiles/{profileId}

​
Request

curl -X GET "http://client-omni-api.argosidentity.com/v1/profiles/{profileId}" \
  -H "x-api-key: your-api-key-here"

​
Response

{
  "id": "pf_a1b2c3d4",
  "workflowId": "wf_7a3f9c2e",
  "name": "Acme Corp - KYB Verification",
  "description": "KYB verification for Acme Corp",
  "metadata": {
    "region": "KR",
    "riskProfile": "standard"
  },
  "itemsCount": 3,
  "lastAnalysisAt": "2026-03-15T10:30:00Z",
  "folders": [
    {
      "id": "fld_default001",
      "name": "default",
      "isDefault": true,
      "itemsCount": 2,
      "createdAt": "2026-03-15T10:00:00Z"
    }
  ],
  "createdAt": "2026-03-15T10:00:00Z",
  "updatedAt": "2026-03-15T10:30:00Z"
}

​
Error Codes

StatusCodeDescription
404PROFILE_NOT_FOUNDProfile not found

​
Get Items Status

GET /v1/profiles/{profileId}/items/status
Returns a summary of item processing status across all folders in the profile. 
curl -X GET "http://client-omni-api.argosidentity.com/v1/profiles/{profileId}/items/status" \
  -H "x-api-key: your-api-key-here"

{
  "profileId": "pf_a1b2c3d4",
  "summary": {
    "total": 3,
    "pending": 0,
    "active": 3,
    "failed": 0
  },
  "isRagReady": true,
  "items": [
    {
      "id": "item_abc123",
      "name": "business_registration.pdf",
      "type": "file",
      "status": "ACTIVE",
      "processedAt": "2026-03-15T10:02:00Z"
    }
  ]
}
​
profileId
string
required
Profile ID
​
summary.total
number
required
Total item count
​
summary.pending
number
required
Items in PENDING status
​
summary.active
number
required
Items in ACTIVE status
​
summary.failed
number
required
Items in FAILED status
​
isRagReady
boolean
required
true when all items are ACTIVE (ready for analysis)
Poll this endpoint at 1-second intervals until isRagReady is true before triggering analysis.