Skip to main content

GetGroupInvite​

Inspects a group invite returning information about the team that created it.

Path Parameters
  • group_invite_code string required

    Provided by rivet.api.group#CreateGroupInviteOutput$code.

Responses

GetGroupInvite 200 response

Schema
  • group object required

    A group handle.

    • group_id string required

      Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

      A universally unique identifier.

    • display_name string required

      Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$

      Represent a resource's readable display name.

    • avatar_url string

      The URL of this group's avatar image.

    • external object required

      External links for this group.

      • profile string required

        A link to this group's profile page.

      • chat string required

        A link to this group's chat page.

    • is_developer boolean

      Whether or not this group is a developer group.