ImmobiNet
ImmobiNet API Docs - Auth

Retrieve the agencies of the API user

GET
/api/v1/agencies
basic

Returns the agencies in which the API user has a role that grants the webservice privilege, ordered by name, with only the data to recognise them (the rest is in GET /api/v1/agencies/{agencyId}). The agency_id of properties, invoices, transactions and quotes usually refers to one of them, but it can also be an agency in which the API user has no role with the webservice privilege: its detail is then 404. Needs no API key scope.

Retrieve the agencies of the API user › Responses

Agencies of the API user

id
​integer
name
​string | null

Name of the agency.

business_name
​string

Legal name ("ragione sociale").


Retrieve a single agency

GET
/api/v1/agencies/{agencyId}
basic

Returns the agency, if the API user has a role in it that grants the webservice privilege; 404 otherwise, also when the agency exists. Needs no API key scope.

Retrieve a single agency › path Parameters

agencyId
​integer · required

Retrieve a single agency › Responses

Agency found

id
​integer
name
​string | null

Name of the agency.

business_name
​string

Legal name ("ragione sociale").

vat_number
​string | null

VAT number (partita IVA) of the agency. null when empty.

tax_code
​string | null

Tax code (codice fiscale) of the agency. null when empty.

​object

Operating office.

​object

Registered office.

phone
​string | null
mobile
​string | null
email
​string | null
pec
​string | null

Certified email address.

website
​string | null