Preo
  • Homepage
  • About
Apps
  • Dashboard
  • App Store
  • Google Play
Social
  • LinkedIn

© 2026 Preo ApS

  • Integration
  • API
Information
Auth
    Get user infoget
Editions
    List editionsgetCreate editionpostGet edition detailsgetUpdate editionpatchDuplicate editionpostGet edition field choicesgetRun edition healthcheckget
Orders
    List ordersgetRetrieve order detailsget
Purchases
    Retrieve purchase detailsgetCreate refund request for purchasepost
User
    List usersgetRetrieve usergetPartially update userpatch
Refunds
    Create refund request for purchasepostList refund requestsgetCreate refund requestpostRetrieve refund request detailsgetApprove refund requestpostReject refund requestpost
Files
    List filesgetUpload filepostGet file detailsgetDelete filedeleteUpdate file metadatapatch
Data Imports
    List data importsgetCreate data importpostGet data import detailsgetUpdate data importpatchCancel data importpostList column mappingsgetUpdate column mappingspatchPreview import ordersgetProcess column mappingspostList product mappingsgetUpdate product mappingspatchStart import processpostValidate column mappingspostImport external orderspost
Campaigns
    List campaignsgetCreate campaignpostRetrieve campaigngetDelete campaigndeleteUpdate campaignpatchCancel campaignpostSchedule campaignpostSend campaign nowpostGet campaign statsget
Consents
    List consentsgetCreate consentpostRetrieve consentgetDelete consentdeleteUpdate consentpatch
Email Messages
    List email messagesgetCreate email messagepostGet email message detailsgetDelete email messagedeleteUpdate email messagepatchAdopt template to editionpostDuplicate email messagepostPreview emailpostGet template variablesget
Segments
    List segmentsgetCreate segmentpostRetrieve segmentgetDelete segmentdeleteUpdate segmentpatchExport segment users as CSVgetRecalculate segmentpostReset stuck segment to draftpostGet CEL context schema and dynamic valuesgetValidate CEL expressionpost
Webhooks
    List webhook endpointsgetCreate webhook endpointpostRetrieve webhook endpointgetDelete webhook endpointdeleteUpdate webhook endpointpatchList deliveries for webhook endpointgetGet delivery detailgetRetry a failed deliverypostRotate webhook secretpost
Schemas
Preo API
Preo API

User

Endpoint

Customer user management within editions.

List users

GET
https://api.preo.dev
/v1/user

API endpoints for managing users.

List users › query Parameters

edition_id
​string

Edition ID (e.g., edt_...)

ordering
​string[] · style: form

Ordering

  • email - Email
  • -email - Email (descending)
  • phone_number - Phone number
  • -phone_number - Phone number (descending)
  • date_joined - Date joined
  • -date_joined - Date joined (descending)
  • last_seen - Last seen
  • -last_seen - Last seen (descending)
Enum values:
-date_joined
-email
-last_seen
-phone_number
date_joined
email
last_seen
phone_number
organization_id
​string

Organization ID (e.g., org_...)

page
​integer

A page number within the paginated result set.

search
​string

Search by name, email, or phone number

List users › Responses

200
count
​integer · required
​object[] · required
next
​string · uri
previous
​string · uri
GET/v1/user
curl --request GET \ --url https://api.preo.dev/v1/user
shell
Example Responses
{ "count": 123, "next": "http://api.example.org/accounts/?page=4", "previous": "http://api.example.org/accounts/?page=2", "results": [ { "id": "id", "email": "test@example.com", "phone_number": "phone_number", "first_name": "first_name", "last_name": "last_name", "is_verified": true, "is_active": true, "locale": "locale", "msg_channel": "msg_channel", "date_joined": "2024-08-25T15:00:00Z", "last_seen": "2024-08-25T15:00:00Z", "metadata": {} } ] }
json
application/json

Retrieve user

GET
https://api.preo.dev
/v1/user/{id}

API endpoints for managing users.

Retrieve user › path Parameters

id
​string · required

A unique value identifying this User.

Retrieve user › Responses

200
id
​string · readOnly · required
email
​string · email · required
locale
​string · readOnly · required
msg_channel
​string | null · readOnly · required
date_joined
​string · date-time · readOnly · required
phone_number
​string | null · maxLength: 32
first_name
​string · maxLength: 80
last_name
​string · maxLength: 80
is_verified
​boolean
is_active
​boolean
last_seen
​string | null · date-time
metadata
​
GET/v1/user/{id}
curl --request GET \ --url https://api.preo.dev/v1/user/:id
shell
Example Responses
{ "id": "id", "email": "test@example.com", "phone_number": "phone_number", "first_name": "first_name", "last_name": "last_name", "is_verified": true, "is_active": true, "locale": "locale", "msg_channel": "msg_channel", "date_joined": "2024-08-25T15:00:00Z", "last_seen": "2024-08-25T15:00:00Z", "metadata": {} }
json
application/json

Partially update user

PATCH
https://api.preo.dev
/v1/user/{id}

API endpoints for managing users.

Partially update user › path Parameters

id
​string · required

A unique value identifying this User.

Partially update user › Request Body

email
​string · email
phone_number
​string
first_name
​string
last_name
​string

Partially update user › Responses

200
id
​string · readOnly · required
email
​string · email · required
locale
​string · readOnly · required
msg_channel
​string | null · readOnly · required
date_joined
​string · date-time · readOnly · required
phone_number
​string | null · maxLength: 32
first_name
​string · maxLength: 80
last_name
​string · maxLength: 80
is_verified
​boolean
is_active
​boolean
last_seen
​string | null · date-time
metadata
​
PATCH/v1/user/{id}
curl --request PATCH \ --url https://api.preo.dev/v1/user/:id \ --header 'Content-Type: application/json' \ --data ' { "email": "test@example.com", "phone_number": "phone_number", "first_name": "first_name", "last_name": "last_name" } '
shell
Example Request Body
{ "email": "test@example.com", "phone_number": "phone_number", "first_name": "first_name", "last_name": "last_name" }
json
Example Responses
{ "id": "id", "email": "test@example.com", "phone_number": "phone_number", "first_name": "first_name", "last_name": "last_name", "is_verified": true, "is_active": true, "locale": "locale", "msg_channel": "msg_channel", "date_joined": "2024-08-25T15:00:00Z", "last_seen": "2024-08-25T15:00:00Z", "metadata": {} }
json
application/json
PurchasesRefunds