Developers
Unify API user response
When fetching users Unify, the response follows a specified JSON format as described in the table below. Some fields however are only included in the response if they are specified in the JWT scopes.
| Property path | Data type | Required scopes | Description |
|---|---|---|---|
| data.id | String | (None) | The unique identifier for the given user. |
| data.gender | String | null | 'gender' | The gender of the user, if any. |
| data.sub | String | 'openid' | The subject claim for the given user as specified in RFC 7519 section 4.1.2. |
| data.iss | String | 'openid' | The issuer claim for the given user as specified in RFC 7519 section 4.1.1. |
| data.aud | String | 'openid' | The audience claim for the given user as specified in RFC 7519 section 4.1.3. |
| data.exp | String | 'openid' | The expiration claim for the given user as specified in RFC 7519 section 4.1.4. |
| data.iat | String | 'openid' | The issued at claim for the given user as specified in RFC 7519 section 4.1.6. |
| data.initials | String | null | (None) | The initials of the given user, if any. |
| data.first_name | String | null | (None) | The first name of the given user, if any |
| data.last_name_prefix | String | null | (None) | Some in some countries like for example The Netherlands, the last name can have a prefix. |
| data.last_name | String | null | (None) | The last name of the given user, if any. |
| data.email | String | null | (None) | The email address of the given user. Note that is there is no valid email address for the user, this will return null. |
| data.email_verified | boolean | (None) | Whether the target user has verified their email address |
| data.is_quest | boolean | (None) | Whether the target user is considered a guest user |
| data.is_complete | boolean | (None) | Whether the given user has completed their account setup and the account is considered completed. |
| data.user_metadata.locale | String | (None) | The language of the given user using the ISO 3166-1 alpha-2 standard. |
| data.user_metadata.country | String | (None) | The country of the given user using the ISO 3166-1 alpha-2 standard. |
| data.user_metadata.professions | Array | 'professions' | A list of specialties which have been assigned to the given user. |
| data.user_metadata.professions.*.sp_code | String | 'professions' | Code for a specialism which has been assigned to the given user. |
| data.user_metadata.professions.*.sp_name | String | 'professions' | The name of the specialism which has been assigned to the given user. |
| data.user_metadata.roles | Array | (None) | List of all the roles which are assigned to the given user |
| data.user_metadata.roles.* | String | (None) | The name of the role which has been assigned to the given user |
| data.user_metadata.place_of_work | String? | (None) | The place of work for the given user. Note that this property only exists on a limited number of tenants. |
| data.user_metadata.consents.[consent_id] | String | 'consents' | A dictionary where each key is the name of a consent and the value is the status the given user for that consent |
| data.user_metadata.attributes.[attribute_key] | String | 'attributes' | A dictionary where each key is is the key for an attribute and the value is the value of the attribute for the given user. |
| data.user_metadata.attributes.onekey_id | String | null | 'attributes' | Special key which exists in the attributes dictionary. Specifies the external onekey id if there is one for the given user. |
| data.user_metadata.attributes.veeva_id | String | null | 'attributes' | Special key which exists in the attributes dictionary. Specifies the external veeva id if there is one for the given user. |
| data.user_metadata.attributes.place_of_work | String? | 'attributes' | Special key which exists in the attributes dictionary. Specifies the place of work for the given user. Note that this property only exists on a limited number of tenants. |
| data.user_metadata.addresses | Array | 'addresses' | Contains the primary address for the given user. Due to historical reasons this remains an array, but currently only ever contains one entry. |
| data.user_metadata.addresses.0.organisation | String | null | 'addresses' | The organisation name of the primary address for the given user. |
| data.user_metadata.addresses.0.postcode | String | null | 'addresses' | The postcode of the primary address for the given user. |
| data.user_metadata.addresses.0.address | String | null | 'addresses' | This field contains the street name of the primary address for the given user. Prefer using the street property instead. |
| data.user_metadata.addresses.0.street | String | null | 'addresses' | The street name of the primary address for the given user. |
| data.user_metadata.addresses.0.number | String | null | 'addresses' | The hourse number of the primary address for the given user. |
| data.user_metadata.addresses.0.letter | String | null | 'addresses' | In addition to the house number, some addresses also have a letter. |
| data.user_metadata.addresses.0.addition | String | null | 'addresses' | In addition to the house number, some addresses also have some additional numbers or letters. |
| data.user_metadata.addresses.0.city | String | null | 'addresses' | The city of the primary address for the given user. |
| data.user_metadata.addresses.0.country | String | null | 'addresses' | The country of the primary address for the given user. |