Skip to content

HOA API

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

Download OpenAPI description
hoas.json
hoas.yaml
Overview
E-mail
servicedesk@twinq.nl
Languages
Servers
Production environment
https://api.twinq.nl/hoas/

List HOAs

Request

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.

Security
oauth2_client_credentials
Path
company_idintegerrequired

TwinQ customer ID

Example: 123
Query
next_tokenstring

Token for next set of data objects if available

Example: next_token=ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B
max_rowsinteger[ 1 .. 1000 ]

Maximum number of data objects to return per request

Default 500
Example: max_rows=500
glninteger

Global Location Number. The GLN always consists of 13 numbers.

Example: gln=1234567890123
kvkstring

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

Example: kvk=01234567
hoa_codestring

HOA code

Example: hoa_code=A001
curl -i -X GET \
  'https://api.twinq.nl/hoas/hoas/v1/123?next_token=ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B&max_rows=500&gln=1234567890123&kvk=01234567&hoa_code=A001' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
dataArray of objects

Contains the response data

countinteger
next_tokenstring
filtersobject

Parameters used

Response
application/json
{
  "data": [
    {
      "hoa_id": 123456,
      "naam": "VvE TwinQ",
      "vve_code": "A001",
      "kvk": "01234567",
      "gln": 1234567890123
    }
  ],
  "count": 1,
  "next_token": "ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B",
  "filters": {
    "max_rows": 500,
    "next_token": "ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B",
    "company_id": 123,
    "kvk": "01234567",
    "gln": 1234567890123,
    "hoa_code": "A001"
  }
}

List board members

Request

Returns details about the board members of the given HOA, i.e. role, name and contact details.

Security
oauth2_client_credentials
Path
company_idintegerrequired

TwinQ customer ID

Example: 123
hoa_idintegerrequired

HOA ID

Example: 123456
Query
next_tokenstring

Token for next set of data objects if available

Example: next_token=ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B
max_rowsinteger[ 1 .. 1000 ]

Maximum number of data objects to return per request

Default 500
Example: max_rows=500
as_of_datestring(date-time)

Date time in UTC to be used as reference date. Format as in RFC 3339, section 5.6

Example: as_of_date=2025-01-01T12:34:56Z
curl -i -X GET \
  'https://api.twinq.nl/hoas/hoas/v1/123/123456/board?next_token=ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B&max_rows=500&as_of_date=2025-01-01T12%3A34%3A56Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
dataArray of objects

Contains the response data

countinteger
next_tokenstring
filtersobject

Parameters used

Response
application/json
{
  "data": [
    {
      "board_member_id": 123456,
      "bestuursfunctie": "Bestuurslid communicatie",
      "bestuurslid": "de Jong, H.",
      "telefoonnummers": [
        {
          "telefoonnummer": "06 12345678",
          "type_telefoonnummer": "Mobiel"
        }
      ],
      "e_mailadressen": [
        "voorbeeld@twinq.nl, voorbeeld2@twinq.nl"
      ],
      "adres": "teststraat 1, Oosterhout",
      "postadres": "postbus 1, Oosterhout"
    }
  ],
  "count": 1,
  "next_token": "ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B",
  "filters": {
    "max_rows": 500,
    "next_token": "ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B",
    "company_id": 123,
    "hoa_id": 123456,
    "as_of_date": "2025-01-01T12:34:56Z"
  }
}

List committee members

Request

Returns details about the committee members of the given HOA

Security
oauth2_client_credentials
Path
company_idintegerrequired

TwinQ customer ID

Example: 123
hoa_idintegerrequired

HOA ID

Example: 123456
Query
next_tokenstring

Token for next set of data objects if available

Example: next_token=ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B
max_rowsinteger[ 1 .. 1000 ]

Maximum number of data objects to return per request

Default 500
Example: max_rows=500
as_of_datestring(date-time)

Date time in UTC to be used as reference date. Format as in RFC 3339, section 5.6

Example: as_of_date=2025-01-01T12:34:56Z
curl -i -X GET \
  'https://api.twinq.nl/hoas/hoas/v1/123/123456/committees?next_token=ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B&max_rows=500&as_of_date=2025-01-01T12%3A34%3A56Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
dataArray of objects

Contains the response data

countinteger
next_tokenstring
filtersobject

Parameters used

Response
application/json
{
  "data": [
    {
      "committee_member_id": 123456,
      "commissie": "Bestuurscommissie",
      "commissielid": "de Jong, H.",
      "telefoonnummers": [
        {
          "telefoonnummer": "06 12345678",
          "type_telefoonnummer": "Mobiel"
        }
      ],
      "e_mailadressen": [
        "voorbeeld@twinq.nl, voorbeeld2@twinq.nl"
      ],
      "adres": "teststraat 1, Oosterhout",
      "postadres": "postbus 1, Oosterhout"
    }
  ],
  "count": 1,
  "next_token": "ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B",
  "filters": {
    "max_rows": 500,
    "next_token": "ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B",
    "company_id": 123,
    "hoa_id": 123456,
    "as_of_date": "2025-01-01T12:34:56Z"
  }
}

List management team members

Request

Returns details about the management team members of the given HOA

Security
oauth2_client_credentials
Path
company_idintegerrequired

TwinQ customer ID

Example: 123
hoa_idintegerrequired

HOA ID

Example: 123456
Query
next_tokenstring

Token for next set of data objects if available

Example: next_token=ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B
max_rowsinteger[ 1 .. 1000 ]

Maximum number of data objects to return per request

Default 500
Example: max_rows=500
as_of_datestring(date-time)

Date time in UTC to be used as reference date. Format as in RFC 3339, section 5.6

Example: as_of_date=2025-01-01T12:34:56Z
curl -i -X GET \
  'https://api.twinq.nl/hoas/hoas/v1/123/123456/management-team?next_token=ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B&max_rows=500&as_of_date=2025-01-01T12%3A34%3A56Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
dataArray of objects

Contains the response data

countinteger
next_tokenstring
filterobject

Parameters used

Response
application/json
{
  "data": [
    {
      "management_team_member_id": 123456,
      "rol": "0. VvE-beheerder / Accountmanager",
      "naam": "de Jong, H.",
      "functie": "Financieel Beheerder",
      "telefoonnummer": "06 12345678",
      "e_mailadres": "voorbeeld@twinq.nl"
    }
  ],
  "count": 1,
  "next_token": "ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B",
  "filter": {
    "max_rows": 500,
    "next_token": "ABC4D65611ECFB58760B12D175139E7A36A07D93EBF657CA3A2DB2A70D1195B013746F0A717F64F3806B3893AA42E20B",
    "company_id": 123,
    "hoa_id": 123456,
    "as_of_date": "2025-01-01T12:34:56Z"
  }
}