zydronium/internetee-registry
1
0
Fork 0
mirror of https://github.com/internetee/registry.git synced 2025-08-03 16:32:04 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update API documentation

Browse source
This commit is contained in:
Alex Sherman 2020-10-14 11:31:17 +05:00
parent c43ae63521
commit c59211239d
1 changed files with 34 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

34
doc/registrant-api/v1/companies.md Normal file
View file

@ -0,0 +1,34 @@
## GET /api/v1/registrant/companies
Returns list of companies registered in business register for the current registrant.
#### Parameters
| Field name | Required | Type | Allowed values | Description |
| ---------- | -------- | ---- | -------------- | ----------- |
| limit | false | Integer | [1..200] | How many companies to show |
| offset | false | Integer | | Company number to start at |
#### Request
```
GET /api/v1/registrant/companies?limit=1 HTTP/1.1
Accept: application/json
Authorization: Bearer Z2l0bGFiOmdoeXQ5ZTRmdQ==
Content-Type: application/json
```
#### Response
```
HTTP/1.1 200
Content-Type: application/json
{
"companies":[
{
"name":"ACME Ltd",
"registry_no":"37605030299",
"country_code":"EE"
}
]
}
```