Skip to content
AdVentur.aiAdVentur.aiAdVentur.ai Docs

Invitations API

4 endpoints. Every path is relative to the API base URL and needs a bearer token unless it is marked public. See the REST API overview for authentication, errors and pagination.

POST/v1/invitations/accept

Bearer token

Request body application/json

  • tokenstringrequired

Responses

200
  • dataobjectrequired
    Fields
    • orgIdstring (uuid)required
    • orgSlugstringrequired
    • orgNamestringrequired
Request
curl -X POST "https://api.adventur.ai/v1/invitations/accept" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"token":"string"}'

GET/v1/orgs/{orgId}/invitations

Bearer token

Path parameters

  • orgIdstring (uuid)required

Query parameters

  • pageinteger
  • limitinteger
  • sortBystring

    one of createdAt, expiresAt, email, status, roleKey

  • sortDirstring

    one of asc, desc

  • filterobject
    Fields
    • statusstring
    • emailstring
    • roleKeystring
    • createdAtFromstring
    • createdAtTostring
  • filterOpobject
    Fields
    • statusstring

      one of eq, in

    • emailstring

      one of eq, contains

    • roleKeystring

      one of eq, in

    • createdAtFromstring

      one of gte

    • createdAtTostring

      one of lte

Responses

200
  • dataarray<object>required
    Item fields
    • idstring (uuid)required
    • emailstring (email)required
    • roleKeystringrequired
    • roleNamestringrequired
    • statusstringrequired
    • expiresAtstringrequired
    • createdAtstringrequired
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/invitations" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/invitations

Bearer token

Path parameters

  • orgIdstring (uuid)required

Request body application/json

  • emailstring (email)required
  • roleKeystringrequired

Responses

201
  • dataobjectrequired
    Fields
    • idstring (uuid)required
    • emailstring (email)required
    • roleKeystringrequired
    • statusstringrequired
    • expiresAtstringrequired
    • createdAtstringrequired
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/invitations" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","roleKey":"string"}'

DELETE/v1/orgs/{orgId}/invitations/{invitationId}

Bearer token

Path parameters

  • orgIdstring (uuid)required
  • invitationIdstring (uuid)required

Responses

200
  • dataobjectrequired
    Fields
    • idstring (uuid)required
    • statusstringrequired
Request
curl -X DELETE "https://api.adventur.ai/v1/orgs/$ORG_ID/invitations/$INVITATION_ID" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"