Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Invitations

Create an invitation

This endpoint allows you to send an invitation to a user.

If you are using a personal access token, you need to have an access level superior or equal to member.

post/v1/invitations

Query parameters

send_emailboolean

Whether to send an email to the invitee with a link to accept the invitation.

Request body

emailstring required

email of the user to invite.

role'manager' | 'member' | 'restricted'

Use access_level instead.

access_level'manager' | 'member' | 'restricted'

Example request

{
  "email": "eric@gitguardian.com",
  "role": "manager",
  "access_level": "manager"
}

Response

Invitation sent

idinteger
emailstring email
role'manager' | 'member' | 'restricted'
access_level'manager' | 'member' | 'restricted'
datestring date-time

Creation date of the invitation

Example response

{
  "id": 3252,
  "email": "john.smith@example.org",
  "date": "2019-08-22T14:15:22Z"
}