# ActiveProspect Developer Documentation ## Docs - [Create a new credential](https://developers.activeprospect.com/api-reference/account/create-a-new-credential.md): Create a new credential - [Create user settings](https://developers.activeprospect.com/api-reference/account/create-user-settings.md): Create a new user settings document, adding it to the list of all user settings in the account. - [Delete a credential](https://developers.activeprospect.com/api-reference/account/delete-a-credential.md): Deletes the credential matching the specified ID - [Get a credential](https://developers.activeprospect.com/api-reference/account/get-a-credential.md): Returns the credential matching the specified ID - [Get a user settings](https://developers.activeprospect.com/api-reference/account/get-a-user-settings.md): Fetch a single user settings document. - [Get account](https://developers.activeprospect.com/api-reference/account/get-account.md): Returns the account information of the caller (based on authentication) - [Get user](https://developers.activeprospect.com/api-reference/account/get-user.md): This singleton resource returns the currently authenticated user - [List all credentials](https://developers.activeprospect.com/api-reference/account/list-all-credentials.md): Get the list of all credentials. - [Sync account data from SSO](https://developers.activeprospect.com/api-reference/account/sync-account-data-from-sso.md): Syncs account data from SSO using the provided `sso_account_id`. - [Update a credential](https://developers.activeprospect.com/api-reference/account/update-a-credential.md): Update an existing credential matching the specified ID - [Update a user settings](https://developers.activeprospect.com/api-reference/account/update-a-user-settings.md): Update an existing user settings document. - [Update account](https://developers.activeprospect.com/api-reference/account/update-account.md): Update my account information - [Update user](https://developers.activeprospect.com/api-reference/account/update-user.md): Resource for User or user admin to toggle modal flag - [Fetch a ping limit counter](https://developers.activeprospect.com/api-reference/caps-and-limits/fetch-a-ping-limit-counter.md): Get a counter for a single ping limit. - [Get a cap counter](https://developers.activeprospect.com/api-reference/caps-and-limits/get-a-cap-counter.md): Returns the cap associated to the ID - [List all cap counters](https://developers.activeprospect.com/api-reference/caps-and-limits/list-all-cap-counters.md): Get the counters for all active caps. Caps that haven't received lead traffic during the current interval will not be included. - [List all ping limit counters](https://developers.activeprospect.com/api-reference/caps-and-limits/list-all-ping-limit-counters.md): Get the counters for all active ping limits. Ping limits that haven't received ping traffic during the current interval will not be included. - [Run Certificate Operations](https://developers.activeprospect.com/api-reference/certificate-url/run-certificate-operations.md): The TrustedForm Certificate API is able to perform multiple operations based on the parameters sent in the request. Each operation is demonstrated in the request body documentation. The overall outcome of the operations is revealed by the `outcome` property. Best practice is to base your purchase de… - [Get a changelog](https://developers.activeprospect.com/api-reference/changelogs/get-a-changelog.md): Returns the changelog matching the specified ID - [List all changelogs](https://developers.activeprospect.com/api-reference/changelogs/list-all-changelogs.md): Get the list of all changelogs. - [List changes to a Flow](https://developers.activeprospect.com/api-reference/changelogs/list-changes-to-a-flow.md): Lists all the changes made to a flow - [Claiming a Certificate](https://developers.activeprospect.com/api-reference/claiming-certificates/claiming-a-certificate.md): TrustedForm account holders who are receiving certified leads can use the TrustedForm API to claim the certificate provided with each lead. Doing so - [Claiming Certificates](https://developers.activeprospect.com/api-reference/claiming-certificates/claiming-certificates.md): ### Testing - [Get connection by ID](https://developers.activeprospect.com/api-reference/connections/get-connection-by-id.md): Retrieves a connection by its unique identifier, SSO Connection Id, or Invitation Id. This endpoint allows clients to fetch detailed information about a specific connection. - [List all destinations configured for the account](https://developers.activeprospect.com/api-reference/destinations/list-all-destinations-configured-for-the-account.md): The `/destinations` resource is used to query destinations which have been configured in the LeadConduit app. If no destinations are configured for your account, this resource will return an empty array. Destinations returned from this endpoint can be [added to flows](/docs/leadconduit/api/tag/Flows… - [Create a new entities](https://developers.activeprospect.com/api-reference/entities/create-a-new-entities.md): Create a new entities - [Delete a entity](https://developers.activeprospect.com/api-reference/entities/delete-a-entity.md): Deletes the entity matching the specified ID - [Get a entity](https://developers.activeprospect.com/api-reference/entities/get-a-entity.md): Returns the entity matching the specified ID - [List all entities](https://developers.activeprospect.com/api-reference/entities/list-all-entities.md): Get the list of all entities. - [List changes to an Entity](https://developers.activeprospect.com/api-reference/entities/list-changes-to-an-entity.md): List all the changes made to an entity - [Update a entity](https://developers.activeprospect.com/api-reference/entities/update-a-entity.md): Update an existing entity matching the specified ID - [Get event metrics counts](https://developers.activeprospect.com/api-reference/events/get-event-metrics-counts.md): Returns event count for the given timeframe and filters (Keen `leadconduit.events`). - [Get funnel event metrics](https://developers.activeprospect.com/api-reference/events/get-funnel-event-metrics.md) - [Get median event metrics](https://developers.activeprospect.com/api-reference/events/get-median-event-metrics.md) - [Get unique event metrics counts](https://developers.activeprospect.com/api-reference/events/get-unique-event-metrics-counts.md) - [Select unique event metrics](https://developers.activeprospect.com/api-reference/events/select-unique-event-metrics.md) - [Create a field](https://developers.activeprospect.com/api-reference/fields/create-a-field.md): Create a new custom field, adding it to the list of all fields in the account. - [Delete a field](https://developers.activeprospect.com/api-reference/fields/delete-a-field.md): Delete an existing custom field. If a field is referenced in a flow and is deleted, an HTTP 202 will be returned but that flow will continue to operate as though the field still exists. The errors for each flow will be returned to the response body and the recorded on the flow's error property. More… - [Get a field](https://developers.activeprospect.com/api-reference/fields/get-a-field.md): Fetch a single field. - [List all fields](https://developers.activeprospect.com/api-reference/fields/list-all-fields.md): Get the list of all fields, including all standard and custom fields. Optionally, provide a `flow_id` query parameter to return only the fields referenced by a specific flow. - [List changes to a Field](https://developers.activeprospect.com/api-reference/fields/list-changes-to-a-field.md): Lists all the changes made to a Field - [List data types](https://developers.activeprospect.com/api-reference/fields/list-data-types.md): Lists the data [types](/docs/leadconduit/api/tag/Types/) available for fields or vars - [List variables](https://developers.activeprospect.com/api-reference/fields/list-variables.md): The `/vars` resource is used to identify which data points have been collected in your flows. This resource is used to determine which data points are available for exports and stats queries. - [Update a field](https://developers.activeprospect.com/api-reference/fields/update-a-field.md): Update an existing custom field. Standard fields cannot be updated. - [Test firehose's ability to write to AWS S3 or Azure Blob Storage](https://developers.activeprospect.com/api-reference/firehose/test-firehoses-ability-to-write-to-aws-s3-or-azure-blob-storage.md): The `/firehose` resource is used to validate cloud storage credentials and test write access to a specified bucket/container. - [Create a new flow](https://developers.activeprospect.com/api-reference/flows/create-a-new-flow.md): Create a new flow, adding it to the list of all flows in the account. The caller may specify an ID for a flow, provided it is a valid BSON ID - [Delete an existing flow](https://developers.activeprospect.com/api-reference/flows/delete-an-existing-flow.md): Once a flow is deleted it will no longer accept leads. Attempting to submit leads to a deleted flow will result in an HTTP 404. Returns the flow as it existed at the time of deletion. - [Deploy a saved flow to production](https://developers.activeprospect.com/api-reference/flows/deploy-a-saved-flow-to-production.md): A flow defines how lead submissions will be handled. In order to make a flow's latest state active for lead handling, it must be deployed. Because changes to a flow can be made without deploying them, you are free make flow updates without affecting current lead handling. Put another way, a deploym… - [Get a flow](https://developers.activeprospect.com/api-reference/flows/get-a-flow.md): Returns the flow associated to the ID - [Get flow field usages](https://developers.activeprospect.com/api-reference/flows/get-flow-field-usages.md): Count the number of leads processed by flow field. This tells you which and how much each flow field was used today. You can change the timeframe using the `timeframe` parameter (i.e. `timeframe=previous_30_days`), though this is discouraged because this query is fairly heavy. - [List all flows](https://developers.activeprospect.com/api-reference/flows/list-all-flows.md): Returns all the flows associated to an account - [List fields associated to the Flow](https://developers.activeprospect.com/api-reference/flows/list-fields-associated-to-the-flow.md): List fields associated to the Flow - [Retrieve metadata for a specific source within a flow](https://developers.activeprospect.com/api-reference/flows/retrieve-metadata-for-a-specific-source-within-a-flow.md): Returns metadata about a source within a specified flow, including parameters, account details, and operational settings. - [Submit data to a source within a flow](https://developers.activeprospect.com/api-reference/flows/submit-data-to-a-source-within-a-flow.md): Submits JSON lead data to a specified source within a flow and returning a success response in JSON. - [Update all flows](https://developers.activeprospect.com/api-reference/flows/update-all-flows.md): Update all flows for an account. Only users with superuser access can run this. - [Update an existing flow](https://developers.activeprospect.com/api-reference/flows/update-an-existing-flow.md): Update an existing Flow - [Create a recipient invitation](https://developers.activeprospect.com/api-reference/invitations/create-a-recipient-invitation.md): Send an invitation to Account's Team and return a recipient pending entity - [Create a source invitation](https://developers.activeprospect.com/api-reference/invitations/create-a-source-invitation.md): Send an invitation to Account's Team and return a source pending entity - [Resend an invitation](https://developers.activeprospect.com/api-reference/invitations/resend-an-invitation.md): Resend an expired or pending invitation. Updates the expiration date and resets the invitation status. Works for both source and recipient invitations. - [About](https://developers.activeprospect.com/api-reference/leadconduit.md) - [Account](https://developers.activeprospect.com/api-reference/leadconduit/account.md) - [Account](https://developers.activeprospect.com/api-reference/leadconduit/account/account.md) - [User](https://developers.activeprospect.com/api-reference/leadconduit/account/authenticateduser.md) - [Credential](https://developers.activeprospect.com/api-reference/leadconduit/account/credential.md) - [Caps and Limits](https://developers.activeprospect.com/api-reference/leadconduit/caps-and-limits.md) - [Cap](https://developers.activeprospect.com/api-reference/leadconduit/caps-and-limits/cap.md) - [Cap counter](https://developers.activeprospect.com/api-reference/leadconduit/caps-and-limits/cap-counter.md) - [Pinglimit](https://developers.activeprospect.com/api-reference/leadconduit/caps-and-limits/pinglimit.md) - [Pinglimit counter](https://developers.activeprospect.com/api-reference/leadconduit/caps-and-limits/pinglimit-counter.md) - [Changelogs](https://developers.activeprospect.com/api-reference/leadconduit/changelogs.md) - [Changelog](https://developers.activeprospect.com/api-reference/leadconduit/changelogs/changelog.md) - [Connections](https://developers.activeprospect.com/api-reference/leadconduit/connections.md) - [Destinations](https://developers.activeprospect.com/api-reference/leadconduit/destinations.md) - [Destination](https://developers.activeprospect.com/api-reference/leadconduit/destinations/destination.md) - [Entities](https://developers.activeprospect.com/api-reference/leadconduit/entities.md) - [Entity](https://developers.activeprospect.com/api-reference/leadconduit/entities/entity.md) - [Field](https://developers.activeprospect.com/api-reference/leadconduit/fields/field.md) - [Type](https://developers.activeprospect.com/api-reference/leadconduit/fields/type.md) - [Firehose](https://developers.activeprospect.com/api-reference/leadconduit/firehose.md) - [Flows](https://developers.activeprospect.com/api-reference/leadconduit/flows.md) - [Destination](https://developers.activeprospect.com/api-reference/leadconduit/flows/destination.md) - [Flow](https://developers.activeprospect.com/api-reference/leadconduit/flows/flow.md) - [Meta](https://developers.activeprospect.com/api-reference/leadconduit/flows/meta.md) - [Invitations](https://developers.activeprospect.com/api-reference/leadconduit/invitations.md) - [Leads](https://developers.activeprospect.com/api-reference/leadconduit/leads.md) - [Event](https://developers.activeprospect.com/api-reference/leadconduit/leads/event.md) - [Onboards](https://developers.activeprospect.com/api-reference/leadconduit/onboards.md) - [Report](https://developers.activeprospect.com/api-reference/leadconduit/reports/report.md) - [Router](https://developers.activeprospect.com/api-reference/leadconduit/router.md) - [Rules](https://developers.activeprospect.com/api-reference/leadconduit/rules.md) - [Rule](https://developers.activeprospect.com/api-reference/leadconduit/rules/rule.md) - [Rule set](https://developers.activeprospect.com/api-reference/leadconduit/rules/rule-set.md) - [Status](https://developers.activeprospect.com/api-reference/leadconduit/system/status.md) - [Templates](https://developers.activeprospect.com/api-reference/leadconduit/templates.md) - [Types](https://developers.activeprospect.com/api-reference/leadconduit/types.md) - [Variables](https://developers.activeprospect.com/api-reference/leadconduit/variables.md) - [Variables](https://developers.activeprospect.com/api-reference/leadconduit/variables/variables.md) - [Fetch a single event](https://developers.activeprospect.com/api-reference/leads/fetch-a-single-event.md) - [List all events](https://developers.activeprospect.com/api-reference/leads/list-all-events.md): The `/events` resource is used to query [events](/docs/leadconduit/api/tag/Leads/#tag/Leads/schema/Event) generated while handling leads. For each lead, one event is generated for each configured [flow step](/docs/leadconduit/api/tag/Flows/#tag/Flows/schema/Flow) that handles the lead. After lead pr… - [List all events for exports](https://developers.activeprospect.com/api-reference/leads/list-all-events-for-exports.md): The `/events` resource is used to query [events](/docs/leadconduit/api/tag/Leads/#tag/Leads/schema/Event) generated while handling leads. For each lead, one event is generated for each configured [flow step](/docs/leadconduit/api/tag/Flows/#tag/Flows/schema/Flow) that handles the lead. After lead pr… - [Retrieve statistics on events](https://developers.activeprospect.com/api-reference/leads/retrieve-statistics-on-events.md): The `/events/stats` resource is used to count events. The event count can be grouped by any field collected with the lead or appended to the lead during flow processing. The API also supports returning results in JSON or CSV using the appropriate MIME type in the `Accept` header. - [Search leads](https://developers.activeprospect.com/api-reference/leads/search-leads.md): The `/search/leads` resource is used to find leads using full text search. For example, you can search for `fred` in `texas` using: - [Complete buyer delivery setup](https://developers.activeprospect.com/api-reference/onboards/complete-buyer-delivery-setup.md): Completes the buyer delivery setup process for a connection. This endpoint performs several operations: - [Create a new onboard](https://developers.activeprospect.com/api-reference/onboards/create-a-new-onboard.md): Creates a new onboard record to track a buyer connection setup process. Requires an invitation_id which will be used to retrieve the associated connection. - [Get an onboard](https://developers.activeprospect.com/api-reference/onboards/get-an-onboard.md): Returns the onboard record associated with the given ID - [List all onboards](https://developers.activeprospect.com/api-reference/onboards/list-all-onboards.md): Returns all the onboard records for the authenticated account. Onboards track the status of buyer connection setup processes. - [Update an existing onboard](https://developers.activeprospect.com/api-reference/onboards/update-an-existing-onboard.md): Updates an existing onboard record. When the status is set to `completed`, the backend automatically triggers the buyer delivery setup process by calling the `/onboard/buyer` endpoint internally. This will: - [Generate Ping URL](https://developers.activeprospect.com/api-reference/ping/generate-ping-url.md): When a lead vendor only provides a TrustedForm Certificate URL, you can generate a new Ping URL for the Certificate. Simply append `/ping_url` to the Certificate URL and perform an unauthenticated `GET`. - [Retrieve Ping Data](https://developers.activeprospect.com/api-reference/ping/retrieve-ping-data.md): Retrieve ping data directly from a Certificate. When a lead vendor only provides a TrustedForm Certificate URL, Ping data can be retrieved directly without a Ping URL. Simply append `/ping` to the Certificate URL and perform an authenticated `GET`. A certificate's Ping data can be accessed two w… - [Retrieving Ping Data](https://developers.activeprospect.com/api-reference/ping/retrieving-ping-data.md): Retrieve ping data directly from a Certificate. - [Clear's a reports share token](https://developers.activeprospect.com/api-reference/reports/clears-a-reports-share-token.md): Unshare a report by clearing the report's token. - [Create a new report](https://developers.activeprospect.com/api-reference/reports/create-a-new-report.md): Create a new report, adding it to the list of all reports in the account. - [Create a report without saving it](https://developers.activeprospect.com/api-reference/reports/create-a-report-without-saving-it.md): Create a report but don't save it. The report definition is provided in the post body and the time range is provided as query parameters. - [Delete a report](https://developers.activeprospect.com/api-reference/reports/delete-a-report.md): Delete an existing report. - [Fetch a report's token](https://developers.activeprospect.com/api-reference/reports/fetch-a-reports-token.md): Share a report by generating a new token for a report. Once the token is retrieved, you can use it in place of the ID in the `/reports/:id` endpoint. - [Fetch a single report](https://developers.activeprospect.com/api-reference/reports/fetch-a-single-report.md): Get the report definition for an individual report. The parameter can be a report id, which requires passing the api_key or a report token, which does not. - [Get report metadata](https://developers.activeprospect.com/api-reference/reports/get-report-metadata.md): Get the metadata for a report that was shared. - [List all reports](https://developers.activeprospect.com/api-reference/reports/list-all-reports.md): Get the list of all reports. - [Run a report](https://developers.activeprospect.com/api-reference/reports/run-a-report.md): Run a report that was previously created. The parameter can be an id or token. The time range is provided as query parameters. - [Update an existing report](https://developers.activeprospect.com/api-reference/reports/update-an-existing-report.md): Update an existing report. Note that the token cannot be updated with this call. Use the /share endpoint to generate a new token and `/unshare` to clear it. - [Retrieve Certificate Insights](https://developers.activeprospect.com/api-reference/retrieving-insights/retrieve-certificate-insights.md): Account holders using TrustedForm Insights who are receiving certified leads can use the following request to retrieve TrustedForm metadata for the lead contained in a TrustedForm certificate. - [Create a router](https://developers.activeprospect.com/api-reference/routers/create-a-router.md): Create a new custom router, adding it to the list of all routers in the account. - [Get a router](https://developers.activeprospect.com/api-reference/routers/get-a-router.md): Fetch a single router. - [List all routers](https://developers.activeprospect.com/api-reference/routers/list-all-routers.md): Get the list of all routers. - [Update a router](https://developers.activeprospect.com/api-reference/routers/update-a-router.md): Update an existing custom router. Standard routers cannot be updated. - [Get system status](https://developers.activeprospect.com/api-reference/system/get-system-status.md): Shows the general status of the system - [Get UI app version](https://developers.activeprospect.com/api-reference/system/get-ui-app-version.md): Returns the current UI app version. - [Check-in](https://developers.activeprospect.com/api-reference/trustedform-certificate-check-in/check-in.md): Check-in supports various actions for a TrustedForm Certificate (e.g. extending the claim period on certificates). - [Overview](https://developers.activeprospect.com/api-reference/trustedform/v2/overview.md) - [Overview](https://developers.activeprospect.com/api-reference/trustedform/v3/overview.md) - [Certificate URL](https://developers.activeprospect.com/api-reference/trustedform/v4/certificate-url.md) - [Sending on Ping](https://developers.activeprospect.com/api-reference/trustedform/v4/certificate/sending-on-ping.md) - [Types](https://developers.activeprospect.com/api-reference/trustedform/v4/certificate/types.md) - [Operations](https://developers.activeprospect.com/api-reference/trustedform/v4/operations.md) - [Insights](https://developers.activeprospect.com/api-reference/trustedform/v4/operations/insights.md) - [Match Lead](https://developers.activeprospect.com/api-reference/trustedform/v4/operations/match-lead.md) - [Retain](https://developers.activeprospect.com/api-reference/trustedform/v4/operations/retain.md) - [InsightsParameters](https://developers.activeprospect.com/api-reference/trustedform/v4/operations/schemas/InsightsParameters.md) - [InsightsResult](https://developers.activeprospect.com/api-reference/trustedform/v4/operations/schemas/InsightsResult.md) - [MatchLeadParameters](https://developers.activeprospect.com/api-reference/trustedform/v4/operations/schemas/MatchLeadParameters.md) - [MatchLeadResult](https://developers.activeprospect.com/api-reference/trustedform/v4/operations/schemas/MatchLeadResult.md) - [RetainParameters](https://developers.activeprospect.com/api-reference/trustedform/v4/operations/schemas/RetainParameters.md) - [RetainResult](https://developers.activeprospect.com/api-reference/trustedform/v4/operations/schemas/RetainResult.md) - [VerifyParameters](https://developers.activeprospect.com/api-reference/trustedform/v4/operations/schemas/VerifyParameters.md) - [VerifyResult](https://developers.activeprospect.com/api-reference/trustedform/v4/operations/schemas/VerifyResult.md) - [Verify](https://developers.activeprospect.com/api-reference/trustedform/v4/operations/verify.md) - [Viewing a Certificate](https://developers.activeprospect.com/api-reference/viewing-certificates/viewing-a-certificate.md): When you claim a certificate, TrustedForm returns either a "consent" or "consent+data" JSON response depending on your subscription. You can "view" this same response by sending a `GET` request to the same endpoint. - [ActiveProspect Documentation](https://developers.activeprospect.com/index.md): Explore our guides and examples to integrate with our APIs - [Authentication](https://developers.activeprospect.com/pages/leadconduit/authentication.md) - [Authentication](https://developers.activeprospect.com/pages/trustedform/authentication.md) - [Adding TrustedForm Consent Tags](https://developers.activeprospect.com/pages/trustedform/consent-tagging.md) - [Getting Started](https://developers.activeprospect.com/pages/trustedform/getting-started.md) - [Implementing the TrustedForm Certify Web SDK](https://developers.activeprospect.com/pages/trustedform/implementing-trustedform-certify.md) - [Validate API](https://developers.activeprospect.com/pages/trustedform/validating-certificates.md) ## OpenAPI Specs - [trustedform_v3](https://developers.activeprospect.com/api-reference/trustedform_v3.json) - [trustedform_v2](https://developers.activeprospect.com/api-reference/trustedform_v2.yaml) - [claims_api-v4](https://developers.activeprospect.com/api-reference/claims_api-v4.yaml) - [leadconduit_api](https://developers.activeprospect.com/api-reference/leadconduit_api.json)