List invites

GET

https://api.sureshake.com/v2/entities/{entityId}/collections/{id}/invites

Path parameters

entityId
string
required
format: uuid

id
string
required
format: uuid

Returns

200

Default Response

JSON

data
object
required
- collectionId
  string
  required
  format: uuid
- sharePermission
  viewer
  or
  download
  required
- invites
  array of
  object
  required
  id
  string
  required
  format: uuid
  code
  string
  required
  collectionId
  string
  required
  format: uuid
  inviterUserId
  string
  required
  permission
  viewer
  or
  download
  required
  status
  active
  or
  revoked
  or
  expired
  required
  expiresAt
  string
  or null
  required
  maxUses
  number
  or null
  required
  uses
  number
  required
  createdAt
  string
  required
  updatedAt
  string
  required
  lastUsedAt
  optional
  string
  or null
  inviteUrl
  optional
  string
  qrPayload
  optional
  string
  valid
  optional
  boolean
  disabledReason
  optional
  revoked
  or
  expired
  or
  max_uses_reached
  or null
}
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": { "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50", "sharePermission": "viewer", "invites": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "code": "string", "collectionId": "0ffe69e2-b7af-4b1e-835c-867376165f50", "inviterUserId": "string", "permission": "viewer", "status": "active", "expiresAt": "string", "maxUses": 0, "uses": 0, "lastUsedAt": "string", "createdAt": "string", "updatedAt": "string", "inviteUrl": "string", "qrPayload": "string", "valid": true, "disabledReason": "revoked" } ] }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }