Skip to main content

Podium API Endpoints

The Podium API endpoints the integration uses, grouped by record type, for firewall allow-listing and understanding data flow.

See what the Podium integration can do →

This article lists the Podium API endpoints the integration uses, grouped by the type of record they act on. It is useful for firewall allow-listing, understanding data flow, and checking whether the integration is affected when Podium publishes a change to its API.

API Endpoints

The integration uses Podium's REST API (version 4). The base URL is the value configured in the subscription's API URL setting; in the endpoint patterns below, [Base URL] stands for that value (for example, https://api.podium.com).

Table of Contents

  • Contact Endpoints

  • Invoice Endpoints

  • Location Endpoints

  • Webhook Endpoints

  • Authorization Endpoint

Contact Endpoints

Get a Contact (GET)

[Base URL]/v4/contacts/{identifier}

Retrieves a Podium contact by its identifier (contact Uid, email address, or phone number). Used during TO iPaaS.com transfers to read the full contact record.

Create a Contact (POST)

[Base URL]/v4/contacts

Creates a contact in Podium. Used during FROM iPaaS.com transfers.

Update a Contact (PATCH)

[Base URL]/v4/contacts/{emailOrPhone}

Updates an existing Podium contact, located by email address or phone number. Used during FROM iPaaS.com transfers.

Invoice Endpoints

Every invoice call requires a location. The location is taken from the subscription's Location setting (for TO iPaaS.com reads) or from the invoice's locationUid (for FROM iPaaS.com writes).

Get an Invoice (GET)

[Base URL]/v4/invoices/{uid}?locationUid={locationUid}

Retrieves a single Podium invoice by its Uid for a given location.

List Invoices (GET)

[Base URL]/v4/invoices?locationUid={locationUid}&limit=100

Lists invoices for a location.

Create an Invoice (POST)

[Base URL]/v4/invoices

Creates an invoice in Podium. Used during FROM iPaaS.com transfers.

Location Endpoints

List Locations (GET)

[Base URL]/v4/locations

Lists the Podium locations available to the connected account.

Get a Location (GET)

[Base URL]/v4/locations/{identifier}

Retrieves a specific Podium location by its identifier.

Search Locations (GET)

[Base URL]/v4/locations?search={name}

Finds a Podium location by name. Used to resolve the Location setting to a location identifier.

Webhook Endpoints

The integration manages the Podium webhook subscription on your behalf, using the endpoints below.

List Webhooks (GET)

[Base URL]/v4/webhooks

Get a Webhook (GET)

[Base URL]/v4/webhooks/{id}

Create a Webhook (POST)

[Base URL]/v4/webhooks

Update a Webhook (PUT)

[Base URL]/v4/webhooks/{id}

Delete a Webhook (DELETE)

[Base URL]/v4/webhooks/{id}

Authorization Endpoint

The integration authenticates with Podium using OAuth 2.0. Access tokens are obtained and refreshed against Podium's OAuth token endpoint. iPaaS.com manages this exchange automatically once you authorize the connection; no subscriber action is required for routine token refresh.

Related Documents

External References

Did this answer your question?