# List HOAs

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.

Endpoint: GET /hoas/v1/{company_id}
Security: oauth2_client_credentials

## Path parameters:

  - `company_id` (integer, required)
    TwinQ customer ID
    Example: 123

## Query parameters:

  - `next_token` (string)
    Token for next set of data objects if available
    Example: "ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B"

  - `max_rows` (integer)
    Maximum number of data objects to return per request
    Example: 500

  - `gln` (integer)
    Global Location Number. The GLN always consists of 13 numbers.
    Example: 1234567890123

  - `kvk` (string)
    The Netherlands Chamber of Commerce (Kamer van Koophandel). Always consists of 8 numbers, don't forget to include leading zeros.
    Example: "01234567"

  - `hoa_code` (string)
    HOA code
    Example: "A001"

## Response 200 fields (application/json):

  - `data` (array)
    Contains the response data

  - `data.hoa_id` (integer)
    HOA ID

  - `data.naam` (string)
    Name of the HOA

  - `data.vve_code` (string)
    HOA code

  - `data.kvk` (string)
    The Netherlands Chamber of Commerce (Kamer van Koophandel). Always consists of 8 numbers, don't forget to include leading zeros.

  - `data.gln` (integer)
    Global Location Number. The GLN always consists of 13 numbers.

  - `count` (integer)
    Number of returned data objects

  - `next_token` (string)
    Token for next set of data objects if available

  - `filters` (object)
    Parameters used

  - `filters.max_rows` (integer)
    Maximum number of data objects to return per request

  - `filters.company_id` (integer)
    TwinQ customer ID

  - `filters.hoa_code` (string)
    HOA code

## Response 400 fields (application/json):

  - `error` (object)

  - `error.code` (string)
    Example: "VALIDATION_ERROR"

  - `error.message` (string)

  - `error.parameter_errors` (array)

  - `error.parameter_errors.key` (string)

  - `error.parameter_errors.value` (string)

  - `error.parameter_errors.expected_format` (string)

  - `error.parameter_errors.allowed_values` (string)

## Response 403 fields (application/json):

  - `error` (object)

  - `error.code` (string)
    Example: "FORBIDDEN"

  - `error.message` (string)
    Example: "Unauthorized request."