Get membership settings
curl --request GET \
--url https://api.interchange.io/api/v2/accounts/{customerId}/membership \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/accounts/{customerId}/membership"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/accounts/{customerId}/membership', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"customerId": 200,
"allowDomainAutoJoin": false,
"customerDomain": "nike.com"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Account
Get membership settings
Get membership settings for a customer org, including whether domain auto-join is enabled. Requires ADMIN role.
GET
/
accounts
/
{customerId}
/
membership
Get membership settings
curl --request GET \
--url https://api.interchange.io/api/v2/accounts/{customerId}/membership \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/accounts/{customerId}/membership"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/accounts/{customerId}/membership', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"customerId": 200,
"allowDomainAutoJoin": false,
"customerDomain": "nike.com"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Path Parameters
Customer ID
Minimum string length:
1Example:
"200"
Response
Get membership settings
Customer membership access settings
Customer ID
Required range:
-9007199254740991 <= x <= 9007199254740991Example:
200
When true, users with a verified matching domain email join immediately as members without admin approval. Defaults to true for top-level organizations and false for child accounts; an explicit setting overrides the default. Requires customerDomain to be set.
Example:
false
Customer domain used to determine auto-join eligibility.
Example:
"nike.com"