---
title: "List all schemas"
method: GET
path: "/Schemas"
---

# List all schemas

`GET /Schemas`

## Request

- Base URL: `https://app.perk.com/api/v2/scim`
- URL: `https://app.perk.com/api/v2/scim/Schemas`
- Auth: API key in header `Authorization`

Lists all schemas and their attributes.

## Response `200`

Returns `200 OK` and a list of all schema definitions.

- object
  - `schemas` string[]
  - `totalResults` integer
  - `itemsPerPage` integer
  - `startIndex` integer
  - `Resources` object[]
    - `id` string
    - `name` string
    - `description` string
    - `attributes` object[]
      - `name` string
      - `type` string
      - `multiValued` boolean
      - `description` string
      - `required` boolean
      - `subAttributes` object[]
        - `name` string
        - `type` string
        - `multiValued` boolean
        - `description` string
        - `required` boolean
        - `caseExact` boolean
        - `mutability` string
        - `returned` string
        - `uniqueness` string
      - `mutability` string
      - `returned` string
      - `uniqueness` string
    - `meta` object
      - `resourceType` string
      - `location` string
    - `schemaExtensions` object[]
      - `schema` string
      - `required` boolean

---

[API](https://skmtc.dev/perk/apis/scim-server.md) - [All operations](https://skmtc.dev/perk/apis/scim-server/llms.txt) - [OpenAPI document](https://skmtc.dev/perk/apis/scim-server/revisions/cd90f1acd9e2?raw)
