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

​
Request

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

​
Parameters

FieldInTypeRequiredNotes
customerIdpathstringYesCustomer ID to read

​
Response

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

​
Errors

  • 401 UNAUTHORIZED — missing or invalid bearer token.
  • 403 FORBIDDEN — caller is not an ADMIN on the target customer.
  • 404 NOT_FOUND — the customer does not exist or is not visible to the caller.
See Errors for the full error contract.

Account tasks

All account operations

Update membership

Toggle domain auto-join

Update customer domain

Set the org domain