REregdoor
company-organizations

Bulk Organizations

post/api/companies/{company_uuid}/organizations/bulk

Request

  • Base URL
    https://api.regdoor.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

company_uuidstring uuid required

Headers

X-User-Emailstring nullable
X-User-Namestring nullable

Request body

action'delete' | 'select' | 'deselect' | 'add_collections' | 'remove_collections' | 'restore' | 'add_groups' | 'remove_groups' | 'replace_groups' required

Supported bulk actions for organizations.

selectedboolean nullable

Current list filter by selection status

searchstring nullable

Current list search term

country_idinteger nullable

Current list country filter

organization_typeTypeEnum[] nullable

Current list organization type filters

government_body_typeGovernmentBodyTypeEnum[] nullable

Current list government body role filters

service_provider_typeServiceProviderTypeEnum[] nullable

Current list service provider subtype filters

regulatory_scopeRegulatoryScopeEnum[] nullable

Current list regulatory scope filters

regulatory_powerRegulatoryPowerEnum[] nullable

Current list regulatory power filters

institutional_formInstitutionalFormEnum[] nullable

Current list institutional form filters

collection_liststring[] nullable

Current list collection name filters

sort_bystring nullable

Current list sort field

sort_orderstring nullable

Current list sort order

user_uuidstring uuid4 nullable

Current list owner filter

include_organization_uuidsstring[] nullable

Manual organization UUID selection. When present, filters are ignored.

exclude_organization_uuidsstring[] nullable

Organization UUIDs excluded from a filtered bulk selection

group_uuid_liststring[] nullable

Current list area (group) filter

unassigned_groupboolean

Current list filter: organizations without area

group_uuidsstring[] nullable

Areas (groups) applied by add_groups/remove_groups/replace_groups

collections_to_addstring[] nullable

Collection names to merge for add_collections bulk action

collections_to_removestring[] nullable

Collection names to remove for remove_collections bulk action

Response

Successful Response

action'delete' | 'select' | 'deselect' | 'add_collections' | 'remove_collections' | 'restore' | 'add_groups' | 'remove_groups' | 'replace_groups' required

Supported bulk actions for organizations.

eligible_countinteger required
blocked_countinteger required
processed_countinteger nullable
processed_uuidsstring[]

UUIDs of organizations effectively processed by execute

blocked_reasonsobject

Changes

No recorded changes to this operation across all 1 revision of this API.