Skip to main content

API reference

Find an endpoint by resource, method or purpose. Each operation includes its request parameters, response schemas and code samples.

Use the API base URL supplied with your credentials. Access depends on your scopes and data permissions. A documented operation does not automatically grant access to it.

Download OpenAPI Specification ↓

The download comes from the public sample client repository. That file and this reference can update independently; use the endpoint pages below to check the contract documented here.

Find an endpointResourceMethodAvailability

215 of 215 operations

GET/jsonapi/advisersGets a collection of advisers GET/jsonapi/advisers/{id}Gets a single adviser by id GET/jsonapi/advisers/{id}/relationships/contactGroupsGets a contactGroups related to a single adviser GET/jsonapi/adviser-details/{id}/adviserGets adviser via a single related adviser detail GET/jsonapi/adviser-detailsGets a collection of adviser details GET/jsonapi/adviser-details/{id}Gets a single adviser detail by id GET/jsonapi/adviser-details/{id}/relationships/adviserGets a adviser related to a single adviser detail GET/jsonapi/assets/{id}/relationships/addressesGets a addresses related to a single asset GET/jsonapi/asset-categoriesGets a collection of asset categories GET/jsonapi/asset-categories/{id}Gets a single asset category by id GET/jsonapi/assets/{id}/addressesGets addresses via a single related asset GET/jsonapi/assets/{id}/ownershipGets ownerships via a single related asset GET/jsonapi/assetsGets a collection of assets GET/jsonapi/assets/{id}Gets a single asset by id GET/jsonapi/assets/{id}/relationships/ownershipGets a ownerships related to a single asset GET/jsonapi/contact-groups/{id}/referrerGets referrer via a single related contact group GET/jsonapi/asset-sub-typesGets a collection of asset sub-types GET/jsonapi/asset-sub-types/{id}Gets a single asset sub-type by id GET/jsonapi/contact-groups/{id}/referrerOrganisationGets referrerOrganisation via a single related contact group GET/jsonapi/contact-groups/{id}/adviserGets adviser via a single related contact group GET/jsonapi/asset-typesGets a collection of asset types GET/jsonapi/asset-types/{id}Gets a single asset type by id GET/jsonapi/contact-groups/{id}/contactsGets contacts via a single related contact group GET/jsonapi/contact-external-references/{id}/relationships/integrationGets a integration related to a single contact external reference GET/jsonapi/contact-categoriesGets a collection of contact categories POST/jsonapi/contact-categoriesCreates a new contact category with attributes, relationships or both GET/jsonapi/contact-categories/{id}Gets a single contact category by id PATCH/jsonapi/contact-categories/{id}Updates the attributes and/or relationships of an existing contact category. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced DELETE/jsonapi/contact-categories/{id}Deletes an existing contact category GET/jsonapi/contact-external-references/{id}/integrationGets integration via a single related contact external reference GET/jsonapi/contact-external-references/{id}/contactGets contact via a single related contact external reference GET/jsonapi/contact-external-referencesGets a collection of external references of contacts POST/jsonapi/contact-external-referencesCreates a new contact external reference with attributes, relationships or both GET/jsonapi/contact-external-references/{id}Gets a single contact external reference by id PATCH/jsonapi/contact-external-references/{id}Updates the attributes and/or relationships of an existing contact external reference. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced DELETE/jsonapi/contact-external-references/{id}Deletes an existing contact external reference GET/jsonapi/contact-external-references/{id}/relationships/contactGets a contact related to a single contact external reference GET/jsonapi/contact-groups/{id}/businessesGets businesses via a single related contact group PATCH/jsonapi/contact-groups/{id}Updates the attributes and/or relationships of an existing contact group. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced GET/jsonapi/contact-groups/{id}Gets a single contact group by id DELETE/jsonapi/contact-groups/{id}Deletes an existing contact group GET/jsonapi/contact-groupsGets a collection of contact groups GET/jsonapi/contact-groups/{id}/relationships/businessesGets a businesses related to a single contact group GET/jsonapi/contacts/{id}/contactGroupGets contactGroup via a single related contact PATCH/jsonapi/contact-marketing/{id}Updates the marketing consent declaration of an existing contact GET/jsonapi/contact-marketing/{id}Gets the marketing consent declaration of a single contact POST/jsonapi/contactsCreates a new contact with attributes, relationships or both GET/jsonapi/contactsGets a collection of contacts PATCH/jsonapi/contacts/{id}Updates the attributes and/or relationships of an existing contact. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced GET/jsonapi/contacts/{id}Gets a single contact by id DELETE/jsonapi/contacts/{id}Deletes an existing contact GET/jsonapi/contacts/{id}/relationships/contactGroupGets a contactGroup related to a single contact GET/jsonapi/deal-external-references/{id}/relationships/integrationGets a integration related to a single deal external reference GET/jsonapi/custom-statusesGets a collection of custom statuses GET/jsonapi/custom-statuses/{id}Gets a single custom status by id GET/jsonapi/deal-external-references/{id}/integrationGets integration via a single related deal external reference GET/jsonapi/deal-external-references/{id}/dealGets deal via a single related deal external reference GET/jsonapi/deal-external-referencesGets a collection of external references of deals POST/jsonapi/deal-external-referencesCreates a new deal external reference with attributes, relationships or both GET/jsonapi/deal-external-references/{id}Gets a single deal external reference by id PATCH/jsonapi/deal-external-references/{id}Updates the attributes and/or relationships of an existing deal external reference. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced DELETE/jsonapi/deal-external-references/{id}Deletes an existing deal external reference GET/jsonapi/deal-external-references/{id}/relationships/dealGets a deal related to a single deal external reference GET/jsonapi/deal-notes/{id}/dealGets deal via a single related deal note POST/jsonapi/deal-notesCreates a new deal note with attributes, relationships or both PATCH/jsonapi/deal-notes/{id}Updates the attributes and/or relationships of an existing deal note. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced GET/jsonapi/deal-notes/{id}Gets a single deal note by id DELETE/jsonapi/deal-notes/{id}Deletes an existing deal note GET/jsonapi/deal-notes/{id}/relationships/dealGets a deal related to a single deal note GET/jsonapi/deal-participants/{id}/contactGets contact via a single related participants in a deal GET/jsonapi/deal-participantsGets a collection of participants in deals GET/jsonapi/deal-participants/{id}Gets a single participants in a deal by id GET/jsonapi/deal-participants/{id}/relationships/contactGets a contact related to a single participants in a deal GET/jsonapi/deals/{id}/customStatusGets customStatus via a single related deal PATCH/jsonapi/deals/{id}Updates the attributes and/or relationships of an existing deal. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced GET/jsonapi/deals/{id}Gets a single deal by id GET/jsonapi/dealsGets a collection of deals GET/jsonapi/deals/{id}/relationships/customStatusGets a customStatus related to a single deal GET/jsonapi/deal-securities/{id}/assetGets asset via a single related securities for a deal GET/jsonapi/deal-securitiesGets a collection of securities for deals GET/jsonapi/deal-securities/{id}Gets a single securities for a deal by id GET/jsonapi/deal-securities/{id}/relationships/assetGets a asset related to a single securities for a deal GET/jsonapi/deal-structures/{id}/dealGets deal via a single related deal structure PUT/jsonapi/deals/{id}/statusChanges the custom status of a deal POST/jsonapi/deal-structuresCreates a new deal structure with attributes, relationships or both PATCH/jsonapi/deal-structures/{id}Updates the attributes and/or relationships of an existing deal structure. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced GET/jsonapi/deal-structures/{id}Gets a single deal structure by id GET/jsonapi/deal-structures/{id}/relationships/dealGets a deal related to a single deal structure GET/jsonapi/incomes/{id}/relationships/ownershipGets a ownerships related to a single income GET/jsonapi/enquiry-sourcesGets a collection of enquiry sources GET/jsonapi/enquiry-sources/{id}Gets a single enquiry source by id GET/jsonapi/incomes/{id}/ownershipGets ownerships via a single related income GET/jsonapi/expense-categories/{id}/expenseTypesGets expenseTypes via a single related expense category GET/jsonapi/expense-categoriesGets a collection of expense categories GET/jsonapi/expense-categories/{id}Gets a single expense category by id GET/jsonapi/expense-categories/{id}/relationships/expenseTypesGets a expenseTypes related to a single expense category GET/jsonapi/expenses/{id}/ownershipGets ownerships via a single related expense GET/jsonapi/expensesGets a collection of expenses GET/jsonapi/expenses/{id}Gets a single expense by id GET/jsonapi/expenses/{id}/relationships/ownershipGets a ownerships related to a single expense GET/jsonapi/expense-types/{id}/expenseCategoryGets expenseCategory via a single related expense type GET/jsonapi/expense-typesGets a collection of expense types GET/jsonapi/expense-types/{id}Gets a single expense type by id GET/jsonapi/expense-types/{id}/relationships/expenseCategoryGets a expenseCategory related to a single expense type GET/jsonapi/income-categories/{id}/incomeTypesGets incomeTypes via a single related income category GET/jsonapi/income-categoriesGets a collection of income categories GET/jsonapi/income-categories/{id}Gets a single income category by id GET/jsonapi/income-categories/{id}/relationships/incomeTypesGets a incomeTypes related to a single income category GET/jsonapi/incomes/{id}/linkedAssetGets linkedAsset via a single related income GET/jsonapi/incomesGets a collection of incomes GET/jsonapi/incomes/{id}Gets a single income by id GET/jsonapi/incomes/{id}/relationships/linkedAssetGets a linkedAsset related to a single income GET/jsonapi/income-types/{id}/incomeCategoryGets incomeCategory via a single related income type GET/jsonapi/income-typesGets a collection of income types GET/jsonapi/income-types/{id}Gets a single income type by id GET/jsonapi/income-types/{id}/relationships/incomeCategoryGets a incomeCategory related to a single income type GET/jsonapi/integrations/{id}/contactExternalReferencesGets contactExternalReferences via a single related integration GET/jsonapi/integrationsGets a collection of integrations POST/jsonapi/integrationsCreates a new integration with attributes, relationships or both GET/jsonapi/integrations/{id}Gets a single integration by id PATCH/jsonapi/integrations/{id}Updates the attributes and/or relationships of an existing integration. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced DELETE/jsonapi/integrations/{id}Deletes an existing integration GET/jsonapi/integrations/{id}/relationships/contactExternalReferencesGets a contactExternalReferences related to a single integration GET/jsonapi/liabilities/{id}/linkedAssetGets linkedAsset via a single related liabilities POST/jsonapi/leadsCreates a lead, including contact and deal attributes GET/jsonapi/leads/{id}Gets select details if an existing lead GET/jsonapi/liabilitiesGets a collection of liabilities GET/jsonapi/liabilities/{id}Gets a single liabilities by id GET/jsonapi/liabilities/{id}/relationships/linkedAssetGets a linkedAsset related to a single liabilities GET/jsonapi/liability-categories/{id}/liabilityTypesGets liabilityTypes via a single related liability category GET/jsonapi/liability-categoriesGets a collection of liability categories GET/jsonapi/liability-categories/{id}Gets a single liability category by id GET/jsonapi/liability-categories/{id}/relationships/liabilityTypesGets a liabilityTypes related to a single liability category GET/jsonapi/liability-types/{id}/liabilityCategoryGets liabilityCategory via a single related liability type GET/jsonapi/liability-typesGets a collection of liability types GET/jsonapi/liability-types/{id}Gets a single liability type by id GET/jsonapi/liability-types/{id}/relationships/liabilityCategoryGets a liabilityCategory related to a single liability type GET/jsonapi/organisations/{id}/customStatusesGets customStatuses via a single related organisation GET/jsonapi/organisationsGets a collection of organisations GET/jsonapi/organisations/{id}Gets a single organisation by id GET/jsonapi/organisations/{id}/relationships/customStatusesGets a customStatuses related to a single organisation GET/jsonapi/tasks/{id}/commercialFinanceDiversifiedDealGets commercialFinanceDiversifiedDeal via a single related task GET/jsonapi/property-typesGets a collection of property types GET/jsonapi/property-types/{id}Gets a single property type by id GET/jsonapi/tasks/{id}/assetFinanceDiversifiedDealGets assetFinanceDiversifiedDeal via a single related task GET/jsonapi/tasks/{id}/contactGroupsGets contactGroups via a single related task GET/jsonapi/referrersGets a collection of referrers GET/jsonapi/referrers/{id}Gets a single referrer by id GET/jsonapi/tasks/{id}/residentialDealGets residentialDeal via a single related task GET/jsonapi/tasks/{id}/assigneeGets assignee via a single related task POST/jsonapi/structured-leadsCreates a structured lead, including contact and deal attributes GET/jsonapi/structured-leads/{id}Gets select details of an existing lead GET/jsonapi/tasks/{id}Gets a single task by id PATCH/jsonapi/tasks/{id}Updates the attributes and/or relationships of an existing task POST/jsonapi/tasksCreates a new task GET/jsonapi/tasks/{id}/relationships/assigneeGets a assignee related to a single task GET/jsonapi/advisers/{id}/contactGroupsGets contactGroups via a single related adviser GET/jsonapi/advisers/{id}/adviserDetailsGets adviserDetail via a single related adviser GET/jsonapi/advisers/{id}/organisationGets organisation via a single related adviser GET/jsonapi/advisers/{id}/agreementHoldersGets agreementHolders via a single related adviser GET/jsonapi/advisers/{id}/addressesGets addresses via a single related adviser GET/jsonapi/advisers/{id}/relationships/adviserDetailsGets a adviserDetail related to a single adviser GET/jsonapi/advisers/{id}/relationships/organisationGets a organisation related to a single adviser GET/jsonapi/advisers/{id}/relationships/agreementHoldersGets a agreementHolders related to a single adviser GET/jsonapi/advisers/{id}/relationships/addressesGets a addresses related to a single adviser GET/jsonapi/contact-groups/{id}/relationships/contactsGets a contacts related to a single contact group GET/jsonapi/contact-groups/{id}/relationships/adviserGets a adviser related to a single contact group GET/jsonapi/contact-groups/{id}/relationships/referrerOrganisationGets a referrerOrganisation related to a single contact group GET/jsonapi/contact-groups/{id}/relationships/referrerGets a referrer related to a single contact group GET/jsonapi/contacts/{id}/ownershipGets ownerships via a single related contact GET/jsonapi/contacts/{id}/externalReferencesGets externalReferences via a single related contact GET/jsonapi/contacts/{id}/dealsGets deals via a single related contact GET/jsonapi/contacts/{id}/contactAddressGets contactAddresses via a single related contact GET/jsonapi/contacts/{id}/relationships/ownershipGets a ownerships related to a single contact GET/jsonapi/contacts/{id}/relationships/externalReferencesGets a externalReferences related to a single contact GET/jsonapi/contacts/{id}/relationships/dealsGets a deals related to a single contact GET/jsonapi/contacts/{id}/relationships/contactAddressGets a contactAddresses related to a single contact GET/jsonapi/deal-participants/{id}/dealGets deal via a single related participants in a deal GET/jsonapi/deal-participants/{id}/relationships/dealGets a deal related to a single participants in a deal GET/jsonapi/deals/{id}/dealScenarioGets dealScenario via a single related deal GET/jsonapi/deals/{id}/importantDatesGets importantDates via a single related deal GET/jsonapi/deals/{id}/participantsGets participants via a single related deal GET/jsonapi/deals/{id}/externalReferencesGets externalReferences via a single related deal GET/jsonapi/deals/{id}/contactsGets contacts via a single related deal GET/jsonapi/deals/{id}/dealStructuresGets dealStructures via a single related deal GET/jsonapi/deals/{id}/adviserGets adviser via a single related deal GET/jsonapi/deals/{id}/dealNotesGets dealNotes via a single related deal GET/jsonapi/deals/{id}/loanSecuritiesGets loanSecurities via a single related deal GET/jsonapi/deals/{id}/relationships/dealScenarioGets a dealScenario related to a single deal GET/jsonapi/deals/{id}/relationships/importantDatesGets a importantDates related to a single deal GET/jsonapi/deals/{id}/relationships/participantsGets a participants related to a single deal GET/jsonapi/deals/{id}/relationships/externalReferencesGets a externalReferences related to a single deal GET/jsonapi/deals/{id}/relationships/contactsGets a contacts related to a single deal GET/jsonapi/deals/{id}/relationships/dealStructuresGets a dealStructures related to a single deal GET/jsonapi/deals/{id}/relationships/adviserGets a adviser related to a single deal GET/jsonapi/deals/{id}/relationships/dealNotesGets a dealNotes related to a single deal GET/jsonapi/deals/{id}/relationships/loanSecuritiesGets a loanSecurities related to a single deal GET/jsonapi/deal-securities/{id}/titleIdentificationsGets titleIdentifications via a single related securities for a deal GET/jsonapi/deal-securities/{id}/ownershipGets ownerships via a single related securities for a deal GET/jsonapi/deal-securities/{id}/relationships/titleIdentificationsGets a titleIdentifications related to a single securities for a deal GET/jsonapi/deal-securities/{id}/relationships/ownershipGets a ownerships related to a single securities for a deal GET/jsonapi/deal-structures/{id}/dealImportantDatesGets dealImportantDates via a single related deal structure GET/jsonapi/deal-structures/{id}/relationships/dealImportantDatesGets a dealImportantDates related to a single deal structure GET/jsonapi/integrations/{id}/dealExternalReferencesGets dealExternalReferences via a single related integration GET/jsonapi/integrations/{id}/relationships/dealExternalReferencesGets a dealExternalReferences related to a single integration GET/jsonapi/liabilities/{id}/ownershipGets ownerships via a single related liabilities GET/jsonapi/liabilities/{id}/relationships/ownershipGets a ownerships related to a single liabilities GET/jsonapi/liability-types/{id}/liabilitySubTypesGets liabilitySubTypes via a single related liability type GET/jsonapi/liability-types/{id}/relationships/liabilitySubTypesGets a liabilitySubTypes related to a single liability type GET/jsonapi/organisations/{id}/addressesGets addresses via a single related organisation GET/jsonapi/organisations/{id}/relationships/addressesGets a addresses related to a single organisation GET/jsonapi/tasks/{id}/relationships/residentialDealGets a residentialDeal related to a single task GET/jsonapi/tasks/{id}/relationships/contactGroupsGets a contactGroups related to a single task GET/jsonapi/tasks/{id}/relationships/assetFinanceDiversifiedDealGets a assetFinanceDiversifiedDeal related to a single task GET/jsonapi/tasks/{id}/relationships/commercialFinanceDiversifiedDealGets a commercialFinanceDiversifiedDeal related to a single task