/users
Returns a list of your users. The users are sorted by creation date, with the most recent users appearing first.
email
string
ids[]
array [Ids[]]
page
int
size
int
Successful Response
{
"items": [
{
"meta": {},
"first_name": "string",
"surname": "string",
"preferred_name": "string",
"dob": "2023-06-07T17:32:28Z",
"title": "string",
"postcode": "string",
"building_number": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"town_city": "string",
"county": "string",
"country_of_residence": "string",
"nationality": "string",
"gender": "string",
"relationship_status": "string",
"number_of_children": "string",
"ages_of_children": "string",
"partner_first_name": "string",
"partner_dob": "2023-06-07T17:32:28Z",
"partner_surname": "string",
"partner_sex": "string",
"relationship_to_partner": "string",
"smoker": "string",
"number_of_cigarettes_per_week": 123,
"drinker": "string",
"number_of_units_per_week": 123,
"national_insurance_number": "string",
"passport_number": "string",
"phone_number": "string",
"mobile_number": "string",
"last_visited": "2023-06-07T17:32:28Z",
"visits": 123,
"terms_conditions": true,
"associated_cp_user": "string",
"email": "alice@example.com",
"id": "string",
"created": "2023-06-07T17:32:28Z",
"updated": "2023-06-07T17:32:28Z"
}
],
"total": 123,
"page": 123,
"size": 123
}
/users
⚠ Only accessible to Partners
.
Creates a new user.
Only first_name
, surname
, and email
are required, but we suggest submitting as much information as possible to avoid having user journeys be disrupted by the user having to manually enter their information at a later stage.
meta
object (Meta)
first_name
string
surname
string
preferred_name
string
dob
string
title
string
postcode
string
building_number
string
address_1
string
address_2
string
address_3
string
town_city
string
county
string
country_of_residence
string
nationality
string
gender
string
relationship_status
string
number_of_children
string
ages_of_children
string
partner_first_name
string
partner_dob
string
partner_surname
string
partner_sex
string
relationship_to_partner
string
smoker
string
number_of_cigarettes_per_week
int
drinker
string
number_of_units_per_week
int
national_insurance_number
string
passport_number
string
phone_number
string
mobile_number
string
last_visited
string
visits
int
terms_conditions
boolean
associated_cp_user
string
email
string
anon_user_id
string
{
"meta": {},
"first_name": "string",
"surname": "string",
"preferred_name": "string",
"dob": "2023-06-07T17:32:28Z",
"title": "string",
"postcode": "string",
"building_number": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"town_city": "string",
"county": "string",
"country_of_residence": "string",
"nationality": "string",
"gender": "string",
"relationship_status": "string",
"number_of_children": "string",
"ages_of_children": "string",
"partner_first_name": "string",
"partner_dob": "2023-06-07T17:32:28Z",
"partner_surname": "string",
"partner_sex": "string",
"relationship_to_partner": "string",
"smoker": "string",
"number_of_cigarettes_per_week": 123,
"drinker": "string",
"number_of_units_per_week": 123,
"national_insurance_number": "string",
"passport_number": "string",
"phone_number": "string",
"mobile_number": "string",
"last_visited": "2023-06-07T17:32:28Z",
"visits": 123,
"terms_conditions": true,
"associated_cp_user": "string",
"email": "alice@example.com",
"anon_user_id": "string"
}
Successful Response
{
"meta": {},
"first_name": "string",
"surname": "string",
"preferred_name": "string",
"dob": "2023-06-07T17:32:28Z",
"title": "string",
"postcode": "string",
"building_number": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"town_city": "string",
"county": "string",
"country_of_residence": "string",
"nationality": "string",
"gender": "string",
"relationship_status": "string",
"number_of_children": "string",
"ages_of_children": "string",
"partner_first_name": "string",
"partner_dob": "2023-06-07T17:32:28Z",
"partner_surname": "string",
"partner_sex": "string",
"relationship_to_partner": "string",
"smoker": "string",
"number_of_cigarettes_per_week": 123,
"drinker": "string",
"number_of_units_per_week": 123,
"national_insurance_number": "string",
"passport_number": "string",
"phone_number": "string",
"mobile_number": "string",
"last_visited": "2023-06-07T17:32:28Z",
"visits": 123,
"terms_conditions": true,
"associated_cp_user": "string",
"email": "alice@example.com",
"id": "string",
"created": "2023-06-07T17:32:28Z",
"updated": "2023-06-07T17:32:28Z"
}
/users/{user_id}
Retrieves the details of an existing user. Information is received by user creation when accessing the marketplace as a Partner
, or when a user gives consent to share data with the Provider
.
ℹ Accessible to Partners
and Providers
companies.
user_id
string
required
Successful Response
{
"meta": {},
"first_name": "string",
"surname": "string",
"preferred_name": "string",
"dob": "2023-06-07T17:32:28Z",
"title": "string",
"postcode": "string",
"building_number": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"town_city": "string",
"county": "string",
"country_of_residence": "string",
"nationality": "string",
"gender": "string",
"relationship_status": "string",
"number_of_children": "string",
"ages_of_children": "string",
"partner_first_name": "string",
"partner_dob": "2023-06-07T17:32:28Z",
"partner_surname": "string",
"partner_sex": "string",
"relationship_to_partner": "string",
"smoker": "string",
"number_of_cigarettes_per_week": 123,
"drinker": "string",
"number_of_units_per_week": 123,
"national_insurance_number": "string",
"passport_number": "string",
"phone_number": "string",
"mobile_number": "string",
"last_visited": "2023-06-07T17:32:28Z",
"visits": 123,
"terms_conditions": true,
"associated_cp_user": "string",
"email": "alice@example.com",
"id": "string",
"created": "2023-06-07T17:32:28Z",
"updated": "2023-06-07T17:32:28Z"
}
/users/{user_id}
⚠ Accessible to Partners
and Providers
.
Updates user details.
meta
object (Meta)
first_name
string
surname
string
preferred_name
string
dob
string
title
string
postcode
string
building_number
string
address_1
string
address_2
string
address_3
string
town_city
string
county
string
country_of_residence
string
nationality
string
gender
string
relationship_status
string
number_of_children
string
ages_of_children
string
partner_first_name
string
partner_dob
string
partner_surname
string
partner_sex
string
relationship_to_partner
string
smoker
string
number_of_cigarettes_per_week
int
drinker
string
number_of_units_per_week
int
national_insurance_number
string
passport_number
string
phone_number
string
mobile_number
string
last_visited
string
visits
int
terms_conditions
boolean
associated_cp_user
string
email
string
{
"meta": {},
"first_name": "string",
"surname": "string",
"preferred_name": "string",
"dob": "2023-06-07T17:32:28Z",
"title": "string",
"postcode": "string",
"building_number": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"town_city": "string",
"county": "string",
"country_of_residence": "string",
"nationality": "string",
"gender": "string",
"relationship_status": "string",
"number_of_children": "string",
"ages_of_children": "string",
"partner_first_name": "string",
"partner_dob": "2023-06-07T17:32:28Z",
"partner_surname": "string",
"partner_sex": "string",
"relationship_to_partner": "string",
"smoker": "string",
"number_of_cigarettes_per_week": 123,
"drinker": "string",
"number_of_units_per_week": 123,
"national_insurance_number": "string",
"passport_number": "string",
"phone_number": "string",
"mobile_number": "string",
"last_visited": "2023-06-07T17:32:28Z",
"visits": 123,
"terms_conditions": true,
"associated_cp_user": "string",
"email": "alice@example.com"
}
Successful Response
{
"meta": {},
"first_name": "string",
"surname": "string",
"preferred_name": "string",
"dob": "2023-06-07T17:32:28Z",
"title": "string",
"postcode": "string",
"building_number": "string",
"address_1": "string",
"address_2": "string",
"address_3": "string",
"town_city": "string",
"county": "string",
"country_of_residence": "string",
"nationality": "string",
"gender": "string",
"relationship_status": "string",
"number_of_children": "string",
"ages_of_children": "string",
"partner_first_name": "string",
"partner_dob": "2023-06-07T17:32:28Z",
"partner_surname": "string",
"partner_sex": "string",
"relationship_to_partner": "string",
"smoker": "string",
"number_of_cigarettes_per_week": 123,
"drinker": "string",
"number_of_units_per_week": 123,
"national_insurance_number": "string",
"passport_number": "string",
"phone_number": "string",
"mobile_number": "string",
"last_visited": "2023-06-07T17:32:28Z",
"visits": 123,
"terms_conditions": true,
"associated_cp_user": "string",
"email": "alice@example.com",
"id": "string",
"created": "2023-06-07T17:32:28Z",
"updated": "2023-06-07T17:32:28Z"
}
/users/broadband
cp_user_id
string
required
broadbandProvider
string
broadbandPpm
string
broadbandDownSpeed
string
{
"cp_user_id": "string",
"broadbandProvider": "string",
"broadbandPpm": "string",
"broadbandDownSpeed": "string"
}
Successful Response
{
"id": "string",
"cp_user_id": "string",
"root_user_id": "string",
"cp_id": "string",
"meta": {}
}
/users/broadband/{cp_user_id}
cp_user_id
string
required
Successful Response
{
"id": "string",
"cp_user_id": "string",
"root_user_id": "string",
"cp_id": "string",
"meta": {}
}
/users/broadband/{cp_user_id}
broadbandProvider
string
broadbandPpm
string
broadbandDownSpeed
string
{
"broadbandProvider": "string",
"broadbandPpm": "string",
"broadbandDownSpeed": "string"
}
Successful Response
{
"id": "string",
"cp_user_id": "string",
"root_user_id": "string",
"cp_id": "string",
"meta": {}
}
Was this page helpful?