HITL

List HITL configs

Get paginated list of HITL configurations.

get/api/v1/hitl

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/hitl
  • Auth: HTTP bearer

Query parameters

pageinteger
Example:1
limitinteger
Example:20
status'pending' | 'active' | 'archived'

Status of a HITL configuration

Example:active
environment'production' | 'test'
Example:production
profile_idstring

Filter configs to one project (public profile). UX narrowing only — always ANDed with the owner; omit to list all projects.

Response

List of HITL configs

Example response

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "user_id": "507f1f77bcf86cd799439011",
      "name": "Production Approvals",
      "profile_id": "507f1f77bcf86cd799439011",
      "circle_id": "507f1f77bcf86cd799439011",
      "channels": [
        {
          "config": {
            "chat_id": "123456789"
          }
        }
      ],
      "timeout_seconds": 3600,
      "status": "active",
      "environment": "production"
    }
  ],
  "limits": {
    "max_active_configs": 1,
    "active_configs": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.