REregdoor
company-organizations

List Company Organizations

List organizations for a company with optional filtering.

Args: company_uuid (UUID): The company UUID. db_session (DBSessionDep): Database session dependency. type (str, optional): Filter by organization type. search (str, optional): Search by organization name. country_id (List[int], optional): Filter by country ID(s). selected (bool, optional): Filter by selection status. user_uuid (UUID, optional): Filter by organization owner. sort_by (str, optional): Sort by field ('name', 'short_name', or 'country'). sort_order (str, optional): Sort order ('asc' or 'desc').

Returns: Page[CompanyOrganizationResponse]: Paginated list of organizations.

get/api/companies/{company_uuid}/organizations

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

Query parameters

typestring nullable

Filter by organization type

searchstring nullable

Search by organization name

country_idinteger[] nullable

Filter by country ID(s). Can specify multiple times.

selectedboolean nullable

Filter by selection status

user_uuidstring uuid nullable

Filter by organization owner

collection_liststring[]

Filter by collection name(s). Can specify multiple times.

group_uuidstring[]

Filter by company group UUID(s). Can specify multiple times.

government_body_typeGovernmentBodyTypeEnum[] nullable

Filter government bodies by role. Match if the org has any selected role.

service_provider_typeServiceProviderTypeEnum[] nullable

Filter by service provider subtype. Match if the org has any selected subtype.

regulatory_scopeRegulatoryScopeEnum[] nullable

Filter by regulatory scope tags. capital_markets matches any child scope.

regulatory_powerRegulatoryPowerEnum[] nullable

Filter by regulatory power tags. Match if the org has any selected power.

institutional_formInstitutionalFormEnum[] nullable

Filter by institutional form. Match if the org has any selected form.

group_uuid_liststring[] nullable

Filter by responsible area (group). Match if the org has any of them.

unassigned_groupboolean

Only selected organizations without any area. Combined with group_uuid_list returns the union.

sort_bystring nullable

Sort by field (name, short_name, first_interaction, last_interaction, total_interactions_count, sentiment_score, contacts_total, or country)

sort_orderstring nullable

Sort order (asc or desc)

pageinteger

Page number

sizeinteger

Page size

Headers

X-Teamspace-Uuidstring uuid nullable
X-User-Emailstring nullable
X-User-Namestring nullable

Response

Successful Response

totalinteger nullable required
pageinteger nullable required
sizeinteger nullable required
pagesinteger nullable

Changes

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