List sales reps

Lists the sales reps set up in your organisation, one page at a time.

GET /settings/sales_reps

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/settings/sales_reps?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "data": [
    {
      "created_by": "<unknown>",
      "created_on": "<string>",
      "email_address": "<string>",
      "first_name": "<string>",
      "href": "<string>",
      "id": "<string>",
      "last_name": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<string>",
      "name": "<string>",
      "object": "<string>",
      "status": "<string>",
      "version": 123
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

The records are under data, and pagination holds the cursor for the next page. To filter, add filter_<field>=<value>.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit · integer

The most records to return on one page.

Example:

20

cursor · string

The next_cursor from the previous page, to fetch the page after it.

sort · string

The field to sort by. Prefix it with - to sort in descending order.

Example:

"-created_on"

Response

200 - application/json

One page of sales reps, under data.

data · object[]

Show child attributes

object · string

pagination · object

Cursor paging for the listing.

Show child attributes

url · string