List members

GET

https://api.sureshake.com/v2/entities/{entityId}/viewer-groups/{groupId}/members

Path parameters

entityId
string
required
format: uuid

groupId
string
required
format: uuid

Query parameters

afterUserId
optional
string
minLength: 1
limit
optional
integer
maximum: 100 · minimum: 1 · default: 50

Returns

200

Default Response

JSON

data
object
required
- members
  array of
  object
  required
  userId
  string
  required
  name
  string
  required
  email
  string
  required
  format: email
  grantedVia
  access_request
  or
  manual
  or
  tier_migration
  required
  createdAt
  string
  required
  format: date-time
- nextCursor
  string
  or null
  required
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

{ "data": { "members": [ { "userId": "string", "name": "string", "email": "user@example.com", "grantedVia": "access_request", "createdAt": "2019-08-24T14:15:22Z" } ], "nextCursor": "string" }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }