Check an invitation

POST

/auth/invitations:check

Code sample: Shell / cURL

curl --request POST \
  --url https://api.grepvine.ai/v1/auth/invitations:check \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

Reports what a pending invitation offers, so the registration form can show it. The token travels in the body, never in the URL. An invitation that was used, withdrawn or has expired is not found.

Request Body^required

Media typeapplication/json

object

token

required

string

>= 1 characters <= 256 characters

Example ^generated

{
  "token": "example"
}

Responses

200

The pending invitation.

Media typeapplication/json

object

email

required

The address the invitation was sent to, to prefill the registration form.

string

organization

An account or organization name. Accounts and organizations share one namespace. A name keeps the case it was created with, and any spelling that differs only in case refers to it; no other account or organization can take such a spelling.

string

/^[A-Za-z][A-Za-z0-9-]{2,62}$/

role

string

Allowed values: admin developer reader

expires_at

required

string format: date-time

Example

{
  "role": "admin"
}

404

The resource does not exist or is not visible.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

{
  "code": "example",
  "reason": "example",
  "error": "example"
}

Headers

X-Request-Id

string

The request identifier used for support and audit correlation.

default

The request failed. A 429 carries Retry-After; the index is busy absorbing recent writes or is out of request capacity, and clients must slow down and retry after the interval. A 403 with code organization_suspended refuses every operation on a suspended organization’s members, indexes, documents and searches; reading the organization itself still answers and reports suspended, and the client should contact support.

Media typeapplication/json

object

code

required

string

reason

required

string

error

required

string

Example ^generated

{
  "code": "example",
  "reason": "example",
  "error": "example"
}

Headers

X-Request-Id

string

The request identifier used for support and audit correlation.

Retry-After

integer

Seconds to wait before retrying. Sent with every 429 so a client slows down instead of failing.