Skip to main content

​
User Parameters

User parameters define end-user account information, contact details, and metadata for the Podero platform.
Use the external_user_id field to link Podero users with your internal customer management system.

​
Required Parameters

​
org_id
string (UUID)
required
Organization ID that the user belongs to. Assigned during partner onboarding.Example: 016b78a7-0c7c-4241-a277-015c3ad3cb90Writable: No (set at creation, cannot be changed)
​
email
string
required
User’s email address. Must be unique within the organization.Example: [email protected]Writable: Yes
​
role
enum
required
User’s access level within the organization.Options:
  • admin - Full access to all organization resources
  • staff - Can manage end-users and devices, but not other staff/admins
  • user - End-user with access only to their own resources
Example: userWritable: Yes (admin only can change roles)

​
Optional Parameters

​
Personal Information

​
external_user_id
string
Partner’s internal user identifier for cross-referencing with your systems.Example: 134681893870Writable: Yes
​
first_name
string
User’s first name.Example: PeterWritable: Yes
​
last_name
string
User’s last name.Example: SchmidtWritable: Yes

​
Address Information

​
street_and_number
string
Primary street address with house number.Example: Platz der Republik 1Writable: Yes
​
street_add_info
string
Additional address information (apartment number, floor, building, etc.).Example: Apt 4BWritable: Yes
​
zip_code
integer
Postal/ZIP code.Example: 11011Writable: Yes
​
town
string
City or town name.Example: BerlinWritable: Yes
​
country_iso2
string
Country code in ISO 3166-1 alpha-3 format.Example: DEUWritable: Yes

​
Location Coordinates

Latitude and longitude can be used for location-based optimization and regional pricing.
​
latitude
float
Geographic latitude coordinate.Example: 40.7128Writable: Yes
​
longitude
float
Geographic longitude coordinate.Example: 74.0060Writable: Yes
​
location_last_updated
datetime
Timestamp when location coordinates were last updated. Read-only, automatically set by the system.Example: 2023-07-15T19:34:29.000ZWritable: No (automatically managed)

​
Usage Examples

​
Create User with Minimum Required Fields

curl -X POST \
  'https://app.podero.com/api/partners/v2.0/org/{org_id}/users' \
  -H 'Authorization: Bearer {auth_token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "role": "user",
    "email": "[email protected]"
  }'

​
Create User with Complete Information

curl -X POST \
  'https://app.podero.com/api/partners/v2.0/org/{org_id}/users' \
  -H 'Authorization: Bearer {auth_token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "role": "user",
    "email": "[email protected]",
    "external_user_id": "134681893870",
    "first_name": "Peter",
    "last_name": "Schmidt",
    "street_and_number": "Platz der Republik 1",
    "street_add_info": "Apt 4B",
    "zip_code": "11011",
    "town": "Berlin",
    "country_iso2": "DEU",
    "latitude": 52.5200,
    "longitude": 13.4050
  }'

​
Update User Information

curl -X PUT \
  'https://app.podero.com/api/partners/v2.0/org/{org_id}/users/{user_id}' \
  -H 'Authorization: Bearer {auth_token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "external_user_id": "updated_id_12345",
    "town": "Munich",
    "country_iso2": "DEU"
  }'

​
Best Practices

  • Always set external_user_id to link with your internal systems
  • Use a consistent ID format across all users
  • This makes it easy to sync data between systems
  • Useful for customer support and troubleshooting
  • Collect user names and addresses for better optimization
  • Location data helps with regional pricing and weather-based optimization
  • Keep email addresses up-to-date for important notifications
  • Validate email format before sending to API
  • Use user role for end-customers
  • Use staff role for support team members
  • Reserve admin role for managers and senior staff
  • Only admins can change user roles
  • Only collect data you need and have permission to store
  • Follow GDPR and other privacy regulations
  • Provide users with access to their own data
  • Implement data retention policies

Getting Started

Create your first user

User Management

Back-office user workflows

Buildings

Building parameters reference

Team Administration

Manage staff and admin users