Skip to content

memberSettings.getMemberSettings

GET
/v1/me/settings
curl --request GET \
--url https://example.com/v1/me/settings \
--header 'Authorization: Bearer <token>'

Success

Media typeapplication/json
object
version
required
integer
<= 9007199254740991
planApproval
required
Any of:
object
approver
required
string
Allowed values: chain person
timeoutMs
required
integer
>= 1000 <= 604800000
onTimeout
required
string
Allowed values: run stay
defaultBot
required
Any of:
string
>= 1 characters <= 128 characters
updatedAt
required
string

Example

{
"planApproval": {
"approver": "chain",
"onTimeout": "run"
}
}

SettingsInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: SettingsInvalid
message
required
string

Example

{
"_tag": "SettingsInvalid"
}

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example

{
"_tag": "AuthenticationRequired"
}

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Forbidden
action
required
string
kind
required
string
field
string
reason
string

Example

{
"_tag": "Forbidden"
}

SettingsConflict | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: SettingsConflict
version
required
integer
<= 9007199254740991

Example

{
"_tag": "SettingsConflict"
}

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example

{
"_tag": "RateLimited"
}

SettingsUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: SettingsUnavailable

Example

{
"_tag": "SettingsUnavailable"
}