Client data sections and pagination

Proplix Secure API Gateway

Call the client data endpoint

GET /proplix_api_gateway/portal_api/me or /me/{section} with the short-lived bearer session.

Use GET for client data

Non-GET requests are rejected.

Send the client session token

Use the short-lived token, not the master token.

Fetch all allowed sections

Call /me without a section to receive permitted data groups.

Fetch one allowed section

Call /me/{section} for a selected allowed section.

Set page

Page is normalised to at least 1.

Set per_page

Use the supported bounded pagination value returned by the production model.

Understand core portal permission filtering

The production model applies contact/client portal permissions in addition to profile section selection.

Resolve a disallowed section

Enable the section on the portal profile and ensure the contact has corresponding portal access.

Understand customer ownership

All core data is filtered to the authenticated client/customer identity.

Fetch Client profile

Retrieve the authenticated customer’s core customer/account profile.

Fetch Contacts

Retrieve the authenticated customer’s active contacts related to the customer.

Fetch Invoices

Retrieve the authenticated customer’s customer invoices permitted by portal rules.

Fetch Invoice payments

Retrieve the authenticated customer’s payments related to the customer invoices.

Fetch Estimates

Retrieve the authenticated customer’s customer estimates.

Fetch Proposals

Retrieve the authenticated customer’s customer proposals.

Fetch Projects

Retrieve the authenticated customer’s customer projects.

Fetch Tickets

Retrieve the authenticated customer’s customer support tickets.

Fetch Contracts

Retrieve the authenticated customer’s customer contracts.

Fetch Customer files

Retrieve the authenticated customer’s authorised customer files.

Fetch Subscriptions

Retrieve the authenticated customer’s customer subscriptions.