MMOB
Environment:
MMOB
Environment:

Users

Download Spec

Get Users

get /users

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

Authentication

API Key ApiKey

X-API-Key found in header

email

string

ids[]

array[string]

string

page

integer

Default
0

size

integer

Default
50

Responses

Response: application/json

items

array[object (User)]

required

User

object (User)

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

email

string

email

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

page

integer

required

size

int

required

total

integer

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Create a New User

post /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.

Authentication

API Key ApiKey

X-API-Key found in header

application/json

address_1

string

address_2

string

address_3

string

ages_of_children

string

anon_user_id

string

associated_cp_user

string

building_number

string

country_of_residence

string

county

string

dob

string

date-time

drinker

string

email

string

email

first_name

string

gender

string

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

visits

int

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

email

string

email

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)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Get User

get /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.

Authentication

API Key ApiKey

X-API-Key found in header

user_id

string

required

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

email

string

email

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)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Update user

post /users/{user_id}

⚠ Accessible to Partners and Providers.

Updates user details.

Authentication

API Key ApiKey

X-API-Key found in header

user_id

string

required

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

dob

string

date-time

drinker

string

email

string

email

first_name

string

gender

string

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

visits

int

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

email

string

email

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)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Create a New User Broadband Entry

post /users/broadband

Authentication

API Key ApiKey

X-API-Key found in header

application/json

broadbandDownSpeed

string

broadbandPpm

string

broadbandProvider

string

cp_user_id

string

required

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)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

get User Broadband Entry

get /users/broadband/{cp_user_id}

Authentication

API Key ApiKey

X-API-Key found in header

cp_user_id

string

required

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)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

update User Broadband Entry

post /users/broadband/{cp_user_id}

Authentication

API Key ApiKey

X-API-Key found in header

cp_user_id

string

required

application/json

broadbandDownSpeed

string

broadbandPpm

string

broadbandProvider

string

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)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Was this page helpful?