Get a list of sellers

Get a list of sellers.

Pass a value for the limit parameter in your request if you want retrieve a paginated result. Otherwise API returns a list with all users without pagination.

You can combine parameters for pagination, filtering and ordering. All parameters are independent.

GET /iam/admin/sellers

Get a list of sellers

cURL

curl --request GET \
  --url https://api.gcore.com/iam/admin/sellers \
  --header 'Authorization: <api-key>'

200

[
  {
    "id": 123,
    "email": "[e-mail]",
    "full_name": "<string>",
    "reseller_name": "<string>",
    "company": "<string>",
    "date_joined": "<string>",
    "activated": true,
    "deleted": true,
    "phone": "<string>"
  }
]

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<boolean>

Filter by status of activation:

• true - activated;
• false - non-activated.

Available options: true, false

deleted · enum<string>

Filter by status of deletion:

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

Available options: true, false

reseller_name · string

Filter by reseller's name.

Response

200

application/json

OK.

object[]

object

id · integer · required · read-only

Seller's ID.

email · string<email> · required

Seller's email address.

Maximum string length: 150

full_name · string · required

Seller's full name.

Maximum string length: 255

reseller_name · string · required · read-only

Seller's reseller's name.

company · string · required · read-only

Seller's company.

date_joined · string · required · read-only

Registration date.

activated · boolean · required · read-only

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 · read-only

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 string length: 30

Pattern: ^[a-z0-9+\-()#, *]*$