Skip to main content
GET
/
salesReps
/
{id}
Get a single Sales Rep by its id
curl --request GET \
  --url https://commerce.driv.ly/api/salesReps/{id} \
  --header 'Authorization: <api-key>'
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "user": "<string>",
  "phone": "<string>",
  "phoneNumber": "<string>",
  "leads": [
    123
  ],
  "acceptNewLeads": true,
  "assignedLeads": "<string>",
  "creditBands": [
    "Excellent (750-900)"
  ],
  "templates": [
    123
  ]
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { salesReps } from '@drivly/commerce'

const sdk = new SDK(...)

const salesReps = await sdk.salesReps.findOne(salesRepsId: string): Promise<salesReps>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Sales Rep

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

​
sort
string

sort by field

​
where
Where clause · object

pass a where query to constrain returned documents (complex type, see documentation)

Example:
{
  "or": [
    { "color": { "equals": "mint" } },
    {
      "and": [
        { "color": { "equals": "white" } },
        { "featured": { "equals": false } }
      ]
    }
  ]
}
​
limit
number

limit the returned documents to a certain number

​
page
number

get a specific page of documents

Response

ok

​
updatedAt
string
required
​
createdAt
string
required
​
name
string | null
​
user
string | null
​
phone
string | null
​
phoneNumber
string | null
​
leads
(number | Lead · object)[] | null
​
acceptNewLeads
boolean | null
​
assignedLeads
string | null
​
creditBands
enum<string>[] | null
Available options:
Excellent (750-900),
Good (700-749),
Fair (650-699),
Fair (600-649),
OK (550-599),
Poor (300-549),
Unknown
​
templates
(number | Template · object)[] | null