Company Address API

Manage company addresses (billing address, registered office, branch offices)

Base URL

https://{tenant}.logzi.com/api/company_address/

Every request returns a JSON response. On success result.code == 1, on error result.code == 0.

GET /api/company_address/get

Retrieve a single address by identifier, optionally in a given language.

Query parameters

ParameterTypeRequiredDescription
idintUnique identifier of the address
language_idintLanguage identifier (for localization)

Example request

GET /api/company_address/get?id=5
X-API-KEY: {your_api_key}
GET /api/company_address/list

Paginated list of a company's addresses, optionally filtered by company identifier.

Query parameters

ParameterTypeRequiredDescription
list_offsetintPagination offset (default: 0)
list_condition[company_id]intFilter by company identifier
language_idintLanguage identifier (for localization)

Example request

GET /api/company_address/list?list_offset=0&list_condition[company_id]=1
X-API-KEY: {your_api_key}
POST /api/company_address/save

Create or update an address. For a new address use data[id] = 0.

POST fields — data object

FieldTypeRequiredDescription
idint0 = new address, >0 = update
company_idintIdentifier of the company the address belongs to
namestringAddress name (e.g. Registered office, Warehouse)
zipstringPostal code
citystringCity
addressstringStreet and house number
country_idintCountry identifier

Example request

POST /api/company_address/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "name": "Székhely",
    "zip": "1234",
    "city": "Budapest",
    "address": "Fő utca 1.",
    "country_id": 1
  }
}
POST /api/company_address/delete

Delete an address by identifier.

POST fields — data object

FieldTypeRequiredDescription
idintIdentifier of the address to delete

Example request

POST /api/company_address/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{ "data": { "id": 5 } }

Get in touch with us

Interested in our software? Feel free to write to us!

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!