Agency
The Agency endpoint provides access to information about your real estate agency's account within Forms Live. This endpoint allows you to retrieve agency details. On this page, we'll explore how to interact with this endpoint programmatically.
The agency model
The agency model contains all the information about your real estate agency, including contact details, subscription status, and credit balance.
Properties
- Name
id- Type
- integer
- Description
Unique identifier for the agency.
- Name
name- Type
- string
- Description
Name of the agency.
- Name
address- Type
- string
- Description
Address, line 1, of the agency.
- Name
address2- Type
- string
- Description
Address, line 2, of the agency.
- Name
suburb- Type
- string
- Description
Suburb of the agency.
- Name
state- Type
- string
- Description
State of the agency.
- Name
postcode- Type
- string
- Description
Postcode of the agency.
- Name
phone- Type
- string
- Description
Phone number of the agency.
- Name
fax- Type
- string
- Description
Fax number of the agency.
- Name
email- Type
- string
- Description
Email address of the agency.
- Name
credits- Type
- integer
- Description
Number of credits the agency has available.
- Name
active- Type
- boolean
- Description
Indicates if the agency is active.
- Name
approved- Type
- boolean
- Description
Indicates if the agency is approved.
- Name
member_number- Type
- string
- Description
Unique membership identifier for the agency.
- Name
licencee_name- Type
- string
- Description
Licencee name of the agency.
- Name
licencee_number- Type
- string
- Description
Licencee number of the agency.
- Name
gst- Type
- boolean
- Description
Indicates if the agency uses GST.
- Name
abn- Type
- string
- Description
Australian Business Number of the agency.
- Name
logo- Type
- string
- Description
Identifier for the agency's logo.
- Name
created- Type
- timestamp
- Description
Timestamp of when the agency was created.
- Name
updated- Type
- timestamp
- Description
Timestamp of when the agency was last updated.
- Name
active_subscription- Type
- boolean
- Description
Indicates if the agency has an active subscription.
- Name
subscription_expiry- Type
- timestamp
- Description
Timestamp of when the agency's subscription will expire. Null if no active subscription exists.
- Name
subscription_type- Type
- string
- Description
Type of subscription the agency has: "ALL" (All Forms), "FM" (Property Management Forms), or "SA" (Sales Forms).
Get agency information
This endpoint allows you to retrieve detailed information about your agency, including contact details, subscription status, and available credits.
Request
curl https://app-api.reiformslive.com.au/agency \
--request GET \
--header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ=="
Response
{
"id": 1,
"name": "Example Agency",
"address": "123 Example Ave",
"address2": "",
"suburb": "Adelaide",
"state": "SA",
"postcode": "5000",
"phone": "00 0000 0000",
"fax": "",
"email": "ExampleAgency@example.com",
"credits": 15895,
"active": true,
"approved": true,
"member_number": "4830484",
"licencee_name": "Example Agency Realty Ltd Pty",
"licencee_number": "000000",
"gst": true,
"abn": "00 0000 0000",
"logo": "8c42e4a4-4e2c-4288-b86a-2247bd47ba59",
"created": 1347418493,
"updated": 1354661735,
"active_subscription": true,
"subscription_expiry": 1385557200,
"subscription_type": "ALL"
}