Circles

List Circle members

List a Circle's members (channel presence booleans and a masked enrollment phone only — never an identifier).

get/api/v1/circles/{id}/members

Request

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

Path parameters

idstring required

MongoDB ObjectId

Example:507f1f77bcf86cd799439011

Response

Members

Example response

{
  "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.