Share Sheet Bridge - API Contract

GET /api/v1/share/api/v1/share

List share events

Public

Response Example

{
  "data": [
    {
      "id": "share_f2a9e1",
      "mentor_id": "usr_4491",
      "type": "link",
      "platform": "whatsapp",
      "status": "completed",
      "shared_at": "2026-03-22T09:15:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 28
  }
}

GET /api/v1/share/api/v1/share/:id

Get a share event by ID

Public

Response Example

{
  "id": "share_f2a9e1",
  "mentor_id": "usr_4491",
  "type": "link",
  "platform": "whatsapp",
  "url": "https://app.org.no/join?ref=JAN-VERV-8F3A",
  "message": "Bli med i organisasjonen! Klikk her: https://app.org.no/join?ref=JAN-VERV-8F3A",
  "status": "completed",
  "shared_at": "2026-03-22T09:15:00Z"
}

POST /api/v1/share/api/v1/share

Share a referral link via native share sheet (shareReferralLink)

Public

Request Example

{
  "mentor_id": "usr_4491",
  "url": "https://app.org.no/join?ref=JAN-VERV-8F3A",
  "message": "Bli med i organisasjonen! Klikk her: https://app.org.no/join?ref=JAN-VERV-8F3A",
  "type": "link"
}

Response Example

{
  "id": "share_f2a9e1",
  "mentor_id": "usr_4491",
  "type": "link",
  "url": "https://app.org.no/join?ref=JAN-VERV-8F3A",
  "message": "Bli med i organisasjonen! Klikk her: https://app.org.no/join?ref=JAN-VERV-8F3A",
  "status": "pending",
  "shared_at": "2026-03-26T12:00:00Z"
}

PUT /api/v1/share/api/v1/share/:id

Record share result callback (onShareResult)

Public

Request Example

{
  "status": "completed",
  "platform": "whatsapp"
}

Response Example

{
  "id": "share_f2a9e1",
  "status": "completed",
  "platform": "whatsapp",
  "updated_at": "2026-03-26T12:01:00Z"
}

DELETE /api/v1/share/api/v1/share/:id

Delete a share event record

Public

Response Example

{
  "id": "share_f2a9e1",
  "deleted": true,
  "deleted_at": "2026-03-26T12:10:00Z"
}

POST /api/v1/share/api/v1/share/qr-image

Share a QR code image via native share sheet (shareQrCodeImage)

Public

Request Example

{
  "mentor_id": "usr_4491",
  "image_base64": "iVBORw0KGgoAAAANSUhEUgAAAS...",
  "message": "Bli med! Skann QR-koden for å registrere deg via Jan.",
  "type": "qr_image"
}

Response Example

{
  "id": "share_e8b3c2",
  "mentor_id": "usr_4491",
  "type": "qr_image",
  "message": "Bli med! Skann QR-koden for å registrere deg via Jan.",
  "status": "pending",
  "shared_at": "2026-03-26T12:02:00Z"
}

GET /api/v1/share/api/v1/share/default-message

Build default share message for a mentor (buildDefaultShareMessage)

Public

Response Example

{
  "mentor_name": "Jan Nilsen",
  "org_name": "Norsk Studentorganisasjon",
  "url": "https://app.org.no/join?ref=JAN-VERV-8F3A",
  "message": "Hei! Jan Nilsen inviterer deg til å bli med i Norsk Studentorganisasjon. Trykk her for å registrere deg: https://app.org.no/join?ref=JAN-VERV-8F3A"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}