List Service Groups

v1.0.0

Use this endpoint to return a list of Service Groups for the requested location. If not specified, the business location defaults to the primary business location. Use the offset and limit parameters to control the page start and size. Default offset is 0, limit is 20, maximum is 100. Use the other query parameters to filter the results further.

Input

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "locationId": {
      "type": "string"
    },
    "offset": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "format": "int32"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "companyId": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "imageUrl": {
            "type": "string"
          },
          "isDeleted": {
            "type": "boolean"
          },
          "locationId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "object": {
            "type": "string"
          },
          "type": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      }
    },
    "hasMore": {
      "type": "boolean"
    },
    "object": {
      "type": "string"
    },
    "total": {
      "type": "integer",
      "format": "int32"
    },
    "url": {
      "type": "string"
    }
  },
  "additionalProperties": false
}