---
title: "Get a list of flags by entity type"
method: GET
path: "/v1/flags"
tags: ["ReferenceData"]
---

# Get a list of flags by entity type

`GET /v1/flags`

Retrieves a collection of flags filtered by entity type (required scope flags:read)

## Query parameters

- `entityType` 'contactNote' | 'job' | 'defInvoiceItem' | 'contactUser' | 'salesOpportunity' | 'contactNotePriority' | 'assetDefect' | 'quote' | 'proforma' | 'invoice' | 'purchaseOrder' | 'creditNote' | 'deliveryNote' | 'appPayment' | 'salesOrder' | 'jobGroup' — Enumeration representing the types of entities that can have flags<p>Possible values:</p><ul><li><b>contactNote</b>: Flag for contact notes</li><li><b>job</b>: Flag for jobs</li><li><b>defInvoiceItem</b>: Flag for default invoice items</li><li><b>contactUser</b>: Flag for contact users</li><li><b>salesOpportunity</b>: Flag for sales opportunities</li><li><b>contactNotePriority</b>: Flag for contact note priorities</li><li><b>assetDefect</b>: Flag for asset defects</li><li><b>quote</b>: Flag for quotes</li><li><b>proforma</b>: Flag for proformas</li><li><b>invoice</b>: Flag for invoices</li><li><b>purchaseOrder</b>: Flag for purchase orders</li><li><b>creditNote</b>: Flag for credit notes</li><li><b>deliveryNote</b>: Flag for delivery notes</li><li><b>appPayment</b>: Flag for app payments</li><li><b>salesOrder</b>: Flag for sales orders</li><li><b>jobGroup</b>: Flag for job groups</li></ul>
- `sortBy` 'name' | 'createdAt' — Represents the fields that can be used to sort flags<p>Possible values:</p><ul><li><b>name</b>: The name</li><li><b>createdAt</b>: The description</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>
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadFlagModel
  - `items` ReadFlagModel[]
    - `id` integer — The unique identifier of the flag
    - `name` string — The name of the flag
    - `description` string — The description of the flag
    - `color` string — The color associated with the flag
    - `createdAt` string, date-time — The UTC timestamp of when this flag was created
  - `pageNumber` integer
  - `pageSize` integer
  - `totalItemCount` integer

## 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)