Get Account Membership Settings

GET 
/v2/settings/account-membership

Use this endpoint to get all account membership settings.

Responses

200

OK

application/json

Schema

Schema

data object

type string

Possible values: [account_membership_setting]

Specifies the the type of object. Set this value to account_membership_setting.

membership_limit integer

The number of accounts an account member can be associated with. You can set this value to any number up to 10,000.

Example (from schema)

{
  "data": {
    "type": "account_membership_setting",
    "membership_limit": 100
  }
}

401

Unauthorized

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

unauthorized-error

{
  "errors": [
    {
      "title": "Unauthorized",
      "status": "401"
    }
  ]
}

default

Internal server error.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Loading...