Skip to content
nsin docs
EN فا

List domain members

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

Everyone with access to the domain — the owner first, then each member — with their role and effective notification matrix, plus your own role and whether you may manage membership (can_edit). The owner always receives every notification and has no preferences to change. Requires domain.view.

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 ”

Members.

Media type application/json
object
members
Array<object>
object
user_id
integer
email
string
name
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
is_owner
boolean
is_self

True for the account this key belongs to.

boolean
joined_at
string format: date-time
notify

The member’s effective notification matrix. Always all-on for the owner, who receives every category and cannot opt out.

object
notify_defaulted

Category → the channels still UNSET for this member, i.e. inherited from their role rather than chosen. Render them as inherited, not as a box the member ticked: a role change moves them.

object
key
additional properties
Array<string>
Allowed values: email sms
is_billing_member

True for the domain’s nominated payer.

boolean
my_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
can_edit

Whether you may manage membership on this domain.

boolean
Example 
{
  "members": [
    {
      "role": "owner",
      "notify_defaulted": {
        "additionalProperty": [
          "email"
        ]
      }
    }
  ],
  "my_role": "owner"
}

401

Section titled “401 ”

Missing, malformed, revoked or expired API key. (A valid key whose account has been deactivated gets 403 account is inactive instead.)

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

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