---
title: "Get a list of note types"
method: GET
path: "/v1/noteTypes"
tags: ["NoteTypes"]
---

# Get a list of note types

`GET /v1/noteTypes`

Retrieve a paged collection of note types (required scope notes:read)

## Query parameters

- `sortBy` 'name' — Represents the fields that can be used to sort note types<p>Possible values:</p><ul><li><b>name</b>: The name of the note type</li></ul>
- `direction` 'ascending' | 'descending' — Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>
- `name` string[]
- `id` integer[]
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadNoteTypeModel — A paged collection of items
  - `items` ReadNoteTypeModel[] — The items returned for the requested page
    - `id` integer — The unique identifier of the note type
    - `name` string — The name of the note type
    - `defaultOwnedByUserId` integer, nullable — The default owner for notes of this type
    - `createdAt` string, date-time — The UTC timestamp of when this note type was created
  - `pageNumber` integer — The page number of the response where 1 is the first page
  - `pageSize` integer — The number of items requested for the current page
  - `pageItemCount` integer — The number of items returned in the current page

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)