# HOA API

Retrieving data regarding the HOA, for example information about the board members, committee members or the management team.


## Servers

Production environment
```
https://api.twinq.nl/hoas
```

## Security

### oauth2_client_credentials

OAuth2 authorization based on Client Credentials

Type: oauth2

## Download OpenAPI description

[HOA API](https://api-docs.twinq.nl/_bundle/apis/modules/hoas/hoas.yaml)

## Other

### List HOAs

 - [GET /hoas/v1/{company_id}](https://api-docs.twinq.nl/apis/modules/hoas/hoas/other/gethoasv1.md): Returns details about the HOAs of the given TwinQ customer, such as Chamber of Commerce number (KVK) and Global Location Number (GLN). The hoa_id can then be used to call other HOA endpoints and retrieve more specific information.With query parameters you can search for a specific HOA, for example based on a KVK number or GLN.

### List board members

 - [GET /hoas/v1/{company_id}/{hoa_id}/board](https://api-docs.twinq.nl/apis/modules/hoas/hoas/other/getboardv1.md): Returns details about the board members of the given HOA, i.e. role, name and contact details.

### List committee members

 - [GET /hoas/v1/{company_id}/{hoa_id}/committees](https://api-docs.twinq.nl/apis/modules/hoas/hoas/other/getcommitteesv1.md): Returns details about the committee members of the given HOA

### List management team members

 - [GET /hoas/v1/{company_id}/{hoa_id}/management-team](https://api-docs.twinq.nl/apis/modules/hoas/hoas/other/getmanagementteamv1.md): Returns details about the management team members of the given HOA