Fixflo in chat
Connect Fixflo once for the organisation, then ask Centrus about issues, properties and people, or ask it to push an update once you have confirmed the change.
Checked against the app on
What it does
Fixflo connects Centrus chat to your organisation's Fixflo account. Once it is set up, you can ask about issues, properties, landlords, tenants and contractors in an ordinary chat, and Centrus looks the answer up in Fixflo while you wait. It can also push an update when you ask, such as a comment on an issue or a change to a property, and it asks you to confirm before it writes.
Connect and manage external services
Configure your organisation's GoHighLevel connection. Other users can then Enable it for chat.
- Find a contact and see pipeline stages
- Check free slots and appointments
- Read a conversation
- Notes and tasks on a contact
Connect a Freshdesk account so chat and automations can read tickets and reply.
- An administrator pastes the Freshdesk subdomain and an agent API key from Profile settings.
- Each user then Enables. Connecting chat does not connect Agent Builder.
Connect a Fixflo account so chat and automations can read issues and push updates.
- An administrator pastes the Fixflo subdomain and the 64-character API token. The email address is not used.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can read issues, properties, and people, and can push updates such as comments, landlords, and properties. Long lists come back one page at a time.
Connect a Cin7 Core account so chat can read products, stock, customers, sales, and purchases.
- An administrator pastes the Cin7 Core Account ID and Application Key from the Cin7 Core API page.
- Each person then Enables. Connecting chat does not connect Agent Builder.
Connect your organisation's Xero account. Other users can then Enable it for chat.
- List and look up sales invoices and bills
- Find contacts, accounts and tax rates
- Create invoices and repeating templates
Connect WhatsApp so people can message Centrus.
- Reply to WhatsApp messages in chat
- 1Integrations, in the menu on the left.
- 2The Fixflo card. It reads Not Connected until you have your own connection.
- 3Connect, which opens the window for the Fixflo address and the API token.
- 4The three lines on the card. Fixflo has no How to Use button. These lines are the guide.
An administrator connects Fixflo once for the whole organisation, and everyone else then clicks Enable on the same card. The card's own wording says the connection is for chat and automations. Connecting this card connects chat only. Agents connect to Fixflo separately, on their own step: see Fixflo in Agent Builder.
Before you start
- An organisation administrator to connect it. Centrus accepts the token only from an administrator. Until an administrator has connected, other people still see a working Connect button. If they use it, Fixflo is not connected, and they see Only organisation administrators can connect Fixflo.
- The Fixflo address and the API token. The address is the subdomain, such as
meridian.fixflo.com, or justmeridian. The token is the 64-character key from the Fixflo account. The window also says the email address is not used. The form does not ask for an email. - The same token for the whole organisation. Everyone who enables Fixflo works through that token, so a change made from chat is made with it, whoever asked for it.
Subdomain
The Fixflo address, such as meridian.fixflo.com, or just meridian.
API token
The 64-character key from the Fixflo account. Centrus stores it encrypted.
The window does not name a screen inside Fixflo for the token. Copy the 64-character key from the Fixflo account, and paste the address exactly as Fixflo shows it, or as the short name in front of .fixflo.com. A full address on any other domain is refused.
Connect Fixflo
- 1Open Integrations from the menu on the left and find the Fixflo card. It sits with Freshdesk and Cin7 Core.
- 2Click Connect. The Connect Fixflo window opens. Anyone can open it. Only an administrator can finish.
- 3Enter Subdomain and API token. Both are required. The token is hidden as you type. Click the eye to check it.
- 4Click Connect.
Request a custom integration tailored to your specific needs. Our team will work with you to create a bespoke solution.
We can build custom integrations for:
- Third-party services and platforms
- In-house systems and databases
- Workflow automation tools
Connect a Fixflo account so chat and automations can read issues and push updates.
- An administrator pastes the Fixflo subdomain and the 64-character API token. The email address is not used.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can read issues, properties, and people, and can push updates such as comments, landlords, and properties. Long lists come back one page at a time.
Connect a Cin7 Core account so chat can read products, stock, customers, sales, and purchases.
- An administrator pastes the Cin7 Core Account ID and Application Key from the Cin7 Core API page.
Paste the Fixflo address, for example acme.fixflo.com, or just acme. The API token is the 64-character key. The email address is not used.
*Subdomain
meridian.fixflo.com*API token
••••••••••••••••••••••- 1Subdomain, the Fixflo address or the short name.
- 2API token, hidden as you type. Click the eye to check it.
- 3Connect, which checks the details with Fixflo before saving them.
Before anything is saved, Centrus uses the address and the token to read the agency settings from https:/. meridian.fixflo.com and meridian are the same account. Only if Fixflo accepts them is the connection saved, with the token encrypted. You then see Successfully connected to Fixflo, and the card changes to Connected, with the line Connected as meridian. The name is the subdomain, without .fixflo.com.
Request a custom integration tailored to your specific needs. Our team will work with you to create a bespoke solution.
We can build custom integrations for:
- Third-party services and platforms
- In-house systems and databases
- Workflow automation tools
Connect a Fixflo account so chat and automations can read issues and push updates.
- An administrator pastes the Fixflo subdomain and the 64-character API token. The email address is not used.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can read issues, properties, and people, and can push updates such as comments, landlords, and properties. Long lists come back one page at a time.
Connect a Cin7 Core account so chat can read products, stock, customers, sales, and purchases.
- An administrator pastes the Cin7 Core Account ID and Application Key from the Cin7 Core API page.
Paste the Fixflo address, for example acme.fixflo.com, or just acme. The API token is the 64-character key. The email address is not used.
*Subdomain
meridian.fixflo.com*API token
••••••••••••••••••••••If anything is wrong, the window stays open so you can correct it. The refusal appears as a notice at the top of the page, not inside the window. The messages you may see are:
- Could not verify Fixflo credentials, followed by what Fixflo returned, at the top of the page: Fixflo did not accept the address or the token. A 401 means the token was refused. Check it for a missing character or a stray space. The same notice also states the token's length, and the position of any character that is not a letter or a number.
- Use the Fixflo subdomain, for example acme or acme.fixflo.com, inside that same notice: the address is not a Fixflo address. Paste the subdomain, not a different website.
- The Fixflo subdomain may contain only letters, numbers, hyphens, and dots, inside that same notice: the address has a character Fixflo addresses do not use.
- Enter the subdomain or Enter the API token, under a box: that box is empty. These stay in the window and are not repeated at the top of the page.
- Fixflo subdomain and API token are required, at the top of the page: the same gap, if the window's own check was skipped.
- Only organisation administrators can connect Fixflo, at the top of the page: your account is not an administrator. The Connect button still opened the window. Ask an administrator to connect.
- Failed to connect to Fixflo, at the top of the page: the request did not complete, and Centrus has no more specific message.
Enable it for everyone else
Once an administrator has connected, everyone else sees An administrator has connected Fixflo. Enable it for your account. on the card, and Connect becomes Enable. The card does not name the administrator. Clicking Enable copies the organisation's connection to your own account, so you never need the token yourself. You see Fixflo is ready for your account, and the card shows Connected with Connected as and the subdomain.
Connect a Fixflo account so chat and automations can read issues and push updates.
- An administrator pastes the Fixflo subdomain and the 64-character API token. The email address is not used.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can read issues, properties, and people, and can push updates such as comments, landlords, and properties. Long lists come back one page at a time.
An administrator has connected Fixflo. Enable it for your account.
- An administrator pastes the Fixflo subdomain and the 64-character API token. The email address is not used.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can read issues, properties, and people, and can push updates such as comments, landlords, and properties. Long lists come back one page at a time.
Connected as meridian.
- An administrator pastes the Fixflo subdomain and the 64-character API token. The email address is not used.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can read issues, properties, and people, and can push updates such as comments, landlords, and properties. Long lists come back one page at a time.
A second administrator does not see Enable. The sentence on the card still says to enable it, but the button stays Connect, so they paste the address and the token again. Their connection is saved as the organisation's connection. People who have already enabled keep the copy they have.
Integrations works the same way in a phone browser, with the cards in a single column. Scroll down to Fixflo and tap Enable. Each person enables once, and Fixflo is then available to them in every chat. If you are already enabled, Enable is not shown. If a copy is already on your account and the request is repeated, you see Already connected to Fixflo.
Centrus
Connect and manage external services
Connect a Freshdesk account so chat and automations can read tickets and reply.
- An administrator pastes the Freshdesk subdomain and an agent API key from Profile settings.
- Each user then Enables. Connecting chat does not connect Agent Builder.
An administrator has connected Fixflo. Enable it for your account.
- An administrator pastes the Fixflo subdomain and the 64-character API token. The email address is not used.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can read issues, properties, and people, and can push updates such as comments, landlords, and properties. Long lists come back one page at a time.
Connect a Cin7 Core account so chat can read products, stock, customers, sales, and purchases.
- An administrator pastes the Cin7 Core Account ID and Application Key from the Cin7 Core API page.
Ask your first questions
Open Chat, start a chat and ask the way you would ask a colleague in the office. Fixflo is available in every chat once you have enabled it, whichever tag you choose. There is no How to Use window. The three lines on the card are the guide: an administrator pastes the subdomain and the token, each person then enables, and chat can read issues, properties and people and can push updates such as comments, landlords and properties. Long lists come back one page at a time.
Connect a Fixflo account so chat and automations can read issues and push updates.
- An administrator pastes the Fixflo subdomain and the 64-character API token. The email address is not used.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can read issues, properties, and people, and can push updates such as comments, landlords, and properties. Long lists come back one page at a time.
- “Which issues at Riverside House are still reported?”
- “Open issue 48291.”
- “Who is the tenant at Riverside House, Flat 2?”
- “What quotes are on issue 48291?”
John Martin
last message sent: less than a minute ago
Which issues at Riverside House are still reported?
2 issues at Riverside House are still Reported, as of Friday 09/10/2026:
| Issue | Title | Where | Updated |
|---|---|---|---|
| 48291 | Leak under the kitchen sink | Flat 2 | 08/10/2026 16:40 |
| 48304 | No heating in the bedroom | Flat 6 | 07/10/2026 09:15 |
Issue 48291 was updated yesterday afternoon. The tenant at Flat 2 is Priya Shah.
While Centrus works, the panel above the answer names each look-up as it happens, such as Listing issues in Fixflo or Getting an issue from Fixflo. A list of issues comes back as addresses, not the full issue, so Centrus then opens the ones it needs. When the answer is ready, the panel folds to Worked with the number of steps. Open it to see exactly what Centrus looked up in Fixflo before it answered.
Carry on in the same chat, with questions like “Who is the tenant on that one?” or “Add a comment to 48291”, and Centrus keeps track of the issue or property you were talking about.
What you can ask
Centrus has 165 Fixflo tools in chat, and picks the right ones from what you ask, so you never choose them yourself. Every tool is listed in the reference. 88 of them read from Fixflo and 77 change it.
Issues
“Which issues at Riverside House are still reported?”
“Open issue 48291.”
Properties
“Find the property at 12 High Street.”
“What issues are open at Riverside House?”
People
“Who is the tenant at Riverside House, Flat 2?”
“List the landlords for Northgate Housing.”
Contractors and jobs
“Who is the contractor on issue 48291?”
“Set an appointment on issue 48291 for Monday at 08:00.”
Quotes and invoices
“What quotes are on issue 48291?”
“Show the invoice details on issue 48291.”
Certificates and servicing
“Which certificates are on Riverside House?”
“List the service programmes at Riverside House.”
Blocks and estates
“List the blocks.”
“What is the brand on Riverside House?”
Agencies and teams
“Show our agency settings.”
“List the teams.”
- Issues. List issues, including those that are job awarded, job completed or closed, and open one issue in full. Read the report, the quotes, the tags and the comments. Centrus can change the assigned agent, set an external reference, merge issues, and add a comment. A list of issues is a set of addresses. Ask Centrus to open the issue if you need the detail. Statuses you can name are Reported, QuotesRequested, QuotesAwaitingReview, QuotesReviewed, JobAwarded, AwaitingJobCompletion, JobCompleted and Closed.
- Issue drafts. Read a draft, its media and its assets, save a draft, commit it so it becomes a reported issue, or delete the draft. Committing and deleting are changes, and Centrus asks you first.
- Properties. Search properties and addresses, open one property, and list the issues, tenants, notes, tags and addresses on it. Centrus can save a property, set a new primary address (the previous address is kept as an alternative), merge or split an address, replace tags, add or delete notes, and set the brand.
- Certificates and media. Search certificate media, open one record, and update the expiry, the start date or the short description. A download describes the file. It does not bring the file into the chat.
- Landlords, leaseholders and tenants. List and open each of them, see which properties they are linked to, and create or update the person or the link. Centrus can remove a link. It can also anonymise a tenant, which cannot be undone.
- Contractors, jobs, quotes and invoices. List contractors and their services, assign a contractor to an issue, read and save job completion, and add or remove completion documents and certificates. Read or save invoice details and submit the invoice. Add or amend a quote, decline to quote, decline the job, set or cancel an appointment, raise further works, or quote instead of doing the instructed job.
- Blocks, estates, assets, brands, cost codes and teams. List and open them, and create or update a record. Walk the fault tree from a node when you are describing a fault. Read one job.
- Agencies and agents. List agencies and agents, open one, read the agency settings, and create or update an agency or an agent. The agency settings are also what Centrus reads when an administrator connects.
- Service programmes and warranties. List programmes, definitions and service events, create or complete an event, and add, update or delete a warranty. A remedial issue can be raised from a service event.
Some questions Fixflo can answer from one list, such as issues in a named status, or properties matching an address. Others need more work. A list of issues does not include the title or the description, so a question such as which reported issues mention a leak means Centrus fetches the addresses, opens each issue, and keeps the ones that match. Say the property and the status, so that Centrus does not open more issues than it needs.
John Martin
last message sent: less than a minute ago
Which reported issues at Riverside House mention a leak?
1 reported issue at Riverside House mentions a leak. The list from Fixflo is a set of issue addresses, so each one was opened:
| Issue | Title | Where | Updated |
|---|---|---|---|
| 48291 | Leak under the kitchen sink | Flat 2 | 08/10/2026 16:40 |
Issue 48304, no heating in Flat 6, is also reported, and it does not mention a leak. Shall I draft a comment for 48291?
Making changes
77 of the 165 tools change data in Fixflo: they create, update, assign, merge, submit, decline or delete. Each change shows as its own step in the panel above the answer, such as Adding a comment in Fixflo, and only after you have agreed to it.
Centrus is told that the connected Fixflo tools can read issues, properties, landlords, tenants and contractors and, after you confirm, push updates such as comments, saves and quotes. It should not treat Fixflo as read only. There is no separate approval screen. Centrus restates the change and waits. Nothing is written until you agree. Name the issue, property or person, give the values you want, and check the result in Fixflo.
John Martin
last message sent: less than a minute ago
Add a comment to issue 48291: tenant out until 14:00, card left.
Issue 48291 is the leak under the kitchen sink at Riverside House, Flat 2. I have not added the comment. Shall I add this to the issue?
Tenant out until 14:00, card left.
Some changes cannot be taken back from chat:
- Anonymising a tenant removes their details in Fixflo. The tool says this cannot be undone. Centrus cannot restore the tenant.
- Deleting a draft, a property note, a warranty, a completion document or a completion certificate removes it. There is no tool that brings it back.
- Removing a link between a landlord, a leaseholder or a tenant and a property deletes that link. You can ask Centrus to create the link again. The deleted one is not restored.
- Merging issues closes the source issues and creates the merged issue. Chat cannot reopen the sources.
- Submitting an invoice, declining a job and declining to quote are sent to Fixflo as those actions. Change them in Fixflo, where Fixflo allows it.
- Setting a new primary address keeps the previous address as an alternative. It does not delete it.
There is no Fixflo tool that applies one change to every row of a list. Each comment, save or quote is one record. If you name two issues in the same message, Centrus still treats them as two changes, and it asks before it writes either of them. A long list you asked for earlier in the chat stays available for 24 hours, so you can say “that issue” or ask for the next page, and then ask for the change on the record you mean.
John Martin
last message sent: 1 minute ago
Add that same comment to the other reported issue at Riverside House as well.
The other reported issue is 48304, no heating in Flat 6. That would be a separate change from 48291. I have not written either comment. Shall I add “Tenant out until 14:00, card left.” to 48304?
Who can use Fixflo in chat
Fixflo has no tool list in Settings, and editing a team does not include Fixflo tools. The Integrations overview describes the tool screens used by BigChange REST and Simpro. Those screens do not appear for Fixflo. Anyone who has clicked Enable, and the administrator who connected, can use all 165 tools.
Connect a Fixflo account so chat and automations can read issues and push updates.
- An administrator pastes the Fixflo subdomain and the 64-character API token. The email address is not used.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can read issues, properties, and people, and can push updates such as comments, landlords, and properties. Long lists come back one page at a time.
An administrator has connected Fixflo. Enable it for your account.
- An administrator pastes the Fixflo subdomain and the 64-character API token. The email address is not used.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can read issues, properties, and people, and can push updates such as comments, landlords, and properties. Long lists come back one page at a time.
- 1The Settings tabs. Fixflo is not among them.
- 2Connect, shown to an organisation administrator, and also shown to everyone else until an administrator has connected.
- 3Enable, which turns on every Fixflo tool for that person. The card does not name who connected.
What each person can change in Fixflo is decided by the token the administrator pasted, not by a tick against their name in Centrus. The three lines on the card are the same for everyone. The control on a write is the question in the chat: Centrus restates the comment, save or quote and waits. Once you confirm, the step appears, such as Adding a comment in Fixflo.
John Martin
last message sent: less than a minute ago
Yes, add it.
Done. The comment is on issue 48291 at Riverside House, Flat 2: tenant out until 14:00, card left.
Limits
- Long lists. 24 lists, including issues, properties, landlords, tenants, contractors, agents, blocks and service programmes, are fetched as up to 50 pages and kept up to 5,000 rows on the chat. The answer is given the first 100. Ask for the next page in the same chat. The saved list lasts 24 hours, and it belongs to that chat and that person. After that, or in a new chat, Centrus asks Fixflo again. A follow-on page whose saved list has expired comes back empty.
- Page size. Centrus sends a page size only for brands, property search and the comments on one issue. Every other list uses Fixflo's own page size. Closed issues are not split into pages: that list is a single response.
- Shorter lists. Comments, draft media, addresses on one property and the other lists that are not in those 24 come back one page at a time. Centrus can ask for further pages, up to 200.
- Issue lists are addresses. List issues, and the job-awarded, job-completed and closed lists, return addresses. Centrus opens an issue to read the title, the description and the people on it. Property issues are summaries, not addresses.
- Files. An issue report, a draft file and a media download describe the file (its type and its size). The file itself does not come back into the chat. Open it in Fixflo.
- One record at a time. Changes are not applied to a whole list in one step. See Making changes.
- When Fixflo is busy. If Fixflo returns 429, Centrus waits for the time Fixflo asks, up to 30 seconds, and tries once more. If it is still busy, the answer includes Fixflo returned 429.
- One account. The card holds one Fixflo subdomain. Connected as meridian means that subdomain, not a person's name.
John Martin
last message sent: less than a minute ago
Which reported issues at Riverside House mention a leak?
The Working line names the look-up while Centrus is fetching it. It does not count pages or rows while it runs, even when Fixflo is returning several pages inside that one step. When the answer is ready, the line folds into Worked.
Disconnect
Disconnect on the card removes your own connection only. It happens straight away, without asking you to confirm, and you see Integration disconnected. If someone else's connection is still there to copy, the card goes back to Enable for anyone who is not an administrator, with the sentence An administrator has connected Fixflo. Enable it for your account. An administrator sees Connect again, even while that sentence is showing.
Connected as meridian.
- An administrator pastes the Fixflo subdomain and the 64-character API token. The email address is not used.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can read issues, properties, and people, and can push updates such as comments, landlords, and properties. Long lists come back one page at a time.
An administrator has connected Fixflo. Enable it for your account.
- An administrator pastes the Fixflo subdomain and the 64-character API token. The email address is not used.
- Each user then Enables. Connecting chat does not connect Agent Builder.
- The assistant can read issues, properties, and people, and can push updates such as comments, landlords, and properties. Long lists come back one page at a time.
- 1Disconnect, which removes your own connection without asking you to confirm.
- 2Enable, to turn Fixflo back on from a connection that is still in the organisation.
When an administrator disconnects, only the administrator's own connection goes. Everyone who has already enabled Fixflo keeps working, because each person holds their own copy. Someone who has not enabled can still enable from one of those copies. The card still does not say whose copy that is.
To stop all access from Centrus at once, withdraw or change the token in Fixflo, and every copy stops working. Copies do not pick up a new token by themselves, so once a new token is issued, an administrator connects again and everyone else clicks Disconnect, then Enable.
Troubleshooting
- Centrus answers as though Fixflo is not connected. Check that the card says Connected for you, and click Enable if it shows the sentence about an administrator having connected. If you are not an administrator and the button is still Connect, nobody has connected yet. Ask an administrator to connect. Clicking Connect yourself opens the window, and then you see Only organisation administrators can connect Fixflo.
- No Fixflo connection found. Please ask your administrator to connect first. You clicked Enable, but no connection is left in the organisation to copy. Ask an administrator to connect.
- Fixflo returned 401, in the answer. Fixflo no longer accepts the token, usually because it was changed or withdrawn. The notice can also include the token's length. The administrator connects again with the current token, then everyone else clicks Disconnect and Enable.
- Stored Fixflo credentials are incomplete. Please reconnect. Your copy is missing the address or the token. Click Disconnect, then Enable, to take a fresh copy. If you are the administrator, click Connect and paste the details again.
- Fixflo returned 429. Fixflo was busy, and the one retry did not get through. Ask again in a minute.
- Could not verify Fixflo credentials while connecting. The address or the token was refused, or the address is not a Fixflo subdomain. The window stays open. Correct the box and click Connect again.
- The answer describes a file but you cannot open it. Issue reports and media downloads do not come back as files. Open them in Fixflo.
- A list of issues has titles missing. The list is addresses. Ask Centrus to open the issue, or ask a follow-up in the same chat.
- The answer stops part way through a long list. Ask Centrus to carry on. The saved list lasts 24 hours. After that, ask for the list again.
John Martin
last message sent: less than a minute ago
Which issues at Riverside House are still reported?
I couldn't get the issues. Fixflo refused the token with Fixflo returned 401, which usually means the API token was changed or withdrawn in Fixflo. Ask your administrator to reconnect Fixflo on the Integrations page.
Tools and endpoints reference
There are 165 Fixflo tools in chat: 88 read from Fixflo and 77 change data. The names below are the labels Centrus uses for the same actions. Every tool calls Fixflo at https:/, and the path in the table starts at /. Where a path contains {Id} or another name in braces, Centrus fills it from the issue, property or person you named. A tool that changes data still waits until you confirm, as described above.
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| List agencies | Lists agencies, one page at a time. | Reads | GET / |
| Get agency | Reads one agency. | Reads | GET / |
| Create agency | Creates an agency. | Changes | POST / |
| Set up agency templates | Sets up the agency's integration templates. The call changes the agency. | Changes | GET / |
| Get agency settings | Reads the agency settings. Centrus also uses this to check the token when an administrator connects. | Reads | GET / |
| Save agent | Creates or updates an agent. | Changes | POST / |
| Get agent | Looks up an agent by email, external ref, or id. | Reads | GET / |
| Update agent brand | Sets the brand on an agent. | Changes | POST / |
| List agents | Lists agents, one page at a time. | Reads | GET / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| Search assets | Searches assets. | Reads | GET / |
| Create asset | Creates an asset. | Changes | POST / |
| Get asset | Reads one asset. | Reads | GET / |
| Update asset | Updates an asset. | Changes | PUT / |
| Get block | Reads one block by id or external ref. | Reads | GET / |
| Save block | Creates or updates a block. | Changes | POST / |
| List blocks | Lists blocks, one page at a time. | Reads | GET / |
| Get block tags | Reads the tags on one block. | Reads | GET / |
| Set block tags | Replaces the tags on a block. | Changes | POST / |
| Get block brand | Reads the brand on one block. | Reads | GET / |
| Set block brand | Sets the brand on a block. | Changes | POST / |
| Get brand | Reads one brand. | Reads | GET / |
| List brands | Lists brands, one page at a time. | Reads | GET / |
| Get cost code | Reads one cost code. | Reads | GET / |
| Save cost code | Creates or updates a cost code. | Changes | POST / |
| List cost codes | Lists cost codes, one page at a time. | Reads | GET / |
| Get estate | Reads one estate. | Reads | GET / |
| Save estate | Creates or updates an estate. | Changes | POST / |
| List estates | Lists estates, one page at a time. | Reads | GET / |
| Walk fault tree | Reads the fault tree branches from a node. | Reads | GET / |
| Get job | Reads one job. | Reads | GET / |
| Get team | Reads one team. | Reads | GET / |
| Save team | Creates or updates a team. | Changes | POST / |
| List teams | Lists teams, one page at a time. | Reads | GET / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| Get issue | Reads one issue in full. A list of issues does not include this detail. | Reads | GET / |
| Update assigned agent | Changes the agent assigned to an issue. Clearing it unassigns the agent. | Changes | POST / |
| Set issue external ref | Replaces the issue's external reference. It has to be unique for the agency. | Changes | POST / |
| List issues | Lists issues as addresses, not the full issue. You can filter by status: Reported, QuotesRequested, QuotesAwaitingReview, QuotesReviewed, JobAwarded, AwaitingJobCompletion, JobCompleted or Closed. | Reads | GET / |
| Get issue report | Asks for the issue report. The result describes the file. It does not include the file itself. | Reads | GET / |
| List job-awarded issues | Lists issue addresses whose status is JobAwarded. | Reads | GET / |
| List job-completed issues | Lists issue addresses whose status is JobCompleted. | Reads | GET / |
| List closed issues | Lists closed issues as addresses. This list is not split into pages. | Reads | GET / |
| Get issue quotes | Reads the quotes on one issue. | Reads | GET / |
| Get issue tags | Reads the tags on one issue. | Reads | GET / |
| Merge issues | Closes the source issues and creates the merged issue. | Changes | POST / |
| List issue comments | Lists the comments on one issue. | Reads | GET / |
| Add issue comment | Adds a comment to an issue. | Changes | POST / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| Save issue draft | Creates or updates a draft issue before it is committed. | Changes | POST / |
| Get issue draft | Reads one issue draft. | Reads | GET / |
| Commit issue draft | Turn a draft into a live reported issue. | Changes | POST / |
| Delete issue draft | Deletes an issue draft. | Changes | POST / |
| List issue draft media | Lists the media on one draft. | Reads | GET / |
| Get issue draft media | Reads one draft media record. | Reads | GET / |
| Save issue draft media | Creates or updates media on a draft. A file you send is not returned afterwards. | Changes | POST / |
| Download issue draft media | Asks for a draft file. The result describes the file. It does not include the file itself. | Reads | GET / |
| List issue draft assets | Lists the assets on one draft. | Reads | GET / |
| Add issue draft asset | Links an asset to a draft. | Changes | POST / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| Get property | Reads one property by id or ExternalPropertyRef. | Reads | GET / |
| Save property | Creates or updates a property. This does not change the address. | Changes | POST / |
| Update property address | Sets a new primary address. The previous address is kept as an alternative. | Changes | POST / |
| Search properties | Searches properties. | Reads | GET / |
| Search property addresses | Searches property addresses. | Reads | GET / |
| Get property address | Reads one property address. | Reads | GET / |
| Merge property address | Merge an address into a property. | Changes | POST / |
| Split property address | Split an address out of a property. | Changes | POST / |
| List property addresses | Addresses on one property. | Reads | GET / |
| List property issues | Lists issue summaries at one property, rather than addresses only. | Reads | GET / |
| List property issues by external ref | Issues for ExternalPropertyRef. | Reads | GET / |
| Get property tags | Reads the tags on one property. | Reads | GET / |
| Set property tags | Replaces the tags on a property. | Changes | POST / |
| Get property notes | Reads the notes on one property. | Reads | GET / |
| Add property notes | Adds notes on a property. Existing notes are left as they are. | Changes | POST / |
| Delete property notes | Deletes notes on a property. | Changes | DELETE / |
| List property tenants | Lists the tenants at one property. | Reads | GET / |
| List landlord links for a property | Lists the landlord links on one property. | Reads | GET / |
| Update property brand | Sets the brand on a property. | Changes | POST / |
| Search certificate media | Searches certificate media on properties. | Reads | GET / |
| Get certificate media | Reads one property-certificate media record. | Reads | GET / |
| Update certificate media | Updates the expiry, the start date or the short description. | Changes | POST / |
| Download media | Asks for a media file. The result describes the file. It does not include the file itself. | Reads | GET / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| Get landlord | Reads one landlord. | Reads | GET / |
| Save landlord | Creates or updates a landlord. | Changes | POST / |
| Get landlord brand | Reads the brand on one landlord. | Reads | GET / |
| Set landlord brand | Sets the brand on a landlord. | Changes | POST / |
| List landlords | Lists landlords, one page at a time. | Reads | GET / |
| Get landlord property | Reads one landlord-property link. | Reads | GET / |
| Save landlord property | Creates or updates a link between a landlord and a property. | Changes | POST / |
| Delete landlord property | Removes a link between a landlord and a property. | Changes | POST / |
| Get landlord property join | Reads one landlord and property join that uses external references. | Reads | GET / |
| Save landlord property join | Creates or updates a landlord and property link using external references. | Changes | POST / |
| Delete landlord property join | Removes a landlord and property link that uses external references. | Changes | POST / |
| List landlord properties | Lists the property links for one landlord. | Reads | GET / |
| Get leaseholder | Reads one leaseholder. | Reads | GET / |
| Save leaseholder | Creates or updates a leaseholder. | Changes | POST / |
| List leaseholders | Lists leaseholders, one page at a time. | Reads | GET / |
| Get leaseholder brand | Reads the brand on one leaseholder. | Reads | GET / |
| Set leaseholder brand | Sets the brand on a leaseholder. | Changes | POST / |
| Get leaseholder property | Reads one leaseholder-property link. | Reads | GET / |
| List leaseholder properties | Lists the property links for one leaseholder. | Reads | GET / |
| Delete leaseholder property | Removes a link between a leaseholder and a property. | Changes | POST / |
| Get leaseholder property join | Reads one leaseholder and property join that uses external references. | Reads | GET / |
| Save leaseholder property join | Creates or updates a leaseholder and property link using external references. | Changes | POST / |
| Delete leaseholder property join | Removes a leaseholder and property link that uses external references. | Changes | POST / |
| Search leaseholder property joins | Finds the leaseholders linked to a property. | Reads | GET / |
| Get tenant | Reads one tenant. | Reads | GET / |
| Save tenant | Creates or updates a tenant. | Changes | POST / |
| Set tenant brand | Sets the brand on a tenant. | Changes | POST / |
| List tenants | Lists tenants, one page at a time. | Reads | GET / |
| List tenant properties | Properties for one tenant. | Reads | GET / |
| Get tenant property | Reads one tenant-property link. | Reads | GET / |
| Link tenant property | Links a property to a tenant. | Changes | POST / |
| Unlink tenant property | Removes a link between a tenant and a property. | Changes | DELETE / |
| Anonymise tenant | Anonymises a tenant. This cannot be undone. | Changes | POST / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| Get contractor | Reads one contractor. | Reads | GET / |
| Save contractor | Creates a contractor, or updates one when you name it. | Changes | POST / |
| Set contractor brand | Sets the brand on a contractor. | Changes | POST / |
| List contractors | Lists contractors, one page at a time. | Reads | GET / |
| List contractor services | Contractor service catalogue. | Reads | GET / |
| Assign contractor | Assigns a contractor to an issue. | Changes | POST / |
| Get job completion | Reads the completion details on an issue. | Reads | GET / |
| Save job completion | Saves the job completion details. | Changes | POST / |
| Add completion document | Adds a completion document. | Changes | POST / |
| Get completion document | Reads one completion document. | Reads | GET / |
| Save completion document | Update a completion document. | Changes | POST / |
| Delete completion document | Deletes a completion document. | Changes | DELETE / |
| List completion documents | Lists the completion documents on an issue. | Reads | GET / |
| Add completion certificate | Adds a completion certificate. | Changes | POST / |
| Get completion certificate | Reads one completion certificate. | Reads | GET / |
| Delete completion certificate | Deletes a completion certificate. | Changes | DELETE / |
| Get invoice details | Reads the invoice details on an issue. | Reads | GET / |
| Save invoice details | Saves the invoice figures. | Changes | POST / |
| Submit invoice | Submit the invoice on an issue. | Changes | POST / |
| Add quote | Adds a quote to an issue. | Changes | POST / |
| Amend quote | Amend a quote. | Changes | POST / |
| Decline to quote | Declines to quote on an issue. | Changes | POST / |
| Decline job | Declines the job. | Changes | POST / |
| Set appointment | Sets an appointment on the accepted job. | Changes | POST / |
| Cancel appointment | Cancels an appointment. | Changes | PUT / |
| Create further works | Creates a linked further-works issue. | Changes | POST / |
| Quote further works | Creates a linked further-works issue, with a quote. | Changes | POST / |
| Quote instead | Declines the instruction and sends a quote instead. | Changes | POST / |
| Add contractor comment | Adds a comment on the contractor network. | Changes | POST / |
| List customers | Lists users on the agency. | Reads | GET / |
| Get customer | Reads one customer. | Reads | GET / |
| Create remedial | Creates a linked remedial issue from a service event. | Changes | POST / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| Add warranty | Creates a warranty. | Changes | POST / |
| Save warranty | Update a warranty. | Changes | POST / |
| Delete warranty | Deletes a warranty. | Changes | POST / |
| Get service programme | Reads one service programme. | Reads | GET / |
| List service programmes | Lists service programmes, one page at a time. | Reads | GET / |
| List property service programmes | Lists the service programmes on one property. | Reads | GET / |
| Get service programme definition | Reads one service programme definition. | Reads | GET / |
| Save service programme definition | Creates or updates a service programme definition. | Changes | POST / |
| List service programme definitions | Lists definitions, one page at a time. | Reads | GET / |
| Get service event | Reads one service event. | Reads | GET / |
| List service events | Lists service events, one page at a time. | Reads | GET / |
| List service event media | Lists the media on one service event. | Reads | GET / |
| Create service event | Creates a service event under a property programme. | Changes | POST / |
| List programme service events | Lists the events for one property and programme. | Reads | GET / |
| Get programme service event | Reads one event by property, programme, and event id. | Reads | GET / |
| Update service event | Updates a service event. | Changes | POST / |
| Complete service event | Marks a service event complete. | Changes | POST / |
| Tool | What it does | Reads or changes | Endpoint |
|---|---|---|---|
| List webhooks | Lists webhook subscriptions on the agency. They come back in one list, not in pages. | Reads | GET / |
| List webhook activity | Lists delivery activity for one webhook. You can ask for failed deliveries only. | Reads | GET / |
| Subscribe webhook | Creates a webhook subscription for an address you give it. | Changes | POST / |
| Unsubscribe webhook | Removes a webhook subscription. | Changes | DELETE / |