Retrieve fields

GET

/fields

Last modified:2025-06-10 05:46:25

x-apidog-folder:Metadata/Fields

x-apidog-name:metadata

Retrieves a list of fields or a specific fields by ID

Request

Authorization

Add parameter in header

apikey

Example:

apikey: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

Example

[
    {
        "id": "gen_random_uuid()",
        "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
        "name": "string",
        "internal_name": "string",
        "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
        "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
        "field_type": "string",
        "status": "active",
        "description": "string",
        "created_at": "now()",
        "updated_at": "string",
        "field_format": "string",
        "created_by": "users.get_auth_profile_id()",
        "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe"
    }
]

🟢206Success

Modified at 2025-06-10 05:46:25

Retrieve object_field_structures

Create fields