Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Use your Bright Data API Key as a Bearer token in the Authorization header.

How to authenticate:

  1. Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
  2. Include the API Key in the Authorization header of your requests
  3. Format: Authorization: Bearer YOUR_API_KEY

Example:

Learn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication

Path Parameters

PARTNER_NAME
string
required

Name of the proxy zone which will service your request.

Query Parameters

active
enum<number>

can be 0, 1 or empty.

If 0 - return only not active customers.

If 1 - only active.

If empty - return all.

Available options:
0,
1,
null
limit
integer
default:1000

max amount of account to return on 1 page

page
integer

number of the page to return

Response

200 - application/json

OK

The response is of type object.