Departments
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
limitintegerOptional
Number of results to return per page.
offsetintegerOptional
The initial index from which to return the results.
Responses
200Success
application/json
get
/api/departments200Success
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
idstring · uuidRead-onlyRequired
is_memberstringRead-onlyRequired
is_leaderstringRead-onlyRequired
has_pending_requeststringRead-onlyRequired
member_countstringRead-onlyRequired
leadersstringRead-onlyRequired
membersstringRead-onlyRequired
pending_request_countstringRead-onlyRequired
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
namestring · max: 255Required
descriptionstringRequired
bannerstring · uri · max: 200 · nullableOptional
is_follow_up_departmentbooleanOptional
Responses
201Success
application/json
post
/api/departments201Success
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
A UUID string identifying this group.
Responses
200Success
application/json
get
/api/departments/{id}200Success
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
A UUID string identifying this group.
Body
idstring · uuidRead-onlyRequired
is_memberstringRead-onlyRequired
is_leaderstringRead-onlyRequired
has_pending_requeststringRead-onlyRequired
member_countstringRead-onlyRequired
leadersstringRead-onlyRequired
membersstringRead-onlyRequired
pending_request_countstringRead-onlyRequired
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyRequired
namestring · max: 255Required
descriptionstringRequired
bannerstring · uri · max: 200 · nullableOptional
is_follow_up_departmentbooleanOptional
Responses
200Success
application/json
put
/api/departments/{id}200Success
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
A UUID string identifying this group.
Responses
204
No response body
delete
/api/departments/{id}204
No response body
No content
patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
A UUID string identifying this group.
Body
idstring · uuidRead-onlyOptional
is_memberstringRead-onlyOptional
is_leaderstringRead-onlyOptional
has_pending_requeststringRead-onlyOptional
member_countstringRead-onlyOptional
leadersstringRead-onlyOptional
membersstringRead-onlyOptional
pending_request_countstringRead-onlyOptional
legacy_idstring · nullableOptional
nextgen_legacy_idstring · nullableOptional
created_atstring · date-time · nullableOptional
updated_atstring · date-timeRead-onlyOptional
namestring · max: 255Optional
descriptionstringOptional
bannerstring · uri · max: 200 · nullableOptional
is_follow_up_departmentbooleanOptional
Responses
200Success
application/json
patch
/api/departments/{id}200Success