Developers

PUBLIC API v1

List of clients for the company

GET /api/v1/companies/{company_pk}/clients/

List of clients for the company

Permission: read_clients · Direct link

Company-scoped. Account permissions, plan limits and document state still apply.

Path and query parameters

ParameterLocation / typeDescription
company_pkRequiredpath · string (uuid)Company's public id (primary key)
pagequery · integerA page number within the paginated result set.
page_sizequery · integerNumber of results to return per page.

Responses

200 Response fields

application/json

FieldType / accepted valuesDescription
countRequiredintegerNot specified
nextstring (uri) | nullNot specified
previousstring (uri) | nullNot specified
resultsRequiredobject[]Not specified
Nested fields
FieldType / accepted valuesDescription
publicIdRequiredRead onlystring (uuid)Not specified
partyAccountNumberRequiredRead onlystring | nullKundennummer; the debtor Personenkonto (10000+), assigned by Norman on creation, immutable (the DATEV convention Lexware/lexoffice also follows).
nameRequiredstringNot specified
clientType"business" | "person"* `business` - Business * `person` - Private
addressstringNot specified
zipCodestringNot specified
emailstring (email)Not specified
country"AT" | "DE" | "BE" | "HR" | "CY" | "CZ" | "DK" | "EE" | "FI" | "FR" | "HU" | "IE" | "IT" | "LV" | "LT" | "LU" | "MT" | "NL" | "PL" | "PT" | "SK" | "SI" | "ES" | "SE" | "IL" | "LI" | "MC" | "MON" | "NO" | "SM" | "RS" | "CH" | "GB" | "CA" | "US" | "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "CU" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "ET" | "FK" | "FO" | "FJ" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "HN" | "HK" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IM" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LB" | "LS" | "LR" | "LY" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MN" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "SH" | "KN" | "LC" | "PM" | "VC" | "WS" | "ST" | "SA" | "SN" | "SC" | "SL" | "SG" | "SB" | "SO" | "ZA" | "GS" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "UM" | "UY" | "UZ" | "VU" | "VA" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW"* `AT` - Austria * `DE` - Germany * `BE` - Belgium * `HR` - Croatia * `CY` - Cyprus * `CZ` - Czech Republic * `DK` - Denmark * `EE` - Estonia * `FI` - Finland * `FR` - France * `HU` - Hungary * `IE` - Ireland * `IT` - Italy * `LV` - Latvia * `LT` - Lithuania * `LU` - Luxembourg * `MT` - Malta * `NL` - Netherlands * `PL` - Poland * `PT` - Portugal * `SK` - Slovakia * `SI` - Slovenia * `ES` - Spain * `SE` - Sweden * `IL` - Israel * `LI` - Liechtenstein * `MC` - Monaco * `MON` - Montenegro * `NO` - Norway * `SM` - San Marino * `RS` - Serbia * `CH` - Switzerland * `GB` - United Kingdom * `CA` - Canada * `US` - United States * `AF` - Afghanistan * `AX` - Åland Islands * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - AndorrA * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AU` - Australia * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei Darussalam * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `KH` - Cambodia * `CM` - Cameroon * `CV` - Cape Verde * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo, The Democratic Republic of the * `CK` - Cook Islands * `CR` - Costa Rica * `CI` - Cote D'Ivoire * `CU` - Cuba * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `ET` - Ethiopia * `FK` - Falkland Islands * `FO` - Faroe Islands * `FJ` - Fiji * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and Mcdonald Islands * `HN` - Honduras * `HK` - Hong Kong * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran * `IQ` - Iraq * `IM` - Isle of Man * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KP` - North Korea * `KR` - South Korea * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Lao People'S * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `MO` - Macao * `MK` - Macedonia * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia * `MD` - Moldova * `MN` - Mongolia * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `AN` - Netherlands Antilles * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `MP` - Northern Mariana Islands * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestina * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PR` - Puerto Rico * `QA` - Qatar * `RE` - Reunion * `RO` - Romania * `RU` - Russian Federation * `RW` - RWANDA * `SH` - Saint Helena * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SB` - Solomon Islands * `SO` - Somalia * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SZ` - Swaziland * `SY` - Syrian Arab Republic * `TW` - Taiwan, Province of China * `TJ` - Tajikistan * `TZ` - Tanzania, United Republic of * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `UM` - United States Minor Outlying Islands * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VA` - Vatican * `VE` - Venezuela * `VN` - Viet Nam * `VG` - Virgin Islands, British * `VI` - Virgin Islands, U.S. * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe
vatNumberstringNot specified
companyRequiredstring (uuid)Not specified
citystringNot specified
phonestringNot specified
400 Response fields

application/json

FieldType / accepted valuesDescription
detailRequiredstringNot specified
codeintegerNot specified
type_stringNot specified
fieldRequiredstringNot specified
401 Response fields

application/json

FieldType / accepted valuesDescription
detailRequiredRead onlystringNot specified
403 Response fields

application/json

FieldType / accepted valuesDescription
detailRequiredRead onlystringNot specified
429 Rate limit exceeded. Wait for the Retry-After header before retrying.

Use the base URL https://api.norman.finance/api/v1. Sign up or log in to Norman to create an API key, then send it as a Bearer token. For an OpenAPI JSON file, contact support.