Account

The authenticated user reveals the details of the API caller's user account as well as certain details about the account of which the user is member. The products array reveals all ActiveProspect products and to which the caller's account is subscribed.

Account

Details of the company account

id
string^[0-9a-fA-F]{24}$

24 character alpha-numeric BSON identifier

sso_id
string^[0-9a-fA-F]{24}$

24 character alpha-numeric BSON identifier

api_key
string

Company-level API key (best practice is to use user-level API key)

enterprise
boolean

Is the account on an an enterprise contract?

name
string

Company name

time_zone
string
type
string
data_retention_in_days
integer

Number of days to retain lead events. Events outside the retention period are automatcially deleted permenantly.

data_truncated_at
string <date-time> (Timestamp)
keen_project_id
string
keen_read_api_key
string
keen_write_api_key
string
pricing_components
Array of objects
self_service_status
string
self_service_status_updated_at
string <date-time> (Timestamp)
cancelled_at
string <date-time>
coupon_code
string
current_period_ends_at
string <date-time>
current_period_started_at
string <date-time>
marketing_reference
string
started_at
string <date-time>
subscription_id
string^[0-9a-fA-F]{24}$

24 character alpha-numeric BSON identifier

lead_ping_enabled
boolean
product_id
string
state
string
Array of objects

List of connected buyers

Array of objects

List of connected sellers

{
  • "id": "64acddadd9b866e066385bd6",
  • "sso_id": "6493820b542ea0521e2a4543",
  • "api_key": "string",
  • "enterprise": true,
  • "name": "Acme, Inc.",
  • "time_zone": "America/New_York",
  • "type": "string",
  • "data_retention_in_days": 0,
  • "data_truncated_at": "2019-08-24T14:15:22Z",
  • "keen_project_id": "string",
  • "keen_read_api_key": "string",
  • "keen_write_api_key": "string",
  • "pricing_components": [
    • { }
    ],
  • "self_service_status": "string",
  • "self_service_status_updated_at": "2019-08-24T14:15:22Z",
  • "cancelled_at": "string",
  • "coupon_code": "string",
  • "current_period_ends_at": "string",
  • "current_period_started_at": "string",
  • "marketing_reference": "string",
  • "started_at": "string",
  • "subscription_id": "string",
  • "lead_ping_enabled": true,
  • "product_id": "lcx",
  • "state": "string",
  • "connected_buyers": [
    • {
      • "id": "string",
      • "name": "string"
      }
    ],
  • "connected_sellers": [
    • {
      • "id": "string",
      • "name": "string"
      }
    ]
}

User

id
string^[0-9a-fA-F]{24}$

24 character alpha-numeric BSON identifier

sso_id
string

The account's ID global across all ActiveProspect products

api_key
string

The user's API key

superuser
boolean

Is the user a super user?

user_admin
boolean

Can the user manage other users and verified domains?

subscription_admin
boolean

Can the user manage subscriptions to TrustedForm, LeadConduit, and SuppressionList?

role_string
string

The user's role (unused)

Value: "user"
first_name
string

The user's first name

last_name
string

The user's last name

email
string

The user's email address

phone
string

The user's phone number

Array of objects (Product)

The list of products available to the account

product_code
string

The code for the current product

Enum: Description
lcx

LeadConduit

trustedform

TrustedForm

suppressionlist

SuppressionList

{}

Credential

One of:
id
required
string^[0-9a-fA-F]{24}$

24 character alpha-numeric BSON identifier

name
required
string

Friendly name for this credential

type
required
string

The type of model changes were performed on: user, token, oauth

Value: "user"
package
required
string

The name of the LeadConduit integration package to which this credential belongs

created_at
string <date-time>
updated_at
string <date-time>
username
required
string non-empty

The username to user for basic authentication

password
required
string non-empty

The password to user for basic authentication

property name*
additional property
any
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "password": "string"
}

Get account

Returns the account information of the caller (based on authentication)

SecurityAPIKey
Responses
200

OK

get/account
Request samples
Response samples
application/json
{
  • "id": "64acddadd9b866e066385bd6",
  • "sso_id": "6493820b542ea0521e2a4543",
  • "api_key": "string",
  • "enterprise": true,
  • "name": "Acme, Inc.",
  • "time_zone": "America/New_York",
  • "type": "string",
  • "data_retention_in_days": 0,
  • "data_truncated_at": "2019-08-24T14:15:22Z",
  • "keen_project_id": "string",
  • "keen_read_api_key": "string",
  • "keen_write_api_key": "string",
  • "pricing_components": [
    • { }
    ],
  • "self_service_status": "string",
  • "self_service_status_updated_at": "2019-08-24T14:15:22Z",
  • "cancelled_at": "string",
  • "coupon_code": "string",
  • "current_period_ends_at": "string",
  • "current_period_started_at": "string",
  • "marketing_reference": "string",
  • "started_at": "string",
  • "subscription_id": "string",
  • "lead_ping_enabled": true,
  • "product_id": "lcx",
  • "state": "string",
  • "connected_buyers": [
    • {
      • "id": "string",
      • "name": "string"
      }
    ],
  • "connected_sellers": [
    • {
      • "id": "string",
      • "name": "string"
      }
    ]
}

