Find an invitation

Search for an invitation using an invitation_id, search_tag, or invite_email_address.

While searching for invitations using the search_tag or invite_email_address, the result returns the invitations created only by the calling application.

Using an invitation_id

GET {base URL}/invitation/{invitation_id}

• HEADER:

  • Include TID OAuth Bearer token for your application

  • Add a Content-Type of application/JSON.

• PARAMETERS:

  • include_expired: Query parameter accepts boolean values to search the expired invitation as well. This value is optional, and the default value is false.

Example request:

GET {base URL}/invitation/ad8c2590-1888-4ae6-b1ee-4ca26b6c470b

Example response:

{
    "invitation":
    {
        "invite_email_address": "john_example@examplellc.com",
        "invitee_name": "John Example",
        "expiry": "2020-01-29T03:29:22",
        "search_tag": "example",
        "product_name": "Tekla",
        "invitation_id": "ad8c2590-1888-4ae6-b1ee-4ca26b6c470b",
        "status": "sent",
        "inviter_name": "John Example",
        "inviter_app_id": "5e62f6c9...",
        "locale":"en-US",
        "expired": true
    }
}

The status of the Invitation failed, sent, and complete. The expired attribute shown in the response is applicable only if the include_expired query parameter is passed in the request URL and the Invitation remains expired. Otherwise, the response will not show the expired attribute.

Using multiple invitation_id

GET {base URL}/invitations/

• HEADER:

  • Include TID OAuth Bearer token for your application

  • Add a Content-Type of application/JSON

• Parameters

  • invitation_id: Comma separated String. limited to 50 invitation id.

Example request:

GET {base URL}/invitations?invitation_id=0c53db14675a4ae4a9ee9c4d77a45c29,2a2c09e4fdc24d828b23d02cb2aa0949

Example response:

{
    "invitations":  [
        {
            "invite_email_address": "john@examplellc.com",
            "invitee_name": "John Example",
            "expiry": "2020-01-29T03:29:22",
            "search_tag": "example",
            "product_name": "Tekla",
            "invitation_id": "0c53db14675a4ae4a9ee9c4d77a45c29",
            "status": "sent",
            "inviter_name": "Smith Example",
            "inviter_app_id": "5e62f6c9..."
        },
        {
            "invite_email_address": "alice@examplellc.com",
            "invitee_name": "Alice Example",
            "expiry": "2020-01-30T03:29:22",
            "search_tag": "example",
            "product_name": "Tekla",
            "invitation_id": "2a2c09e4fdc24d828b23d02cb2aa0949",
            "status": "sent",
            "inviter_name": "Smith Example",
            "inviter_app_id": "5e62f6c9..."
        }
    ]
}

Using search_tag

GET {base URL}/invitations/

• HEADER:

  • Include TID OAuth Bearer token for your application

  • Add a Content-Type of application/JSON

• Parameters

  • search_tag: String value used (see Create an end-user invitation)

Example request:

GET {base URL}/invitations?search_tag=example

Example response:

{
    "invitations":  [
        {
        "invite_email_address": "john_example@examplellc.com",
        "invitee_name": "John Example",
        "expiry": "2020-01-29T03:29:22",
        "search_tag": "example",
        "product_name": "Tekla",
        "invitation_id": "ad8c2590-1888-4ae6-b1ee-4ca26b6c470b",
        "status": "sent",
        "inviter_name": "John Example",
        "inviter_app_id": "5e62f6c9..."
        }
    ]
}

Using invite_email_address

Invitation Service supports finding an invitation by providing the invite_email_address.

GET {base URL}/invitations/

• HEADER:

  • Include TID OAuth Bearer token for your application

  • Add a Content-Type of application/JSON

• PARAMETERS:

  • invite_email_address: The email address of the person being invited in the create invitation flow.

Example request:

GET {base URL}/invitations?invite_email_address=alice@domain.com

Example response:

{
    "invitations":  [
        {
            "invite_email_address": "alice@domain.com",
            "invitee_name": "Alice Example",
            "expiry": "2020-01-29T03:29:22",
            "search_tag": "example",
            "product_name": "Tekla",
            "invitation_id": "ad8c2590-1888-4ae6-b1ee-4ca26b6c470b",
            "status": "sent",
            "inviter_name": "John Example",
            "inviter_app_id": "5e62f6c9..."
        }
    ]
}