Get User

GET /api/v1_1/user/{user_id}

A user record is identified by user_id in CustomerSuccessBox. It's possible to have multiple user records recognised by same user_id as long as each one is associated to a unique account recognised by account_id.

get
User

https://{domain}.customersuccessbox.com/api/v1_1/user/{user_id}
GET User fetches a list of users recognised by user_id
Request
Response
Request
Path Parameters
user_id
required
string
Unique identifier for user
Headers
Authorization
required
string
Bearer {secret_key}
Content-Type
required
string
application/json
Response
200: OK
{
"current_page":1,
"data":[
{
"id":123104,
"account_id":"913",
"event_account_id":"cus_cz7mdvqcpxg6ix",
"event_user_id":"111111",
"role_id":null,
"phone":"+107503241715",
"mobile_phone":"+107503241715",
"email":"simranistesting@gmail.com",
"salutation":null,
"title":null,
"mailing_street":null,
"mailing_city":null,
"mailing_state":null,
"mailing_postal_code":null,
"mailing_country":null,
"active_days":"0",
"first_active_date":null,
"last_active_date":null,
"first_name":"Simarnjit",
"last_name":null,
"role_name":null,
"team":null,
"original_source":null,
"type":null,
"date_of_birth":null,
"linkedin_profile":null,
"twitter_profile":null,
"facebook_profile":null,
"business_email":null,
"product_user":"0",
"last_touchpoint_date":"2019-04-08",
"last_touchpoint_time":"09:04:06",
"last_touchpoint_at":"2019-04-08 09:04:06",
"external_billing_user_id":null,
"external_crm_user_id":null,
"external_ticket_user_id":null,
"external_account_id":null,
"created_on":null,
"last_login_on":null,
"updated_on":null,
"created_at":"2019-03-26 11:46:23",
"updated_at":"2019-04-08 09:04:06",
"external_ticket_user_name":null,
"external_ticket_account_id":null,
"ticket_last_login_at":null,
"custom_user_company_id":null,
"custom_company_id":null,
"role":null,
"first_active_date_readable":"",
"last_active_date_readable":"",
"last_touchpoint_at_readable":"3 weeks ago",
"custom_columns":[
{
"name":"custom_user_company_id",
"label":"Custom User Company Id",
"type":"string",
"required":""
},
{
"name":"custom_company_id",
"label":"Custom Company Id",
"type":"string",
"required":""
}
],
"first_active_date_for_humans":"",
"first_active_date_for_date_format":"",
"last_active_date_for_humans":"",
"last_active_date_for_date_format":"",
"last_touchpoint_at_for_humans":"3 weeks ago",
"last_touchpoint_at_for_date_format":"2019-04-08"
},
{
"id":123105,
"account_id":"123",
"event_account_id":"cus_dwrc8udx8czvte",
"event_user_id":"111111",
"role_id":null,
"phone":"+1",
"mobile_phone":"+1",
"email":"simranistesting@gmail.com",
"salutation":null,
"title":null,
"mailing_street":null,
"mailing_city":null,
"mailing_state":null,
"mailing_postal_code":null,
"mailing_country":null,
"active_days":"0",
"first_active_date":null,
"last_active_date":null,
"first_name":"10k",
"last_name":"asdf",
"role_name":null,
"team":null,
"original_source":null,
"type":null,
"date_of_birth":null,
"linkedin_profile":null,
"twitter_profile":null,
"facebook_profile":null,
"business_email":null,
"product_user":"0",
"last_touchpoint_date":"2019-04-08",
"last_touchpoint_time":"09:04:06",
"last_touchpoint_at":"2019-04-08 09:04:06",
"external_billing_user_id":null,
"external_crm_user_id":null,
"external_ticket_user_id":null,
"external_account_id":null,
"created_on":null,
"last_login_on":null,
"updated_on":null,
"created_at":"2019-04-08 08:48:24",
"updated_at":"2019-04-08 09:04:06",
"external_ticket_user_name":null,
"external_ticket_account_id":null,
"ticket_last_login_at":null,
"custom_user_company_id":null,
"custom_company_id":null,
"role":null,
"first_active_date_readable":"",
"last_active_date_readable":"",
"last_touchpoint_at_readable":"3 weeks ago",
"custom_columns":[
{
"name":"custom_user_company_id",
"label":"Custom User Company Id",
"type":"string",
"required":""
},
{
"name":"custom_company_id",
"label":"Custom Company Id",
"type":"string",
"required":""
}
],
"first_active_date_for_humans":"",
"first_active_date_for_date_format":"",
"last_active_date_for_humans":"",
"last_active_date_for_date_format":"",
"last_touchpoint_at_for_humans":"3 weeks ago",
"last_touchpoint_at_for_date_format":"2019-04-08"
},
{
"id":123106,
"account_id":"123",
"event_account_id":"cus_dwrc8udx8czvte",
"event_user_id":"111111",
"role_id":null,
"phone":null,
"mobile_phone":null,
"email":"simranistesting2@gmail.com",
"salutation":null,
"title":null,
"mailing_street":null,
"mailing_city":null,
"mailing_state":null,
"mailing_postal_code":null,
"mailing_country":null,
"active_days":"0",
"first_active_date":null,
"last_active_date":null,
"first_name":"11",
"last_name":"222",
"role_name":null,
"team":null,
"original_source":null,
"type":null,
"date_of_birth":null,
"linkedin_profile":null,
"twitter_profile":null,
"facebook_profile":null,
"business_email":null,
"product_user":"0",
"last_touchpoint_date":"2019-04-26",
"last_touchpoint_time":"12:49:21",
"last_touchpoint_at":"2019-04-26 12:49:21",
"external_billing_user_id":null,
"external_crm_user_id":null,
"external_ticket_user_id":null,
"external_account_id":null,
"created_on":null,
"last_login_on":null,
"updated_on":null,
"created_at":"2019-04-26 09:55:26",
"updated_at":"2019-04-26 12:49:21",
"external_ticket_user_name":null,
"external_ticket_account_id":null,
"ticket_last_login_at":null,
"custom_user_company_id":null,
"custom_company_id":null,
"role":null,
"first_active_date_readable":"",
"last_active_date_readable":"",
"last_touchpoint_at_readable":"2 days ago",
"custom_columns":[
{
"name":"custom_user_company_id",
"label":"Custom User Company Id",
"type":"string",
"required":""
},
{
"name":"custom_company_id",
"label":"Custom Company Id",
"type":"string",
"required":""
}
],
"first_active_date_for_humans":"",
"first_active_date_for_date_format":"",
"last_active_date_for_humans":"",
"last_active_date_for_date_format":"",
"last_touchpoint_at_for_humans":"2 days ago",
"last_touchpoint_at_for_date_format":"2019-04-26"
}
],
"first_page_url":"https:\/\/local.customersuccessbox.dev\/api\/v1_1\/user\/111111?page=1",
"from":1,
"last_page":1,
"last_page_url":"https:\/\/local.customersuccessbox.dev\/api\/v1_1\/user\/111111?page=1",
"next_page_url":null,
"path":"https:\/\/local.customersuccessbox.dev\/api\/v1_1\/user\/111111",
"per_page":20,
"prev_page_url":null,
"to":3,
"total":3
}

CURL example

curl --location --request GET "https://{domain}.customersuccessbox.com/api/v1_1/user/111111" \
--header "Authorization: Bearer {secret_api_key}" \
--header "Content-Type: application/json" \