Skip to main content
GET
/
products
List products
curl --request GET \
  --url https://api.bitgpt.xyz/products \
  --header 'Authorization: <api-key>'
{
  "status": 200,
  "data": [
    {
      "id": "product_0197a8d9-8426-7e71-9edf-26301686ed26",
      "version_group_id": "vg_0197a8d9-8426-7e71-9edf-26301686ed26",
      "is_active": true,
      "name": "Premium API Access",
      "organization_id": "org_0197a8d9-8426-7e71-9edf-26301686ed26",
      "description": "Premium API access with advanced features",
      "image_id": "img_0197a8d9-8426-7e71-9edf-26301686ed26",
      "metadata": {
        "category": "api",
        "tier": "premium"
      },
      "schemas": [
        {
          "id": "schema_0197a8d9-8426-7e71-9edf-26301686ed26",
          "configurations": [
            {
              "id": "config_0197a8d9-8426-7e71-9edf-26301686ed26",
              "type": "monthly",
              "price": 99.99
            }
          ]
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "error": null,
  "log": null,
  "validator": null,
  "support_id": null,
  "message": "Resource created successfully",
  "env": "development"
}

Authorizations

​
Authorization
string
header
required

Send your access token as header Authorization: Bearer {accessToken}

​
Authorization
string
header
required

Your API key that starts with sk_live or sk_test. You can create yours at go.bitgpt.xyz/api-keys.

Response

Products list

​
status
enum<integer>
required

Status code of the response

Available options:
200,
201,
202
​
data
object[]
required

Response data containing the requested object

​
message
string | null
required

Message of the response, human readable

Example:

"Resource created successfully"

​
env
enum<string>
required

API environment

Available options:
development,
production
​
error
string | null

Error message of the response, human readable

Example:

"Invalid email address"

​
log

Useful informaiton, not always present, to debug the response

Examples:
{ "request_id": "req_1234567890" }

"Some pertinent log message"

​
validator
object

Validator response object, each key is the field name and value is the error message

Example:
{
  "email": "Invalid email address",
  "password": "Password is required"
}
​
support_id
string<uuid> | null

Support ID linked to the response, used to identify it when talking with our team

Example:

"support_uuidv7-something-else"