Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

ReferenceData

Get a list of flags by entity type

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

get/v1/flags

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>

Example:contactNote

The entity type to filter flags by

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>

Example:name

The field to sort items by

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>

Example:ascending

The direction to apply the sort

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger
pageSizeinteger
totalItemCountinteger

Example response

{
  "items": [
    {
      "id": 12345,
      "name": "Urgent",
      "description": "This flag indicates urgent items",
      "color": "#FF0000",
      "createdAt": "2022-11-29T16:50:16.0000000+00:00"
    }
  ]
}