Get a List of Codes for a Domain's Field

get

https://{environment}.origamirisk.com/OrigamiApi/api/{domain}/Codes

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Retrieves the list of valid code values for a specific coded/lookup field on a domain entity. Use this endpoint to discover the allowed values for fields where NeedsLookup or IsCodeList is true (as reported by the /{domain}/Fields endpoint). This is useful for populating dropdown or selection fields correctly when inserting or updating records.

GET /api/Claim/Codes?fieldName=Custom2Code
Ex: Returns all valid code values for the Custom2Code field on the Claim domain.

Results are paginated (default 100 per page, max 100) and can be filtered using either a simple text search or the Origami Advanced Search syntax. Optionally, pagination metadata (total count, total pages) can be included in the response, though this may impact performance on large code lists.

Path Params

domain

string

required

Defaults to Claim

This is the Domain Name as identified in the response of the /api/Domains endpoint. Ex: the "Claims" domain (DomainID 1) would be referenced by its name value of Claim. Values are case-sensitive. Client-defined Domains should start with "Custom."

Query Params

fieldName

string

required

This is the PropertyName as identified in the response of the /api/{domain}/Fields endpoint as a coded field. Must be a field where IsCodeList or NeedsLookup is true.

filter

string

Accepts either a simple text string (matched against Display Code and Description) or the Origami Advanced Search syntax for more complex filtering. If advanced filtering fails, the system silently falls back to simple text filtering. Only codes matching the filter criteria will be included in the response.
This dual-mode approach means callers can use a straightforward search string (e.g., "Workers") for quick lookups, or the full Origami filter syntax for precise control.

pageNumber

string

Defaults to 1

Default is 1. If you are fetching subsequent pages of data you must provide the desired page number.

pageSize

string

Defaults to 100

Number of results per page. Minimum 1, maximum 100. Values exceeding 100 are capped at 100.

includePaginationInfo

boolean

Defaults to false

When true, includes pagination metadata (TotalCount, TotalPages) in the response. Note: May result in slower response times for large code lists.

Response

Overview

200