Skip to main content

Podium API Endpoints

Updated today

Base URLs:

Table of Contents

Contact Endpoints

Get a Customer by Email Address: (GET)

[Base URL]/v4/contacts/{customer-email}

Get a Customer by Phone Number: (GET)

[Base URL]/v4/contacts/{customer-email}

Create a Customer: (POST)

[Base URL]/v4/contacts

Update a Customer by Email Address: (PATCH)

[Base URL]/v4/contacts/{customer-email}

Update a Customer by Phone Number: (PATCH)

[Base URL]/v4/contacts/{customer-email}

Invoices Endpoints

NOTE: The locationUid is required for every call. It is derived from the iPaaS subscription's location prefix, which defines the location name.

Get an Invoice: (GET)

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

Create an Invoice: (POST)

[Base URL]/V4/invoices

Authentication Endpoints

Get Access Token: (POST)

[Base URL]/ V4/oauth/token?code={code}&client_id={clientId}&client_secret={clientSecret}&redirect_uri={redirectUrl}&grant_type=authorization_code}

Refresh Token: (POST)

[Base URL]/ V4/oauth/token?client_id={clientId}&client_secret={clientSecret}&grant_type=refresh_token&refresh_token={refreshToken}}

Webhook Endpoints

Get a Webhook: (GET)

[Base URL]/v4/webhooks

Create a Webhook: (POST)

[Base URL]/v4/webhooks

Update a Webhook: (PUT)

[Base URL]/v4/webhooks/uid

Delete a Webhook: (Delete)

[Base URL]/v4/webhooks/:uid

Did this answer your question?