Jump to Content
Guides
API Reference
Changelog
API Reference
Guides
API Reference
Changelog
Get a user.
Search
JUMP TO
Overview
Introduction
Authentication
Response Body
Pagination
HTTP Status Codes
Errors
Accounts
Location
The location object
List all locations.
get
Get a location.
get
Update a location.
patch
Organization
The organization object
Get an organization.
get
User
The user object
List all users.
get
Get a user.
get
Appointments
Appointment
The appointment object
Create an appointment.
post
Campaigns
Campaign Interaction
The campaign interaction object
List campaign interactions
get
Campaign
The campaign object
List all campaigns.
get
Create a campaign.
post
Delete a campaign.
delete
Get a campaign.
get
Update a campaign.
put
Message
Create a message for a given campaign
post
Contacts
Contact Attribute
The contact attribute object
List contact attributes
get
Create a contact attribute
post
Delete a contact attribute
delete
Gets a contact attribute by uid
get
Update a contact attribute
patch
Contact Tag
The contact tag object
List all tags for the organization
get
Create a contact tag for an organization
post
Get a contact tag for an organization given an uid
get
Update a contact tag
patch
Contact
The contact object
List all contacts
get
Create a contact
post
Opt out a contact
post
The contact upsert object
Delete a contact
delete
The Contact-attribute Object
Retrieve a contact
get
Update a contact
patch
Remove an attribute from a contact
delete
The Contact-tag Object
Update a contact attribute inside a contact
patch
Add a contact attribute to a contact
post
Remove an existing tag from an existing contact
delete
Add an existing tag to an existing contact
post
Conversations
Conversation
The conversation object
List conversations.
get
Get a conversation.
get
Update a conversation.
put
The lead writeback object
Writeback lead
post
The conversation note object
Create a note for given conversation.
post
Conversation Assignee
Get conversation assignees.
get
Update a conversation assignee.
put
Feedback (Surveys)
Feedback
The feedback object
List all feedback surveys.
get
Messenger
Message
The message object
Retrieve messages from a conversation
get
Retreive a message from a conversation
get
Import a message.
post
Send a message.
post
Send a message with attachment.
post
Template
The template object
List all templates
get
Create a message template.
post
Delete a template
delete
Update a message template.
put
Payments
Invoice
The invoice object
Get all invoices.
get
Create an invoice.
post
Get an invoice.
get
Cancel an invoice.
post
Refund an invoice
post
Payment
The payment object
Get a payment.
get
Reader
The reader object
Get a card reader.
get
Refund
The refund object
Create a refund.
post
Get a refund.
get
Products
Product
List all products.
get
Get a product.
get
Deletes images from a product.
delete
Upload images to a product.
post
The Product Object
The Product Async Object
The Product Image Object
Reviews
Review
The review object
List all reviews.
get
Get a review.
get
Review Invite
The review invite object
List all review invites.
get
Create a review invite link.
post
Get a review invite.
get
Review Sites Summary
The review sites summary object
Summary of all connected review sites.
get
Review Summary
The review summary object
Summary of all reviews
get
Review Response
The Review-response Object
Update response for a given review
patch
List Responses of a given review
get
Create response for a given review
post
Review Attribution
The Review-attribution Object
Remove a user attribution for a given review
delete
Attribute a user to a review
post
Webhook Event Types
Message
Contact
The contact webhook event object
Review
Invoice
Webhooks
Webhook
The webhook object
List webhooks.
get
Create a webhook.
post
Delete a webhook.
delete
Get a webhook.
get
Update a webhook.
put
Workflows
Conversation
Get a conversation lead ID.
get
Data Feed Event
The data feed event object
Process an event through a data feed.
post
SCIM
SCIM User
The SCIM User object
Delete a SCIM user resource
delete
Update a SCIM user resource to be deactivated
patch
Get a user.
get
https://api.podium.com/v4/users/
{uid}
Gets a user.
Required scope:
read_users
.
Callback
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!