Advanced generic API v1 sources and keys

Fetch one source record

Append a record ID where the configured source supports an id column.

Audience: CRM administrators, integration developers, external portal backend teams and security reviewersPermission: Administrator or valid v1 API keyModule v1.0.0
Exact navigationCompatible administrator integration UI → Proplix API Gateway source/key routes
Before you begin
  • Confirm the module is active and use the exact navigation shown above.
  • Use an account with the stated module and core CRM permissions.
  • Use known test records when changing statuses, visibility, saved filters or global navigation.

What this guide covers

Append a record ID where the configured source supports an id column. The instructions below follow the supplied module’s live menu, controller, form, model and JavaScript flow.

Exact step-by-step process

  1. Open Compatible administrator integration UI → Proplix API Gateway source/key routes.
  2. Locate the record, endpoint, field or action used to fetch one source record.
  3. Complete the displayed values exactly as described in this guide.
  4. Select the available save, submit, send, upload, create, update or confirm action.
  5. Return to the related register, portal, activity log or API response and verify the expected result.

Fields, choices and supported possibilities

Workspace or endpointCompatible administrator integration UI → Proplix API Gateway source/key routes
PurposeAppend a record ID where the configured source supports an id column.

Code-backed validations and workflow rules

  • The action is available only where the supplied module exposes it and the signed-in user or API client meets the stated access conditions.
  • Internal helpers are documented under the visible workflow or endpoint they support rather than presented as invented menu pages.

Expected result and verification

  • The fetch one source record workflow completes without a validation, permission, ownership or availability error.
  • The related record, portal view, activity entry, notification log or API response shows the expected state.
  • Client-visible, public and API data remains limited to the code-backed ownership and visibility rules.

Security, privacy and operational checks

  • Use controlled test records and non-production credentials before wider rollout.
  • Grant least privilege and protect secure links, personal data, uploaded files, signatures, API tokens, allowed origins and server IPs.