Skip to main content
GET
/
iam
/
admin
/
sellers
Get a list of sellers
curl --request GET \
  --url https://api.gcore.com/iam/admin/sellers \
  --header 'Authorization: <api-key>'
[
  {
    "id": 123,
    "email": "jsmith@example.com",
    "full_name": "<string>",
    "phone": "<string>",
    "reseller_name": "<string>",
    "company": "<string>",
    "date_joined": "<string>",
    "activated": true,
    "deleted": true
  }
]

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

​
limit
integer

The maximum number of items.

​
offset
integer

Offset relative to the beginning of list.

​
ordering
string

The parameter using for sorting data.

Default sort order is ascending. Put - before value for descending sort order: -id.

  • id - sort by seller's ID.
  • email - sort by seller's email.
  • full_name - sort by seller's full name.
  • date_joined - sort by seller's registration date.
  • activated - sort by activated field.
  • deleted - sort by deleted field.

Use comma separated string for multiple-field sorting.

Example:

"activated,-date_joined"

​
id
number

Filter by id.

Example:

1

​
id__in
string

Filter by id list.

Use comma separated string for multiple values.

Example:

"1,2,3"

​
id__contains
string

Filter by part of ID.

Example:

"22"

​
email
string<email>

Filter byemail address.

​
full_name
string

Filter by full name.

​
activated
enum<string>

Filter by status of activation:

  • true - activated;
  • false - non-activated.
​
deleted
enum<string>

Filter by status of deletion:

  • true — only deleted;
  • false — only non-deleted clients;
  • other value — return all.
​
reseller_name
string

Filter by reseller's name.

Response

OK.

  • object[]
  • object

Simple array without pagination

​
id
integer
required

Seller's ID.

​
email
string<email>
required

Seller's email address.

Maximum length: 150
​
full_name
string
required

Seller's full name.

Maximum length: 255
​
reseller_name
string
required

Seller's reseller's name.

​
company
string
required

Seller's company.

​
date_joined
string
required

Registration date.

​
activated
boolean
required

Show the activation status of seller's account:

  • true – a seller has clicked on the activation link and has set up a password;
  • false – a seller hasn't clicked on the activation link.
​
deleted
boolean
required

Show the deletion status of seller's account:

  • true – a seller has been deleted;
  • false – a seller is active.
​
phone
string

Seller's phone number.

Maximum length: 30
⌘I