Skip to main content

​
List Invites

Returns all invites for a dock, ordered by createdAt descending. 
GET /v1/docks/:dockId/invites

​
Path Parameters

ParameterTypeDescription
dockIdstringThe dock ID

​
Example Request

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

​
Response

[
  {
    "id": "inv_01HQ8A...",
    "dockId": "dock_01HQ3K...",
    "recipientId": "rcp_01HQ3N...",
    "status": "pending",
    "createdAt": "2025-01-22T15:00:00.000Z"
  },
  {
    "id": "inv_01HQ8B...",
    "dockId": "dock_01HQ3K...",
    "recipientId": "rcp_01HQ3P...",
    "status": "accepted",
    "createdAt": "2025-01-20T10:00:00.000Z"
  }
]

​
Error Handling

StatusCondition
401Missing or invalid API key
404Dock not found