Generate one-time auth token
Generate a single-use authentication token for the specified account – Reseller/Partner account required. If the email does not exist and an externalAccountId is provided, the system will automatically add that email as a member of the organization.
OpenAPI
````yaml get /api/v2/auth/account/oneTimeAuthToken
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/auth/account/oneTimeAuthToken:
get:
tags:
- Authorization
summary: Generate one-time auth token
description: >-
Generate a single-use authentication token for the specified account –
Reseller/Partner account required. If the email does not exist and an
externalAccountId is provided, the system will automatically add that
email as a member of the organization.
parameters:
- name: externalAccountId
in: query
description: Your system’s customer / account ID (optional)
required: false
example: acct_123abc
schema:
type: string
- name: customerId
in: query
description: >-
Alternative to externalAccountId. Provide either this or your
externalAccountId (optional)
required: false
example: acct_123abc
schema:
type: string
- name: email
in: query
description: Email address of the account user
required: true
example: user@example.com
schema:
type: string
responses:
'200':
description: Auth token created
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
message:
type: string
example: Success
authToken:
type: string
example: token_here
'400':
description: Missing or invalid parameters
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: email is required
'401':
description: 'Unauthorized : missing / bad API key or token'
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Unauthorized Request
'404':
description: No account found OR caller lacks access
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: 'Account not found for key: user@example.com'
'500':
description: Unexpected server error
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: An error occurred while fetching authentication token
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
