List domain members

GET

/domains/{domain}/members

const url = 'https://api.nsin.ir/domains/example.com/members';
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/domains/example.com/members \
  --header 'Authorization: Bearer <token>'

Everyone with access to the domain, including the owner, plus your own role and whether you may manage membership.

Authorizations

bearerAuth
apiKeyAuth

Parameters

Path Parameters

domain

required

string

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

Example

example.com

Responses

200

Members.

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_domain

Receive domain status notifications.

boolean

notify_uptime

Receive outage notifications.

boolean

notify_ssl

Receive certificate notifications.

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"
    }
  ],
  "my_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

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

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