Customer work, connected.

Help & supportMyAccount
Advanced generic API v1 sources and keys

Use GET for v1 data

Pixie CRM guidance. Follow the route for your workspace, check your role and enabled modules, and verify the result before moving on.

Unsupported methods are rejected.

Audience: CRM administrators, integration developers, external portal backend teams and security reviewersPermission: Administrator or valid v1 API keyModule v1.0.0
Jump to steps
Where to goCompatible administrator integration UI → Proplix API Gateway source/key routes
Before you start
  • Verify 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 helps you do

Unsupported methods are rejected. The instructions below follow the supplied module’s live menu, controller, form, model and JavaScript flow.

Follow these steps

  1. Go to Compatible administrator integration UI → Proplix API Gateway source/key routes.
  2. Find the record, endpoint, field or action used to use get for v1 data.
  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 and options

Workspace or endpointCompatible administrator integration UI → Proplix API Gateway source/key routes
PurposeUnsupported methods are rejected.

Rules and limits

  • 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.

Check it worked

  • The use get for v1 data 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.

Search the platform, integrations and practical Help Centre guides.

Press Esc to close.Browse every page