StatusPhrases.GetAll

Try it in Swagger

Endpoint

Request Schema

Headers

Header Required Notes
X-Api-Key Required when tenant is not resolved by subdomain Resolves the tenant/customer database.
Authorization: Bearer {token} Required for authorized endpoints Get a token from Auth/Token, Session/Create, or Employee/SignIn.

Query Parameters

Field Type Required Notes
fieldAppOnly bool No When true, returns only Field Check In phrases (StatusPhrase.Options[15]). Defaults to false (all user-selectable phrases). Auto-status phrases are always excluded.

This endpoint does not accept a JSON request body.

Expected Response Schema

Status Codes

Status Notes
200 OK Returned by the controller for this operation.
400 Bad Request Invalid query parameter.

Success Body

Response type: StatusPhraseListDto

Field Type Max Length Notes
phrases StatusPhraseDto[] Ordered by title. Each item includes:
code int Status phrase code.
title string Display title.
phrase string Phrase text to send as Notes report.
comment bool When true, send as an office note (comment / isOfficeNote).

Response Sample

{
  "phrases": [
    {
      "code": 41,
      "title": "PICKED UP CNR",
      "phrase": "We picked up a certificate of no records.",
      "comment": false
    }
  ]
}