Sign in
Invites

List invites for a service

get/v1/api/invites

Query parameters

serviceIdstring

Response

OK

attempt_counterinteger
disabledboolean
emailstring
expiredboolean
inviteLinkstring
invite_to_join_serviceboolean
otp_keystring
password_setboolean
rolestring
telephone_numberstring
typestring
user_existboolean

Example response

[
  {
    "_links": [
      {
        "href": "https://an.example.link",
        "method": "GET",
        "rel": "self"
      }
    ],
    "email": "example@example.gov.uk",
    "invite_to_join_service": true,
    "otp_key": "ABC123",
    "role": "view-only",
    "type": "service"
  }
]

Changes