Update account

Update my account information

SecurityAPIKey
Request
Request Body schema: application/json
required

Update an existing Account

data_retention_in_days
integer

Number of days to retain lead events. Events outside the retention period are automatcially deleted permenantly.

data_truncated_at
string <date-time> (Timestamp)
Responses
200

OK

put/account
Request samples
application/json
{
  • "data_retention_in_days": 0,
  • "data_truncated_at": "2019-08-24T14:15:22Z",
  • "self_service_status_updated_at": "2019-08-24T14:15:22Z"
}
Response samples
application/json
{
  • "id": "64acddadd9b866e066385bd6",
  • "sso_id": "6493820b542ea0521e2a4543",
  • "api_key": "string",
  • "enterprise": true,
  • "name": "Acme, Inc.",
  • "time_zone": "America/New_York",
  • "type": "string",
  • "data_retention_in_days": 0,
  • "data_truncated_at": "2019-08-24T14:15:22Z",
  • "keen_project_id": "string",
  • "keen_read_api_key": "string",
  • "keen_write_api_key": "string",
  • "pricing_components": [
    • { }
    ],
  • "self_service_status": "string",
  • "self_service_status_updated_at": "2019-08-24T14:15:22Z",
  • "cancelled_at": "string",
  • "coupon_code": "string",
  • "current_period_ends_at": "string",
  • "current_period_started_at": "string",
  • "marketing_reference": "string",
  • "started_at": "string",
  • "subscription_id": "string",
  • "lead_ping_enabled": true,
  • "product_id": "lcx",
  • "state": "string",
  • "connected_buyers": [
    • {
      • "id": "string",
      • "name": "string"
      }
    ],
  • "connected_sellers": [
    • {
      • "id": "string",
      • "name": "string"
      }
    ]
}

List all credentials

Get the list of all credentials.

SecurityAPIKey
Responses
200

OK

get/credentials
Request samples
Response samples
application/json
[
  • {
    • "id": "5fd4371e940df5a34a3888b2",
    • "name": "string",
    • "type": "user",
    • "package": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "username": "string",
    • "password": "string"
    }
]

Create a new credential

Create a new credential

SecurityAPIKey
Request
Request Body schema: application/json
required

Create a new credential

One of:
name
required
string

Friendly name for this credential

type
required
string

The type of model changes were performed on: user, token, oauth

Value: "user"
package
required
string

The name of the LeadConduit integration package to which this credential belongs

username
required
string non-empty

The username to user for basic authentication

password
required
string non-empty

The password to user for basic authentication

property name*
additional property
any
Responses
201

Created

post/credentials
Request samples
application/json
{
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "username": "string",
  • "password": "string"
}
Response samples
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "password": "string"
}

Get a credential

Returns the credential matching the specified ID

SecurityAPIKey
Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the credential to get

Responses
200

OK

get/credentials/{id}
Request samples
Response samples
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "password": "string"
}

Update a credential

Update an existing credential matching the specified ID

SecurityAPIKey
Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the credential to update

Request Body schema: application/json
required

Create a new credential

One of:
name
required
string

Friendly name for this credential

type
required
string

The type of model changes were performed on: user, token, oauth

Value: "user"
package
required
string

The name of the LeadConduit integration package to which this credential belongs

username
required
string non-empty

The username to user for basic authentication

password
required
string non-empty

The password to user for basic authentication

property name*
additional property
any
Responses
200

OK

put/credentials/{id}
Request samples
application/json
{
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "username": "string",
  • "password": "string"
}
Response samples
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "password": "string"
}

Delete a credential

Deletes the credential matching the specified ID

SecurityAPIKey
Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the credential to delete

Responses
200

OK

delete/credentials/{id}
Request samples
Response samples
application/json
{
  • "id": "5fd4371e940df5a34a3888b2",
  • "name": "string",
  • "type": "string",
  • "package": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "username": "string",
  • "password": "string"
}

Get user

This singleton resource returns the currently authenticated user

SecurityAPIKey
Responses
200

OK

get/user
Request samples
Response samples
application/json
{}

Update user

Resource for User or user admin to toggle modal flag

SecurityAPIKey
Request
path Parameters
id
required
string (ID) ^[0-9a-fA-F]{24}$

ID of the user to update

Request Body schema: application/json
required

UI State flags are passed as boolean values. Response will return the flag as a date-time string or null value

object

User interface state

Responses
200

OK

put/user/{id}
Request samples
application/json
{
  • "ui_state": {
    • "has_seen_free_account_modal": true
    }
}
Response samples
application/json
{}