TOtopi
ops
ops-sales-agents

List sales agents

Changed on

Get a list of all portal sales agents or sales agents for provided seller_id

get/ops/sales-agents

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/sales-agents
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: ops-seller:read

Query parameters

seller_idstring regexp

Seller Id

Example:739b63c2-9e58-4964-b38d-4ebb424de242
exclude_suspendedboolean

Whether to exclude suspended sales agents

Response

OK response.

Example response

{
  "agents": [
    {
      "email": "alice@example.com",
      "external_agent_id": "abc123",
      "id": "auth0|63881a171828b3997ad1b3fc",
      "language": "abc123",
      "last_login": "1970-01-01T00:00:01Z",
      "name": "abc123",
      "phone": "abc123",
      "seller_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "seller_store_id": "abc123",
      "status": "abc123",
      "topi_relevant": false
    }
  ]
}

Changes

  • ac6979514123Revision changes
    • info

      api operation id portal_sales_agents.findAgents removed and replaced with portal_sales_agents#findAgents

  • 7ff7ee94b30eRevision changes
    • info

      api operation id portal_sales_agents#findAgents removed and replaced with portal_sales_agents.findAgents

    • info

      api tag ops-sales-agents added