Platform Status: Good
V1.5
Join Free
Object Types
User

User

User objects represent your customers, or in legal jargon, your Data Subjects.

Property

Type

Example

Description

id
String
24bh0slwro
Unique ID of the user
email
String
customer1@domain.com
Email address of the user
name
String
John Doe
The full name of the user
ref
String
123455
Your ID for the user, this can be used to map users between systems
created
String
2018-04-23T09:54:20.071
DateTime user was created in PORT
since
String
2018-04-23T09:54:20.071
DateTime since user was first seen by an organistion, same as created if not provided
account
Boolean
false
Has this user been connected with a PORT account
invite_url
String
-
An invite link you can give to the user to give them access to their data

Example:

{
    "id": "24bh0slwro",
    "email": "customer1@domain.com",
    "name": "John Doe",
    "ref": "123455",
    "created": "2018-04-23T09:54:20.071",
    "since": "2018-04-23T09:54:20.071",
    "account": false,
    "invite_url": "https://api.port.im/signupinvite?id=24bh0slwro&token=3f24ad6c1bee89f6e6786daa85b18366f8855b7406ecc54a697395729985d250"
}