Skip to content

Accepting an invitation to join an organization

Entity relationship diagram

erDiagram
  USER ||--o{ INVITATION : contains
  USER ||--o{ MEMBERSHIP : contains
  INVITATION ||..|| ORGANIZATION : references
  MEMBERSHIP ||..|| ORGANIZATION : references

Info

  • Exactly one USER contains zero or more INVITATION
  • Exactly one USER contains zero or more MEMBERSHIP
  • Exactly one INVITATION references exactly one ORGANIZATION
  • Exactly one MEMBERSHIP references exactly one ORGANIZATION

Get pending invitations

GET https://api.zorgapis.nl/v1beta1/users/me/invitations?filter=eq(status,"PENDING") HTTP/1.1

HTTP/1.1 200 Success
Content-Type: application/json

[
  {
    "id": "88411780-1d25-4bc3-86a5-f2f901d9a900",
    "organizationId": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad",
    "organization": {
      "id": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad",
      "name": "Nictiz"
    },
    "emailAddress": "john.doe@nictiz.nl",
    "status": "PENDING"
  }
]

Note

To learn more, view the API reference or fork our Postman Collection and explore our API.

Accept pending invitation

POST https://api.zorgapis.nl/v1beta1/users/me/invitations/88411780-1d25-4bc3-86a5-f2f901d9a900:accept HTTP/1.1

HTTP/1.1 200 Success
Content-Type: application/json

{
  "id": "88411780-1d25-4bc3-86a5-f2f901d9a900",
  "organizationId": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad",
  "organization": {
    "id": "4a7c2c17-6514-46f8-aa05-6a22fb18b4ad",
    "name": "Nictiz"
  },
  "emailAddress": "john.doe@nictiz.nl",
  "status": "ACCEPTED",
  "responseTime": "2024-04-10T15:00:00.000Z" // (1)!
}
  1. The date and time (formatted as per ISO 8601) at which the user responded to the invitation.

Note

To learn more, view the API reference or fork our Postman Collection and explore our API.