11.3. api/PortalList

This API call is used to return various options available for dropdown selections.

• County – Returns all counties available in the client’s CRM.

• Country – Returns all countries available in the client’s CRM.

• WhereHear – Returns all lead source options available in the client’s CRM.

• BusinessCategory – Returns all business category types available in the client’s CRM.

• Classification – Returns all classification options (if applicable).

• Subscriptions – Returns all available membership or customer subscription packages for users wishing to join.

• Postcode|yourpostcodevalue

Purpose: Used to search for existing Primary Records (companies) by postcode during the registration process.
Format Example: Postcode|LS12
Behavior: Returns all Primary Records in the CRM that match the supplied postcode.
Additional Info: Results include a “My Organisation Is Not Listed” option if the user’s company is not found. This ensures users can either select an existing company or create a new one.

• Postcode|yourcompanynamevalue

Purpose: Used to search for existing Primary Records by company name during the registration process.
Format Example: Postcode|Rubi
Behavior: Returns all Primary Records in the CRM that match the supplied company name.
Additional Info: Results include a “My Organisation Is Not Listed” option if no match is found, allowing users to create a new Primary Record if needed.

• OfferCategory – Returns all offer categories in the client’s CRM.

• EventCategory – Returns all event categories in the client’s CRM.

• NewsCategory – Returns all news categories in the client’s CRM.

• VacancyCategory – Returns all vacancy categories in the client’s CRM.

All parameters are required and cannot be empty.

Parameter	Parameter Help
List	A list of available options is shown above under “Available List Options”.
API Key

This API call will return an array of all items relating to the list option submitted.

This page was: Helpful | Not Helpful