The Metadata API lets you discover the shape of your workspace: custom fields, pipeline configurations, and workspace members. Before creating records with custom properties, or working with pipelines, you should fetch the relevant metadata.

Endpoints

Object Metadata (Custom Fields)

Each entity type has a fixed standard ID. Use it to retrieve all field definitions — both standard fields and any custom fields your workspace has added.

Standard IDs

Example

# Get all Person field definitions (including custom fields)
curl -G "https://app.usedalil.ai/rest/metadata/objects/standard-id/20202020-e674-48e5-a542-72570eee7213" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Get all Person field definitions (including custom fields)
curl -G "https://app.usedalil.ai/rest/metadata/objects/standard-id/20202020-e674-48e5-a542-72570eee7213" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Get all Person field definitions (including custom fields)
curl -G "https://app.usedalil.ai/rest/metadata/objects/standard-id/20202020-e674-48e5-a542-72570eee7213" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Structure

{
  "data": {
    "getObjectMetadataByStandardId": {
      "fields": [
        {
          "name": "jobTitle",
          "label": "Job Title",
          "type": "TEXT",
          "isCustom": false,
          "isActive": true,
          "isNullable": true,
          "defaultValue": null,
          "description": "The job title of the person",
          "options": null
        },
        {
          "name": "myCustomSelectField",
          "label": "Lead Source",
          "type": "SELECT",
          "isCustom": true,
          "isActive": true,
          "isNullable": true,
          "defaultValue": null,
          "description": "",
          "options": [
            {
              "id": "option-uuid",
              "label": "Website",
              "value": "WEBSITE",
              "position": 0,
              "color": "blue"
            },
            {
              "id": "option-uuid-2",
              "label": "Referral",
              "value": "REFERRAL",
              "position": 1,
              "color": "green"
            }
          ]
        }
      ]
    }
  }
}

{
  "data": {
    "getObjectMetadataByStandardId": {
      "fields": [
        {
          "name": "jobTitle",
          "label": "Job Title",
          "type": "TEXT",
          "isCustom": false,
          "isActive": true,
          "isNullable": true,
          "defaultValue": null,
          "description": "The job title of the person",
          "options": null
        },
        {
          "name": "myCustomSelectField",
          "label": "Lead Source",
          "type": "SELECT",
          "isCustom": true,
          "isActive": true,
          "isNullable": true,
          "defaultValue": null,
          "description": "",
          "options": [
            {
              "id": "option-uuid",
              "label": "Website",
              "value": "WEBSITE",
              "position": 0,
              "color": "blue"
            },
            {
              "id": "option-uuid-2",
              "label": "Referral",
              "value": "REFERRAL",
              "position": 1,
              "color": "green"
            }
          ]
        }
      ]
    }
  }
}

{
  "data": {
    "getObjectMetadataByStandardId": {
      "fields": [
        {
          "name": "jobTitle",
          "label": "Job Title",
          "type": "TEXT",
          "isCustom": false,
          "isActive": true,
          "isNullable": true,
          "defaultValue": null,
          "description": "The job title of the person",
          "options": null
        },
        {
          "name": "myCustomSelectField",
          "label": "Lead Source",
          "type": "SELECT",
          "isCustom": true,
          "isActive": true,
          "isNullable": true,
          "defaultValue": null,
          "description": "",
          "options": [
            {
              "id": "option-uuid",
              "label": "Website",
              "value": "WEBSITE",
              "position": 0,
              "color": "blue"
            },
            {
              "id": "option-uuid-2",
              "label": "Referral",
              "value": "REFERRAL",
              "position": 1,
              "color": "green"
            }
          ]
        }
      ]
    }
  }
}

Key fields in the response:

Pipeline Metadata

List All Pipelines

curl -G "https://app.usedalil.ai/rest/metadata/pipelines" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -G "https://app.usedalil.ai/rest/metadata/pipelines" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -G "https://app.usedalil.ai/rest/metadata/pipelines" \
  -H "Authorization: Bearer YOUR_API_KEY"

Returns each pipeline's id, nameSingular, namePlural, labelSingular, labelPlural, and parent record type. You need namePlural to construct pipeline endpoints and nameSingular for GraphQL search.

Get Pipeline Fields

curl -G "https://app.usedalil.ai/rest/metadata/pipelines/pipeline-uuid-here" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -G "https://app.usedalil.ai/rest/metadata/pipelines/pipeline-uuid-here" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -G "https://app.usedalil.ai/rest/metadata/pipelines/pipeline-uuid-here" \
  -H "Authorization: Bearer YOUR_API_KEY"

Returns the field definitions specific to that pipeline, including stage options, amount fields, date fields, and other custom properties. Use this to know what you can send when creating or updating pipeline records.

Workspace Members

List all members of your workspace. Use member UUIDs to populate owner/assignee fields.

curl -G "https://app.usedalil.ai/rest/workspaceMembers" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -G "https://app.usedalil.ai/rest/workspaceMembers" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl -G "https://app.usedalil.ai/rest/workspaceMembers" \
  -H "Authorization: Bearer YOUR_API_KEY"

The response includes each member's UUID, name, email, and role. Use these UUIDs for:

System Fields to Ignore

The following fields appear in metadata responses but are read-only — never include them in create or update requests:

Use Cases

Discover custom fields before creating records:
Fetch the entity's metadata to find any workspace-specific fields and their valid values before sending a create request.

Build dynamic forms:
Use field metadata to render appropriate input controls — text inputs for TEXT fields, dropdowns for SELECT fields with their options, etc.

Validate SELECT values:
Check the options array to find valid value strings (these are the UPPER_SNAKE_CASE values you send in API requests).

Populate owner/assignee dropdowns:
Fetch workspace members and use their UUIDs for ownerId, assigneeId, and accountOwnerId.

Work with pipelines:
Always fetch pipeline metadata first to get namePlural (for endpoint construction) and field definitions (for knowing what to send).

See Also

• Pipeline — full pipeline workflow that starts with metadata discovery

• Field Types — how to format values for each field type