Users

get

Get Users

Returns a list of your users. The users are sorted by creation date, with the most recent users appearing first.

emailstring
ids[]array [Ids[]]
pageint
Default
0
sizeint
Default
50

Responses

Response examples

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
}
post

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.

metaobject (Meta)
first_namestring
surnamestring
preferred_namestring
dobstring
Format
date-time
titlestring
postcodestring
building_numberstring
address_1string
address_2string
address_3string
town_citystring
countystring
country_of_residencestring
nationalitystring
genderstring
relationship_statusstring
number_of_childrenstring
ages_of_childrenstring
partner_first_namestring
partner_dobstring
Format
date-time
partner_surnamestring
partner_sexstring
relationship_to_partnerstring
smokerstring
number_of_cigarettes_per_weekint
drinkerstring
number_of_units_per_weekint
national_insurance_numberstring
passport_numberstring
phone_numberstring
mobile_numberstring
last_visitedstring
Format
date-time
visitsint
terms_conditionsboolean
associated_cp_userstring
emailstring
Format
email
anon_user_idstring

Responses

Request examples

{
  "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"
}

Response examples

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"
}
get

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.

user_idstring

required

Responses

Response examples

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"
}
post

Update user

⚠ Accessible to Partners and Providers.

Updates user details.

metaobject (Meta)
first_namestring
surnamestring
preferred_namestring
dobstring
Format
date-time
titlestring
postcodestring
building_numberstring
address_1string
address_2string
address_3string
town_citystring
countystring
country_of_residencestring
nationalitystring
genderstring
relationship_statusstring
number_of_childrenstring
ages_of_childrenstring
partner_first_namestring
partner_dobstring
Format
date-time
partner_surnamestring
partner_sexstring
relationship_to_partnerstring
smokerstring
number_of_cigarettes_per_weekint
drinkerstring
number_of_units_per_weekint
national_insurance_numberstring
passport_numberstring
phone_numberstring
mobile_numberstring
last_visitedstring
Format
date-time
visitsint
terms_conditionsboolean
associated_cp_userstring
emailstring
Format
email

Responses

Request examples

{
  "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"
}

Response examples

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"
}
post

Create a New User Broadband Entry

cp_user_idstring

required

broadbandProviderstring
broadbandPpmstring
broadbandDownSpeedstring

Responses

Request examples

{
  "cp_user_id": "string",
  "broadbandProvider": "string",
  "broadbandPpm": "string",
  "broadbandDownSpeed": "string"
}

Response examples

Successful Response

{
  "id": "string",
  "cp_user_id": "string",
  "root_user_id": "string",
  "cp_id": "string",
  "meta": {}
}
get

get User Broadband Entry

cp_user_idstring

required

Responses

Response examples

Successful Response

{
  "id": "string",
  "cp_user_id": "string",
  "root_user_id": "string",
  "cp_id": "string",
  "meta": {}
}
post

update User Broadband Entry

broadbandProviderstring
broadbandPpmstring
broadbandDownSpeedstring

Responses

Request examples

{
  "broadbandProvider": "string",
  "broadbandPpm": "string",
  "broadbandDownSpeed": "string"
}

Response examples

Successful Response

{
  "id": "string",
  "cp_user_id": "string",
  "root_user_id": "string",
  "cp_id": "string",
  "meta": {}
}

Was this page helpful?