Qodex.ai

Get Single Vendor TorBox Account

GET https://api.torbox.app/v1/api/vendors/getaccount?user_auth_id=string

Overview

Gets a single user specified by the user_auth_id parameter. This request includes all of the user's TorBox data including their API token. This can be useful if you want to automate their account using your own system. If you have just signed up a user and are requesting their API token, you must wait for the account to be confirmed before getting their API token.

The reason this happens is that once a user has an API key, they are able to use the service, so we only assign API keys once the user has confirmed their email. This is to prevent abuse of the service, even for free accounts. It is not possible to assign the API key before a user has confirmed their email. Once the user has confirmed their email, you will have access to their API token in this request.

For sign up flow on your end, we recommend the following:

  1. User signs up for your service, which in turn, registers an account for them. Get their initial account data from the sign up request.
  2. Tell user to confirm the email sent from account@torbox.app which will be in their email inbox.
  3. While waiting, continuously poll this endpoint until the api_token , returns anything but USER HAS NOT CONFIRMED EMAIL .
  4. Save the API token once you have confirmed that it is not USER HAS NOT CONFIRMED EMAIL .

We understand this is not perfect, but it is this way to prevent abuse of the service, so this much is required, everything else should be relatively simple from here on out!

Authentication

This endpoint requires Bearer token authentication using your TorBox account API Key.

Request Params

| Key | Datatype | Required | Description | | user_auth_id | string | | The auth ID of the user you want to get the account for. The user must be owned by your vendor account under your TorBox account for the request to be successful. |

HEADERS

| Key | Datatype | Required | Description |

RESPONSES

status: OK

{"success":true,"error":false,"detail":"Users retrieved successfully.","data":{"id":0,"created_at":"2023-08-11T06:27:47.192016+00:00","updated_at":"2023-08-30T01:21:48.419152+00:00","email":"XXXXXXXXXXXXXXXXXXXXX","plan":0,"total_downloaded":0,"customer":"cus_XXXXXXXXXXXXXXXX","server":0,"is_subscribed":false,"premium_expires_at":"2024-04-10T22:36:02.884962+00:00","cooldown_until":"2023-12-23T16:12:41.800023+00:00","auth_id":"XXXXXXXXXXXXXXXXXXXXXXXXXXX","user_referral":"XXXXXXXXXXXXXXXXXXXXXXXX","base_email":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXX","api_token":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"}}