Skip to main content

Dealers

This object represents a dealer profile created by a user. Includes business information and submitted applications.

Search dealers​

Search for dealers using a variety of filters. A maximum of 100 results will be returned per request. If additional results are available, they can be retrieved using the nextPage parameter from the previous response.

Authentication

Service Integration with vendor:read scope.

Request

link
nextPagestring (optional)

A cursor for pagination across multiple pages of results. Don't include this attribute on the first call. Use the nextPage parameter from the previous response for each subsequent request.

link
limitnumber (optional)

The maximum number of results to return, between 1 and 100. Defaults to 100.

link
filterobject
Required
Filters to apply to the search.
Show child attributes
link
userIdsArray of string
Required

The IDs of the users to filter by.

Response

link
dataArray of Dealer (optional)
nullable
The dealers that match the search.
Show child attributes
link
idstring

The unique identifier of the dealer.

link
nextPagestring (optional)
nullable

A cursor for pagination across multiple pages of results. Use this value in the nextPage parameter for the next request.

link
hasMoreboolean

If true, there are more results available. Use the value returned in the nextPage field for the next request.

POST /api/v0/users/searchJSON
{
"nextPage": "eyBsYXN0SWQ6IDEwMDAgfQ==",
"limit": 100,
"filter": {
  "userIds": [
    "23",
    "40"
  ]
}
}
Responseapplication/json
{
"hasMore": false,
"nextPage": null,
"data": [
  {
    "id": "28",
    "user": {
      "id": "23",
      "firstName": "John",
      "lastName": "Doe",
      "username": "jdoe",
      "preferredName": "Johnny",
      "phone": "+15555555555",
      "email": "johnny.test@concat.systems"
    },
    "applications": [
      {
        "id": "5",
        "specialRequests": "Near entrance, please!",
        "status": "pending",
        "tableNumber": "4",
        "dealerRequestTypes": [
          {
            "id": "3",
            "name": "wifi",
            "displayName": "Wi-Fi",
            "paid": true
          }
        ],
        "tableType": {
          "id": "2",
          "name": "largetable",
          "displayName": "Large Table",
          "paid": true
        },
        "dealerArea": {
          "id": "2",
          "name": "Artist Alley"
        },
        "options": [
          {
            "id": "12"
            "name": "Have your own tablecloth?",
            "type": "select",
            "value": "Yes"
          }
        ]
      }
    ],
    "name": "Johnny's Wares",
    "email": "johnny.test.business@concat.systems",
    "addressLine1": "123 Main St",
    "addressLine2": "Apt 1",
    "addressCity": "San Francisco",
    "addressZipcode": "94105",
    "addressCountry": "US",
    "addressState": "CA",
    "options": [
      {
        "id": "9",
        "name": "Business Legal Name",
        "type": "text",
        "value": "Johnny's Wares, LLC"
      },
      {
        "id": "10",
        "name": "Business Phone Number",
        "type": "phone",
        "value": "+15555555555"
      }
    ]
  }
]
}