Skip to main content
POST
/
v6
/
classes
/
segments
/
query
Query class segments
curl --request POST \
  --url https://sandbox.tight.com/v6/classes/segments/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cursor": "<string>",
  "limit": 123
}
'
{
  "result": "SUCCESS",
  "data": [
    {
      "id": "cls_936413",
      "label": {
        "id": "cll_439512",
        "name": "Region",
        "requiredness": "REQUIRED"
      },
      "name": "Mid-Atlantic",
      "children": [
        {
          "id": "cls_936419",
          "label": {
            "id": "cll_439513",
            "name": "Location",
            "requiredness": "NOT_REQUIRED"
          },
          "name": "District of Columbia, DC",
          "children": [
            {
              "id": "cls_936415",
              "label": {
                "id": "cll_439514",
                "name": "Job Site",
                "requiredness": "NOT_REQUIRED"
              },
              "name": "1611 Connecticut Ave",
              "children": []
            },
            {
              "id": "cls_936418",
              "label": {
                "id": "cll_439514",
                "name": "Job Site",
                "requiredness": "NOT_REQUIRED"
              },
              "name": "1815 Adams Mill Rd",
              "children": []
            }
          ]
        },
        {
          "id": "cls_936420",
          "label": {
            "id": "cll_439513",
            "name": "Location",
            "requiredness": "NOT_REQUIRED"
          },
          "name": "Bethesda, MD",
          "children": [
            {
              "id": "cls_936416",
              "label": {
                "id": "cll_439514",
                "name": "Job Site",
                "requiredness": "NOT_REQUIRED"
              },
              "name": "5511 Cornish Rd",
              "children": []
            }
          ]
        }
      ]
    },
    {
      "id": "cls_936414",
      "label": {
        "id": "cll_439512",
        "name": "Region",
        "requiredness": "REQUIRED"
      },
      "name": "Northeast",
      "children": [
        {
          "id": "cls_936421",
          "label": {
            "id": "cll_439513",
            "name": "Location",
            "requiredness": "NOT_REQUIRED"
          },
          "name": "Boston, MA",
          "children": [
            {
              "id": "cls_936417",
              "label": {
                "id": "cll_439514",
                "name": "Job Site",
                "requiredness": "NOT_REQUIRED"
              },
              "name": "123 Atlantic Avenue",
              "children": []
            }
          ]
        }
      ]
    }
  ],
  "cursor": {
    "after": "<string>",
    "before": "<string>"
  },
  "error": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.tight.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, see Authentication for more detail.

Body

application/json
​
cursor
string | null

Cursor from the previous paginated response

​
limit
integer<int32>

Page size, i.e. number of items to return per page

Required range: x <= 250

Response

Success

Paginated response for class segments

​
result
enum<string>

Result status

Available options:
SUCCESS,
FAILURE
Example:

"SUCCESS"

​
data
object[]

List of class segments

​
cursor
object

Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.