Convert Experiences organizes customer data into Accounts(which are billable entities) and gives Users access to accounts under different roles. By default the **user that initially setups an account**, will get access to that account as the **owner** of it. Other users can be invited to get access to specific/all projects inside that account becoming this way **Collaborators** of that **Account**
Convert Collaborators API is one of 33 APIs that Convert publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Collaborators. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
6 operations
across 6 paths,
and defines 72 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against 3 base URLs: https://api.convert.com/api/v2, https://apidev.convert.com/api/v2, http://apidev.convert.com:5000/api/v2.
6 operations6 paths72 schemas1 GET4 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.convert.com/api/v2
Authentication
API Key, HTTP Bearer, API Key
Resource Areas
1
Authentication & Security 3
Convert Collaborators API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (requestSigning).
It accepts HTTP bearer tokens (secretKey).
An API key is passed in the cookie as sid (cookieAuthentication).
requestSigning — See [API Key Authentication](tag/API-KEY-Authentication) for more information.
secretKey — See [API Key Authentication](tag/API-KEY-Authentication) for more information.
cookieAuthentication — Cookie authentication is used against Convert's own IdentityProvider or third party identity providers and is described more in the "[Cookie Authentication](ta…
Paths & Operations 6
Across 6 paths, the API surfaces 6 operations — 1 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Collaborators 6
Convert Experiences organizes customer data into Accounts(which are billable entities) and gives Users access to accounts under different roles. By default the user that initially…
GET
/accounts/{account_id}/users-accesses
List users and their access permissions for an account
getAccountUsersAccessesList2 params→ 200default
PUT
/accounts/{account_id}/users-accesses/update
Update a user's access permissions for an account
updateAccountUserAccesses1 parambody→ 200default
POST
/accounts/{account_id}/users-accesses/add
Invite a new collaborator to an account
addAccountUserAccesses1 parambody→ 201default
POST
/accounts/{account_id}/users-accesses/delete
Remove a collaborator's access from an account
deleteAccountUserAccesses1 parambody→ 200default
POST
/check-partner
Check partner status for extended API access
checkPartnerbody→ 200default
POST
/auth/accept-invitation
Accept a collaborator invitation
acceptInvitationbody→ 200default
Schemas 72
The contract defines 72 schemas that model the data the API accepts and returns. The most detailed are ExperienceReportingSettings (18 properties), BaseProject (12 properties), CheckPartnerData (3 properties), VisitorInsightsBase (3 properties). Each schema is shown below with its type and property counts.
SE_ProcTypes
string
The statistical methodology used for analyzing experiment results and determining winners. - frequentist: Traditional hypothesis testing approach using p-value…
IntegrationGA3
object
2 properties
CheckPartnerRequestData
object
1 property
TrackingScriptReleaseLatest
SimpleLocation
object
2 properties
UserByEmail
object
1 property
BaseProject
object
12 properties
Project
Represents a Convert project, which is a container for organizing a set of related optimization activities (experiences), their goals, target audiences, associ…
AccountUserAccessesUpdateRequestData
GA_SettingsBase
object
1 property
NumericOutlier
CustomDomainOwnershipVerificationItem
object
3 properties
ProjectStatuses
string
The overall status of a project: - active: The project is active, and experiences within it can run and track data. - inactive: The project is inactive (archiv…
CheckPartnerData
object
3 properties
AccountUserAccessesList
array
A list of AccountUserAccesses objects, each representing a collaborator and their permissions.
NumericOutlierPercentile
VisualEditorUserAgents
string
Predefined User-Agent strings that the Visual Editor can emulate for responsive design and device-specific testing.
AccountUserAccessesDelete
AccountUsersAccessesListResponse
object
Response containing a list of users who have collaborator access to a specific account, detailing their permissions.
1 property
GenerateDebugTokenData
object
2 properties
Percentiles
number
Standard percentile values used for outlier detection thresholds. For example, a min of 5 and max of 95 means orders in the bottom 5% and top 5% of values are…
SE_ProcSettingsBayesian
UpdateAccountUserAccessesByUserEmail
ErrorData
object
3 properties
MetricTypes
string
The primary types of performance metrics calculated by the reporting engine for each goal. - conversionrate: The percentage of visitors who completed the goal…
UTC_Offset
integer
The time offset from Coordinated Universal Time (UTC) in seconds. For example, UTC-5 (EST) would be -18000. UTC+2 would be 7200. Used for interpreting or displ…
SimpleAudienceExpandable
DeleteAccountUserAccessesByUserId
TrackingScriptReleaseManual
SimpleLocationExpandable
GA_Settings
SE_MabSettings
object
Configuration for Multi-Armed Bandit (MAB) traffic allocation. If null, MAB is disabled and manual traffic allocation is used. MAB dynamically allocates more t…
2 properties
DeleteAccountUserAccessesByUserEmail
AccountUserAccessesExpandParams
object
1 property
NumericOutlierNone
SimpleGoal
object
2 properties
SuccessData
object
2 properties
AccountUserAccessesResponse
object
Response detailing the access permissions for a single specified user within an account.
1 property
TrackingScriptReleaseAutomaticApplyOn
object
Configuration for scheduled tracking script updates, specifying the day of the week and time for automatic application of new versions.
2 properties2 required
IntegrationGA4
ProjectGASettingsBase
SimpleGoalExpandable
AccessRoleNames
string
The predefined names for user access roles within the Convert system. Each role grants a specific set of permissions. - owner: Highest level, full control over…
AccountUserAccesses
AccessRoleNamesNoOwner
string
Access roles that can be assigned to collaborators or API keys (excludes the 'owner' role, which is typically unique to the account creator).
UserById
object
1 property
TrackingScriptAvailableVersions
array
A list of available versions for the Convert tracking script, each with a version tag, changelog, release date, and potentially the date it was or will be appl…
IntegrationGA4Base
object
2 properties
VisitorInsightsBase
object
3 properties
Domain
object
A website domain data.
3 properties
ProjectIntegrationGA4
NumericOutlierBase
object
1 property1 required
BaseAccountUserAccesses
BaseAccesses
object
1 property
AccountUserAccessesCreateRequestData
AccountUserAccessesExpandFields
string
SimpleAudience
object
2 properties
NumericOutlierTypes
string
The method used for detecting and handling order outliers in revenue or product count tracking: - none: No outlier detection is applied. - minmax: Orders with…
ExperienceReportingSettings
object
Comprehensive settings governing how an experience's results are reported and analyzed.
18 properties
TrackingScriptRelease
AccessStatuses
string
UpdateAccountUserAccessesByUserId
TrackingScriptReleaseBase
object
Base settings for managing how new versions of the Convert tracking script are applied to the project.
1 property
ProjectIntegrationGA3
NumericOutlierMinMax
SE_ProcSettingsBase
object
1 property
TrackingScriptReleaseScheduled
SE_ProcSettingsFrequentist
AccessCreateUpdateRole
object
2 properties
DNSRecordTypes
string
The type of the DNS record.
AcceptInvitationRequestData
object
1 property
SE_ProcSettings
Overall settings for the statistical engine processing results for this experience.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Convert Collaborators API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
