Inspect an invitation

GET

/invites/{token}

const url = 'https://api.nsin.ir/invites/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.nsin.ir/invites/example \
  --header 'Authorization: Bearer <token>'

What an invitation grants, for the authenticated caller. Use it before accepting to show who invited them and to which domain.

email_match reports whether the invitation was addressed to the calling account — POST /invites/{token}/accept will refuse when it is false. When it is false, invited_email carries the masked target address.

If the caller already has access, already_member is true and the remaining fields describe their existing role.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

token

required

string

The invitation token from the accept link.

Responses

200

Invitation details.

application/json

object

domain

string

role

Your role on a domain. owner is implicit for the domain’s creator and for global admins; the other three are grantable via sharing.

string

Allowed values: owner admin editor viewer

inviter

Display name of whoever sent it.

string

is_link

boolean

email_match

Whether the invitation was addressed to the calling account. Accepting fails when this is false.

boolean

expires_at

string format: date-time

already_member

You already have access; the other fields describe your existing role.

boolean

is_owner

boolean

invited_email

Masked target address. Present only when email_match is false.

string

Example

{
  "role": "owner"
}

401

Missing, malformed, revoked or expired API key — or the owning account is inactive.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

invalidKey

{
  "error": "invalid API key"
}

404

The invitation does not exist, has expired, was revoked, or is used up.

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Example

{
  "error": "read-only API key"
}

429

The key exceeded its request budget (300 requests per minute by default).

application/json

The single error shape used by every endpoint.

object

error

required

Human-readable description of what went wrong.

string

Examples

limited

{
  "error": "rate limit exceeded"
}