Circles

List Circles

List the caller's Circles (archived excluded by default; pass ?status=archived to surface them).

get/api/v1/circles

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/circles
  • Auth: one of:
    • HTTP bearer
    • API key in cookie auth_token

Query parameters

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

Lifecycle state of a Circle (archived = soft-retired)

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

MongoDB ObjectId

Example:507f1f77bcf86cd799439011

Response

List of Circles

Example response

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "user_id": "507f1f77bcf86cd799439011",
      "name": "Family",
      "owner_name": "Dad",
      "profile_id": "507f1f77bcf86cd799439011",
      "environment": "production",
      "status": "active",
      "member_count": 2,
      "members": [
        {
          "id": "507f1f77bcf86cd799439011",
          "name": "Mum",
          "status": "active",
          "enrolled_phone_hint": "+9••••••4171"
        }
      ]
    }
  ]
}

Changes

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