User Resource

A user is someone with a Speakap account, enrolled in at least one network and identified by a unique email address and other personal details.

Changelog

v1.0.4
  • Added deleted property.
v1.0.10
  • Added tourCompleted property.
v1.0.13
  • Added lastModified property.
v1.0.22
  • Added external property.
v1.1.3
  • Added XID property.
  • Removed relationshipStatus property.
v1.3.7
  • Added internal contactlabel
  • Changed headerBackgroundUrl
  • Added organizationGroups relation

Representations

JSON

Properties

Name Type Description
address object Hash of address parts
address. city string City
address. country object Two digit ISO 3166-1 country code
address. lines array List of (max 3) free format address lines
address. postalCode string Postal code (free format)
adminConditionsAccepted boolean Read-only Whether or not the user accepted Terms & Conditions for network administrators
avatarThumbnailUrl URI Network profile only File URL to profile picture thumbnail
birthday string Date of birth (ISO 8601 YYYY-mm-dd)
deleted boolean Since 1.0.4 Read-only Whether this user has been deleted or not
EID EID Unique entity identifier
emailAddresses array List of alternative email addresses
external boolean Since 1.0.22 Read-only Whether this is an external user with limited privileges
fullName string Read-only Concatenated name parts
gender string 'female', 'male' or 'complicated'
headerBackgroundUrl URI File URL to header background image. In API versions up to 1.3.6 this is the URL of a pre-scaled thumbnail. In versions 1.3.7 and higher this is the URL of the original file, which can be scaled by adding w and h query parameters as described here: Custom Thumbnails
jobTitle string Network profile only Current job title
languages array List of languages (ISO 639-1)
lastModified datetime Since 1.0.4 Read-only Last time the user was modified
name object Full name parts
name. firstName string First name
name. infix string Optional infices ('de', 'van der‘, 'von', etc.)
name. familyName string Family or last name
preferredLanguage string Global user only Preferred language in RFC 5646/4647 format (e.g. 'en-US' or 'nl-NL')
primaryEmail string Read-only Primary email address
privacyStatementAccepted boolean Read-only Whether or not the user accepted Speakap’s general Terms & Conditions
relationshipStatus string Until 1.1.3 Relationship status
telephoneNumbers array List of telephone numbers
tourCompleted boolean Since 1.0.10 global user only Whether or not this user has completed the tour at least once
type string “user”
XID string Since 1.1.3 Unique external identifier

Email address properties

Name Type Description
confirmed boolean Read-only Whether the mail has been confirmed
label string Label field
primary boolean Whether the email is the primary email address (defaults to false)
value string Actual email address

Telephone number properties

Name Type Description
iddCode string Valid international calling code (excl. international call prefix)
label string 'home', 'work', 'private' or 'internal' (since 1.3.7)
value string Actual telephone number (free format)

Example

{
    "_links": {
        "self": {
            "href": "https://api.speakap.io/networks/FEDCBA0987654321/users/1234567890ABCDEF/"
        },
        "avatar": {
            "href": "https://api.speakap.io/networks/FEDCBA0987654321/messages/ABCDEF0123456789/"
        }
    },
    "EID": "1234567890ABCDEF",
    "primaryEmail": "johndoe@gmail.com",
    "privacyStatementAccepted": true,
    "adminConditionsAccepted": false,
    "emailAddresses": [
        { "label": "Primary", "value": "johndoe@gmail.com", "primary": true },
        { "label": "Home", "value": "johndoe@hotmail.com" }
    ],
    "name": {
        "firstName": "John",
        "infix": "",
        "familyName": "Doe"
    },
    "fullName": "John Doe",
    "birthday": "1980-01-01",
    "gender": "male",
    "relationshipStatus": "single",
    "languages":[
        "nl",
        "en"
    ],
    "preferredLanguage": "en-US",
    "tourCompleted": true,
    "avatarThumbnailUrl": "http://vault.speakap.com/file/1234567890ABCDEF",
    "headerImageUrl": "http://vault.speakap.com/file/ABCDEF0123456789",
    "address": {
        "lines": [
            "Pedro de Medinalaan 5-9"
        ],
        "postalCode": "1086 XK",
        "city": "Amsterdam",
        "country": "NL"
    },
    "telephoneNumbers": [
        { "iddCode": "31", "label": "Primary", "value": "012-3456789" },
        { "iddCode": "0", "label": "Extension", "value": "1788" }
    ],
    "jobTitle": "Engineer",
    "deleted": false,
    "lastModified": "2014-11-04T14:17:38.123+01:00",
    "external": false
}