API Requests support using query string parameters in order to specify the type of value being provided in POST or PATCH requests, or the desired type of value to be returned in a GET request. Depending on the type of field, the available lookup types will vary. Only one lookup type (Display Value, Identifier or Client Code) can be requested per field.

The syntax for using query string parameters to utilize different lookup types will be static across all types:

An example of how the request is modified to have the API respond with the display values for the Phase and Status of the Assignment.

Example of how the fields are returned when this parameter is provided:

Query string parameters for lookup fields can be used in combination with the parameters to limit the response to a subset of fields:

For most lookup types, the other available option is Identifier. When no lookup type is specified, the stored database value will be returned by default.

An example of how the request is modified to have the API respond with the identifiers for the Phase and Status of the Assignment.

Example of how the fields are returned when this parameter is provided:

Client Codes can be used as query string parameters for lookup fields, similarly to how Display Value and Identifiers behave.

Example of how the fields are returned when this parameter is provided:

Client Codes can also be provided for POST or PATCH requests when this parameter is supplied, and the corresponding value will be used when the record is created or updated.