Skip to content
nsin nsin nsin Docs

List pending invitations

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

Invitations that have not yet been accepted. Invites addressed to someone who already has access are filtered out. Requires members.manage.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
domain
required
string

The domain name (for example example.com) — not a numeric id.

Example 
example.com

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Pending invitations.

Media type application/json
object
invites
Array<object>
object
id
integer
domain_id
integer
email

The address the invitation is bound to.

string
role

A role that may be assigned to a member or invitation. owner is not grantable — it always follows domain ownership.

string
Allowed values: admin editor viewer
invited_by

User id of the inviter.

integer
expires_at
string format: date-time
max_uses
integer
uses
integer
revoked_at
string format: date-time
created_at
string format: date-time
link

The accept URL. Returned when the invitation is created or resent.

string
is_link

True for a shareable link rather than an emailed invitation.

boolean
exhausted

True when uses has reached max_uses.

boolean
Example 
{
  "invites": [
    {
      "role": "admin"
    }
  ]
}

401

Section titled “401 ”

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

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example invalidKey 
{
  "error": "invalid API key"
}

403

Section titled “403 ”

The key is read-only, your role on the domain lacks the required permission, or the domain’s plan does not include the feature.

Media type 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"
}

404

Section titled “404 ”

No such domain, or it is not visible to this account. Domains you cannot access are reported as not found rather than forbidden.

Media type 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

Section titled “429 ”

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

Media type application/json

The single error shape used by every endpoint.

object
error
required

Human-readable description of what went wrong.

string
Examples
Example limited 
{
  "error": "rate limit exceeded"
}