List Person Filter Options

GET

https://api.aventure.vc/v1/people/filters

GET

/v1/people/filters

curl https://api.aventure.vc/v1/people/filters \
     -H "Authorization: Bearer <token>"

{
  "arrayFilterEntry": [
    {
      "chart": [
        {
          "amount": 1,
          "end": 1,
          "start": 1
        }
      ],
      "choiceOption": [
        {
          "label": "string",
          "value": "string",
          "scope": {
            "max": 1,
            "min": 1
          }
        }
      ],
      "controlType": "checkbox",
      "filterKey": "string",
      "label": "string",
      "choiceOptionTotal": 1,
      "choiceOptionTruncated": true,
      "filterMeta": {
        "applicableTypeRecord": [
          "Company"
        ],
        "requestBinding": {
          "path": [
            "string"
          ],
          "rangeBound": [
            "string"
          ],
          "valueShape": "string"
        },
        "ui": {
          "headquartersOption": {
            "country": [
              {
                "country": "string",
                "state": [
                  {
                    "city": [
                      "string"
                    ],
                    "state": "string"
                  }
                ]
              }
            ]
          }
        }
      },
      "scope": {
        "max": 1,
        "min": 1
      }
    }
  ],
  "rangeFilterEntry": [
    {
      "chart": [
        {
          "amount": 1,
          "end": 1,
          "start": 1
        }
      ],
      "choiceOption": [
        {
          "label": "string",
          "value": "string",
          "scope": {
            "max": 1,
            "min": 1
          }
        }
      ],
      "controlType": "checkbox",
      "filterKey": "string",
      "label": "string",
      "choiceOptionTotal": 1,
      "choiceOptionTruncated": true,
      "filterMeta": {
        "applicableTypeRecord": [
          "Company"
        ],
        "requestBinding": {
          "path": [
            "string"
          ],
          "rangeBound": [
            "string"
          ],
          "valueShape": "string"
        },
        "ui": {
          "headquartersOption": {
            "country": [
              {
                "country": "string",
                "state": [
                  {
                    "city": [
                      "string"
                    ],
                    "state": "string"
                  }
                ]
              }
            ]
          }
        }
      },
      "scope": {
        "max": 1,
        "min": 1
      }
    }
  ],
  "filtersMeta": {
    "defaultOptionLimit": 1,
    "distributionKey": [
      "string"
    ],
    "generatedAt": "2024-01-15T09:30:00Z",
    "includeDistribution": true,
    "includePrivate": true,
    "includedTypeRecord": [
      "string"
    ],
    "optionMode": "TOP_RESULTS",
    "requestedTypeGroup": "string",
    "defaultTypeGroup": "Organization",
    "typeGroupMembership": [
      {
        "typeGroup": "Organization",
        "typeRecord": [
          "Company"
        ]
      }
    ]
  }
}

Returns available people filter facets — the option inventory a filter can take (titles, statuses, and the like), not people; searching or listing people by title uses the people search and list operations with their filters.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Response headers

X-RateLimit-LimitintegerOptional

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-RemainingintegerOptional

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-ResetintegerOptional

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

arrayFilterEntrylist of objects

Array filter entries

rangeFilterEntrylist of objects

Range filter entries

filtersMetaobject or nullOptional

Metadata for the generated filter option set

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

406

Not Acceptable Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error