Advisers, organisations and lookup data
Directory resources describe the adviser and organisation context available to an integration. Lookup resources provide categories, types and other values used by business records.
Adviser context
The adviser identifier used in UserId must be one the application is permitted to act for. The list of advisers you can act on behalf of is available through the adviser-details resource when your access permits it.
Cache reference values thoughtfully
For categories, types, enquiry sources and statuses, these retain stable identifiers and refresh labels periodically. Do not assume a label is the same in every organisation or that all reference data is editable. Some reference data is specific to each adviser or organisation or the country they are operating in, e.g. enquiry sources. Commonly these endpoints will return an error if not called with a UserId header.
For organisation-specific pipeline ordering and changing a deal's status, follow custom status reads and changes.
Use the reference catalogue to find the other category and type endpoints.