GET /projects/:projectId

Reads the project your API key belongs to. Creating, editing, and deleting projects is not available through the API. Use the dashboard.

Endpoint

GET /v1/projects/{projectId}

Request

Path parameters

Parameter	Type	Description
`projectId`	`string`	ID of the project to read (`proj_` prefix)

curl "https://client-omni-api.argosidentity.com/v1/projects/proj_75hgxoxamzn9" \
  -H "x-api-key: your-api-key-here"

Requesting a project your API key does not belong to returns 403 OMNI_5001.

Response

{
  "id": "proj_75hgxoxamzn9",
  "displayId": "PID-75hgxo",
  "userId": "user_7b3k9m1x5p8t",
  "name": "Demo",
  "description": "Demo project",
  "status": "trial",
  "workflowsCount": 1,
  "workflows": [
    {
      "id": "wf_3p8k2m5r9v1t",
      "name": "Vendor Onboarding Document Verification Policy",
      "status": "active",
      "profilesCount": 1
    }
  ],
  "apiKeysCount": 1,
  "membersCount": 1,
  "owner": {
    "id": "user_7b3k9m1x5p8t",
    "email": "admin@example.com",
    "name": null
  },
  "createdAt": "2026-09-10T04:23:56.000Z",
  "updatedAt": "2026-09-10T05:14:07.000Z"
}

Response fields

Field	Type	Description
`id`	`string`	Project ID (`proj_` prefix)
`displayId`	`string`	Short display ID (`PID-` prefix)
`userId`	`string`	Owner user ID (`user_` prefix)
`name`	`string`	Project name
`description`	`string \| null`	Description
`status`	`string`	Project status. Returned in lowercase (for example `trial`)
`workflowsCount`	`number`	Number of workflows in this project
`workflows`	`object[]`	Workflow list (up to 10). See below
`apiKeysCount`	`number`	Number of active API keys
`membersCount`	`number`	Number of active members
`owner`	`object`	Owner details. See below
`createdAt`	`string`	Creation time
`updatedAt`	`string`	Last update time

The remaining trial period and expiry date are not in this response. Check them on the project info tab in the dashboard — project management.

`workflows`

Field	Type	Description
`id`	`string`	Workflow ID (`wf_` prefix)
`name`	`string`	Workflow name
`status`	`string`	`active` · `archived`
`profilesCount`	`number`	Number of linked profiles

For the full definition, use GET /workflows/:workflowId.

`owner`

Field	Type	Description
`id`	`string`	User ID (`user_` prefix)
`email`	`string`	Owner email
`name`	`string \| null`	Owner name. `null` when not set

Error codes

Status	Code	Description
404	`OMNI_3002`	Project not found

Common errors (400 validation · 401 authentication · 403 permission · 500 server) are listed in the API overview.

Overview

API Reference

Endpoint

Request

Path parameters

Response

Response fields

`workflows`

`owner`

Error codes

​Endpoint

​Request

​Path parameters

​Response

​Response fields

​workflows

​owner

​Error codes

Endpoint

Request

Path parameters

Response

Response fields

`workflows`

`owner`

Error codes