Skip to main content
GET /api/v2/accounts/{customerId}/membership Returns the membership access settings for a customer org, including whether domain auto-join is enabled. Requires the ADMIN role.

Request

curl
curl https://api.interchange.io/api/v2/accounts/200/membership \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

Parameters

FieldTypeRequiredNotes
customerIdstringYesPath parameter. ID of the customer to read

Response

{
  "customerId": 200,
  "allowDomainAutoJoin": false
}
FieldTypeNotes
customerIdintegerCustomer ID
allowDomainAutoJoinbooleanWhen true, users with a verified matching-domain email join as members without admin approval. Requires a registered customerDomain

Errors

  • 401 UNAUTHORIZED — caller is not an ADMIN.
See Errors for the full error contract.

Account tasks

All account operations

Update membership

Toggle domain auto-join

Update customer domain

Set the registered domain