IM
ZH-TW
文件首頁
選單

Contents

Account management endpoints

POST/api/account-views/switch

Switch active account context for the authenticated user. More Accounts & Members

Body application/json
account_idstringrequired
Account identifier.
Responses
200application/json
OK
schemaobject
dataobjectrequired
idstringrequired
Account view identifier.
user_idstringrequired
User identifier.
application_idstringrequired
Application identifier.
current_account_idstringrequired
Account identifier.
created_atstringrequired
updated_atstringrequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
GET/api/accounts

List accounts available to the authenticated user. More Accounts & Members

Responses
200application/json
OK
schemaobject
dataarrayrequired
itemobjectrequired
idstringrequired
parent_idstring | nullrequired
namestring | nullrequired
avatar_urlstring | null
meta
linksobjectrequired
selfstringrequired
URL of the current page
nextstring
URL of the next page
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/accounts

Create a child account under the active parent account. More Accounts & Members

Body application/json
namestringrequired
Responses
201application/json
Created
schemaobject
dataobjectrequired
idstringrequired
parent_idstring | nullrequired
namestring | nullrequired
avatar_urlstring | null
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
DELETE/api/accounts/{account_id}

Delete an account and invalidate cached directory views. More Accounts & Members

Responses
204
No Content
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
GET/api/accounts/{account_id}

Retrieve one account by ID. More Accounts & Members

Responses
200application/json
OK
schemaobject
dataobjectrequired
idstringrequired
parent_idstring | nullrequired
namestring | nullrequired
avatar_urlstring | null
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
PATCH/api/accounts/{account_id}

Patch mutable account fields such as name and avatar. More Accounts & Members

Body application/json
namestring | null
avatar_urlstring | null
Responses
200application/json
OK
schemaobject
dataobjectrequired
idstringrequired
parent_idstring | nullrequired
namestring | nullrequired
avatar_urlstring | null
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
GET/api/accounts/{account_id}/email-counts/bootstrap

Auto-generated OpenAPI docs for undocumented route.

Responses
200application/json
OK
schemaobject
dataobjectrequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/accounts/{account_id}/job-events/search

Auto-generated OpenAPI docs for undocumented route.

Responses
200application/json
OK
schemaobject
dataarrayrequired
itemobjectrequired
meta
linksobjectrequired
selfstringrequired
URL of the current page
nextstring
URL of the next page
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/accounts/{account_id}/job-events/search-delete

Auto-generated OpenAPI docs for undocumented route.

Responses
200application/json
OK
schemaobject
dataobjectrequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/accounts/search

Search account records by query expression. More Accounts & Members

Body application/json
querystringrequired
limitinteger
offsetinteger
Responses
200application/json
OK
schemaobject
dataarrayrequired
itemobjectrequired
idstringrequired
namestring | nullrequired
parent_idstring | nullrequired
meta
linksobjectrequired
selfstringrequired
URL of the current page
nextstring
URL of the next page
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring

Models

ProblemDetails
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
ValidationProblemDetails
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring