Get Users

get /users

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

API Key ApiKey

email

string

ids[]

array[string]

string

page

integer

Default
0

size

integer

Default
50

Response

Examples Schema

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": null,
  "page": null,
  "size": 123
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

items

array[object (User)]

required

User

object (User)

meta

object (meta)

first_name

string

surname

string

preferred_name

string

dob

string

date-time

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

date-time

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

date-time

visits

int

terms_conditions

boolean

associated_cp_user

string

email

string

email

id

string

required

created

string

date-time

required

updated

string

date-time

required

total

integer

required

page

integer

required

size

int

required

No schema

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.

API Key ApiKey

meta

object (meta)

first_name

string

surname

string

preferred_name

string

dob

string

date-time

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

date-time

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

date-time

visits

int

terms_conditions

boolean

associated_cp_user

string

email

string

email

anon_user_id

string

Request

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

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

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

meta

object (meta)

first_name

string

surname

string

preferred_name

string

dob

string

date-time

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

date-time

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

date-time

visits

int

terms_conditions

boolean

associated_cp_user

string

email

string

email

id

string

required

created

string

date-time

required

updated

string

date-time

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

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.

API Key ApiKey

user_id

string

required

Response

Examples Schema

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

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

meta

object (meta)

first_name

string

surname

string

preferred_name

string

dob

string

date-time

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

date-time

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

date-time

visits

int

terms_conditions

boolean

associated_cp_user

string

email

string

email

id

string

required

created

string

date-time

required

updated

string

date-time

required

No schema

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.

API Key ApiKey

user_id

string

required

meta

object (meta)

first_name

string

surname

string

preferred_name

string

dob

string

date-time

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

date-time

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

date-time

visits

int

terms_conditions

boolean

associated_cp_user

string

email

string

email

Request

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

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

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

meta

object (meta)

first_name

string

surname

string

preferred_name

string

dob

string

date-time

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

date-time

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

date-time

visits

int

terms_conditions

boolean

associated_cp_user

string

email

string

email

id

string

required

created

string

date-time

required

updated

string

date-time

required

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

API Key ApiKey

cp_user_id

string

required

broadbandProvider

string

broadbandPpm

string

broadbandDownSpeed

string

Request

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

Response

Examples Schema

Successful Response

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

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

id

string

required

cp_user_id

string

required

root_user_id

string

required

cp_id

string

required

meta

object (meta)

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

get User Broadband Entry

get /users/broadband/{cp_user_id}

API Key ApiKey

cp_user_id

string

required

Response

Examples Schema

Successful Response

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

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

id

string

required

cp_user_id

string

required

root_user_id

string

required

cp_id

string

required

meta

object (meta)

No schema

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}

API Key ApiKey

cp_user_id

string

required

broadbandProvider

string

broadbandPpm

string

broadbandDownSpeed

string

Request

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

Response

Examples Schema

Successful Response

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

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

id

string

required

cp_user_id

string

required

root_user_id

string

required

cp_id

string

required

meta

object (meta)

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Was this page helpful?