B2B Edition
B2B Edition APIs
Storefront APIs
Sales Rep
Super Admin

Super Admin

Super Admin Begin Masquerade

PUT /sales-reps/{userId}/companies/{companyId}/begin-masq

Request

Update status for when a super admin masquerades as a company by userId and companyId. Equivalent Storefront GraphQL API Mutation: superAdminBeginMasquerade. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • companyId in path - string
    required
    Unique company ID in B2B Edition
  • userId in path - string
    required
    Unique user ID in B2B Edition

Response

OK

Body

object | application/json

  • code    number
    required

  • message    string
    required

    >= 1 characters

  • data    object
    required

example-1

Super Admin End Masquerade

PUT /sales-reps/{userId}/companies/{companyId}/end-masq

Request

Update status for when a super admin masquerades as a company by userId and companyId. Equivalent Storefront GraphQL API Mutation: superAdminEndMasquerade. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • companyId in path - string
    required
    Unique ID of a company in B2B Edition
  • userId in path - string
    required
    Unique ID of a user in B2B Edition

Response

OK

Body

object | application/json

  • code    number
    required

  • message    string
    required

    >= 1 characters

  • data    object
    required

example-1

Get Masquerading Company

GET /sales-reps/{customerId}/companies/masquerading

Request

Get company information for the current super admin masquerading. Equivalent Storefront GraphQL API Query: superAdminMasquerading. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • customerId in path - string
    required
    Unique ID of a company in BigCommerce

example

Response

OK

Body

object | application/json

  • code    number
    required

  • message    string
    required

    >= 1 characters

  • data    object
    required

example-1

Get Company List by Super Admin

GET /sales-reps/{salesRepId}/companies

Request

Get companies by Super Admin ID. Equivalent Storefront GraphQL API Query: superAdminCompanies. For more information, see the GraphQL Playground.

Authentication

  • Authorization in header in the format of Bearer {{token}}

Parameters

  • salesRepId in path - string
    required
    Unique ID of super admin
  • offset in query - integer
  • limit in query - integer
  • orderBy in query - string
  • sortBy in query - string
    Example: DESC, ASC
  • q in query - string
  • companyId in query - string

example

Response

OK

Body

object | application/json

  • code    number
    required

  • message    string
    required

    >= 1 characters

  • data    object
    required

example-1

Did you find what you were looking for?
Sales RepSuper Admin Begin Masquerade