Skip to main content

List Recipient Groups

Returns all recipient groups in a dock with their members.
GET /v1/docks/:dockId/groups

Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID

Example Request

curl https://api.docyard.io/v1/docks/dock_01HQ3K.../groups \
  -H "Authorization: Bearer dk_live_a1b2c3d4..."

Response

[
  {
    "id": "grp_01HQ3R...",
    "dockId": "dock_01HQ3K...",
    "name": "Mortgagee Partners",
    "description": "All institutional mortgage lender recipients",
    "recipients": [
      { "id": "rcp_01HQ3N...", "name": "First National Bank", "email": "[email protected]" },
      { "id": "rcp_01HQ3P...", "name": "SecondBank Corp", "email": "[email protected]" }
    ],
    "createdAt": "2025-01-15T10:40:00.000Z"
  }
]

Error Handling

StatusCondition
401Missing or invalid API key
404Dock not found