---
title: "Group Types Search"
method: POST
path: "/curricular-skills/group-types/search"
tags: ["Group Types Search"]
---

# Group Types Search

`POST /curricular-skills/group-types/search`

## Request

- Base URL: `https://api.lightcast.io/alumni-pathways`
- URL: `https://api.lightcast.io/alumni-pathways/curricular-skills/group-types/search`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.emsicloud.com/connect/token` scopes: `alumni-pathways`

Lets you retrieve all Group Types that fit a set of parameters. There are a wide range of filter options including a text based search. You can also sort across multiple properties (ascending or descending as you see fit).

## Request body

- GroupTypeSearchRequest
  - `data` object, required
    - `type` string, required
    - `attributes` object, required
      - `filter` object, required
        - `site` object, required
          - `in` string[], required: Example: `"in": ["site1", "site2"]`
        - `ids` union
          - object
            - `in` string[], required: Example: `"in": ["000000000000000000000000", "012345678901234567890123"]`
            - `exclude` string[]: Example: `"exclude": ["000000000000000000000000", "012345678901234567890123"]`
          - object
            - `in` string[]: Example: `"in": ["000000000000000000000000", "012345678901234567890123"]`
            - `exclude` string[], required: Example: `"exclude": ["000000000000000000000000", "012345678901234567890123"]`
        - `textFilter` object
          - `query` string, required
          - `fields` string[]
        - `text` string: Example: <br/>`"text": "search string"` <br/>`"text": "\"exact match search\""`
        - `groupTypeClass` object
          - `in` string[], required: Example: `"in": ["5d782386a05145a6a0fa20bf", "8yt82386a05145a6a0fa23be"]`
      - `sort` array[]: Example:<br/> `[ ["label", "ascending"], ["groups", "descending"] ]`
        - string[]
      - `limit` number, required
      - `offset` number

## Response `200`

OK

- GroupTypeSearchResponse
  - `meta` unknown
  - `data` object[]
    - `type` string, required
    - `id` string, required
    - `attributes` object, required
      - `site` string, required
      - `label` string, required
      - `groupTypeClass` object, required
        - `id` string, required
        - `name` string, required
        - `sortOrder` number
      - `groups` object[]
        - `id` string, required
        - `title` string, required

## Other responses

- `400`: bad request
- `403`: You don't have access to traveltime data.

---

[API](https://skmtc.dev/lightcast/apis/alumni-pathways-2-0.md) - [All operations](https://skmtc.dev/lightcast/apis/alumni-pathways-2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/lightcast/apis/alumni-pathways-2-0/revisions/fc66b9877391?raw)