Users
Download SpecGet Users
Returns a list of your users. The users are sorted by creation date, with the most recent users appearing first.
Authentication
ApiKey
Responses
Response: application/json
items
array[object (User)]
required
page
integer
required
size
int
required
total
integer
required
Response: application/json
detail
array[object (ValidationError)]
Create a New User
⚠ 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.
Authentication
ApiKey
Responses
Response: application/json
address_1
string
address_2
string
address_3
string
ages_of_children
string
associated_cp_user
string
building_number
string
country_of_residence
string
county
string
created
string
date-time
required
dob
string
date-time
drinker
string
string
first_name
string
gender
string
id
string
required
last_visited
string
date-time
meta
object (meta)
mobile_number
string
national_insurance_number
string
nationality
string
number_of_children
string
number_of_cigarettes_per_week
int
number_of_units_per_week
int
partner_dob
string
date-time
partner_first_name
string
partner_sex
string
partner_surname
string
passport_number
string
phone_number
string
postcode
string
preferred_name
string
relationship_status
string
relationship_to_partner
string
smoker
string
surname
string
terms_conditions
boolean
title
string
town_city
string
updated
string
date-time
required
visits
int
Response: application/json
detail
array[object (ValidationError)]
Request Examples
Get User
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.
Authentication
ApiKey
Responses
Response: application/json
address_1
string
address_2
string
address_3
string
ages_of_children
string
associated_cp_user
string
building_number
string
country_of_residence
string
county
string
created
string
date-time
required
dob
string
date-time
drinker
string
string
first_name
string
gender
string
id
string
required
last_visited
string
date-time
meta
object (meta)
mobile_number
string
national_insurance_number
string
nationality
string
number_of_children
string
number_of_cigarettes_per_week
int
number_of_units_per_week
int
partner_dob
string
date-time
partner_first_name
string
partner_sex
string
partner_surname
string
passport_number
string
phone_number
string
postcode
string
preferred_name
string
relationship_status
string
relationship_to_partner
string
smoker
string
surname
string
terms_conditions
boolean
title
string
town_city
string
updated
string
date-time
required
visits
int
Response: application/json
detail
array[object (ValidationError)]
Authentication
ApiKey
Responses
Response: application/json
address_1
string
address_2
string
address_3
string
ages_of_children
string
associated_cp_user
string
building_number
string
country_of_residence
string
county
string
created
string
date-time
required
dob
string
date-time
drinker
string
string
first_name
string
gender
string
id
string
required
last_visited
string
date-time
meta
object (meta)
mobile_number
string
national_insurance_number
string
nationality
string
number_of_children
string
number_of_cigarettes_per_week
int
number_of_units_per_week
int
partner_dob
string
date-time
partner_first_name
string
partner_sex
string
partner_surname
string
passport_number
string
phone_number
string
postcode
string
preferred_name
string
relationship_status
string
relationship_to_partner
string
smoker
string
surname
string
terms_conditions
boolean
title
string
town_city
string
updated
string
date-time
required
visits
int
Response: application/json
detail
array[object (ValidationError)]
Request Examples
Create a New User Broadband Entry
Authentication
ApiKey
Responses
Response: application/json
cp_id
string
required
cp_user_id
string
required
id
string
required
meta
object (meta)
root_user_id
string
required
Response: application/json
detail
array[object (ValidationError)]
Request Examples
get User Broadband Entry
Authentication
ApiKey
Responses
Response: application/json
cp_id
string
required
cp_user_id
string
required
id
string
required
meta
object (meta)
root_user_id
string
required
Response: application/json
detail
array[object (ValidationError)]
update User Broadband Entry
Authentication
ApiKey
Responses
Response: application/json
cp_id
string
required
cp_user_id
string
required
id
string
required
meta
object (meta)
root_user_id
string
required
Response: application/json
detail
array[object (ValidationError)]
Request Examples
Was this page helpful?