GovDash
Menu

Metadata

List custom field definitions

Active custom fields for an object type, for the authenticated team and its sub-teams, with the allowed values of picklist fields.

gethttps://api.govdash.us/v1/meta/custom-fields

Authorization

Authorizationstringheaderrequired

Your API key as a bearer token, for example Bearer gd_live_....

See Authentication for how to create a key.

Query parameters

cursorstringquery

Return the objects after this cursor: the previous page's pageInfo.endCursor, or any edge's cursor. Omit it to start at the first page.

limitintegerquerydefault: 20

Number of objects to return, from 1 to 100. Defaults to 20.

sort_byenumquery

Sort by name or configured order. By default, grouped by team in configured order.

One of:nameorder

sort_directionenumquery

Sort direction. Keep the same sort and filters when following a cursor.

One of:ascdesc

namestringquery

Only definitions whose name contains this text, ignoring case.

entity_typeenumqueryrequired

Object type the custom fields belong to.

One of:opportunity

Headers

govdash-versionenumheaderrequired

The dated API version this request is written against. Responses keep that version's shape after newer versions ship.

One of:2026-11-17

Response

200 · application/json

One page of a list.

edgesobject[]

The objects on this page, in list order.

Show child attributes
nodeobject
Show child attributes
idstring

Custom field identifier.

team_idstring

Team that owns the custom field.

namestring

Custom field name.

typeenum

Kind of value the field holds.

One of:TEXTTEXTAREANUMBERNUMBER_RANGECURRENCYCURRENCY_RANGEDATEDATE_RANGEBOOLEANSELECTMULTI_SELECTURLPERCENTAGEFORMULARATING

optionsstring[] | null

Allowed values for SELECT and MULTI_SELECT fields, null for other types.

cursorstring

Pass as cursor to fetch the objects after this one.

pageInfoobject

Where this page sits in the list.

Show child attributes
hasNextPageboolean

Whether more objects follow this page. Pass endCursor as cursor to fetch them.

hasPreviousPageboolean

Whether this page was fetched after a cursor.

startCursorstring | null

The first edge's cursor. null when the page is empty.

endCursorstring | null

The last edge's cursor. null when the page is empty.

Errors

Every error returns a stable error.code to branch on and an error.message that says what went wrong, like the examples below. See Errors for how to handle each one.

400bad_request

A query parameter is malformed, such as a changed or reused cursor.

The cursor is invalid. Pass an `endCursor` or edge `cursor` unchanged.

401unauthorized

The API key is missing, mistyped, revoked, or expired.

The bearer token is missing or invalid.

403forbiddenclassification_out_of_scope

The key's service account doesn't have the permission this needs, or your team's access has ended.

You do not have permission to perform this action.

413payload_too_large

The request body is over 1 MB.

The request body must not exceed 1 MB.

422validation_failed

The request is well formed, but GovDash won't make this change. The message says why, when it can.

The request failed validation.

429rate_limited

You sent too many requests. Wait the seconds in the retry-after header, then retry.

This access token exceeded its read rate limit.

500internal_error

Something went wrong on GovDash's side, usually a bug. Retry with backoff, and check before retrying a create.

An unexpected error occurred.

503service_unavailable

GovDash is briefly unavailable and didn't run the request. Retry after retry-after.

The service is temporarily unavailable. Try again later.

get/v1/meta/custom-fields

List custom field definitions

Sends a real request to GovDash with the key you enter.

Query parameters
enum, required

Object type the custom fields belong to.

string

Return the objects after this cursor: the previous page's pageInfo.endCursor, or any edge's cursor. Omit it to start at the first page.

integer

Number of objects to return, from 1 to 100. Defaults to 20.

enum

Sort by name or configured order. By default, grouped by team in configured order.

enum

Sort direction. Keep the same sort and filters when following a cursor.

string

Only definitions whose name contains this text, ignoring case.

Bearer

Kept in this tab only. Use a key you can revoke.

Request
Response
Send the request to see the response.