---
title: "Get predicate schema by predicate id"
method: GET
path: "/api/v2/public/schema/predicates/{id}/"
tags: ["Schema API"]
---

# Get predicate schema by predicate id

`GET /api/v2/public/schema/predicates/{id}/`

## Path parameters

- `id` string, required

## Response `200`

- PublicAPIPredicate
  - `id` string — Predicate ID
  - `name` string — Predicate Name
  - `description` string, required — Predicate Description
  - `type` string, required — Can be int, intrange, float, text, url, entity and location
  - `objectChoices` PublicAPIPredicateObjectChoice[], required — If set, it defines the value choice set.
    - `value` union, required
      - integer — Integer value. Used for int type.
      - number — Number value. Used for float predicate types.
      - string — String value. Used for text, url and date predicate types. For date type, the value is ISO-8601 formatted (YYYY-MM-DD, YYYY-MM, or YYYY).
      - object — Entity reference object. Used for entity and location types.
        - `id` integer, required — Entity ID
        - `properties` object[], required — Array of properties. Same format as the root properties. Since this is a reference, it only includes the name property.
      - object — Integer Range Value
        - `gte` integer, required — Range start numeric value (inclusive)
        - `lte` integer, required — Range end numeric value (inclusive)
      - object — JSON object value. Used for json predicate type. For json type, the schema is predicate specific. See predicate schema resource for details.
  - `objectEntityTypes` PublicAPIEntityReference[], required — For predicates of type entity, this field defines the allowed entity types.
    - `id` integer, required
    - `properties` PublicAPIEntityProperty[], required — Array of properties. Since this is a reference, it only includes the name property.
      - `predicateId` string, required — Property Predicate ID
      - `instances` PublicAPIEntityPropertyInstance[], required — Array of Property Instances
        - `value` union, required
          - integer — Integer value. Used for int type.
          - number — Number value. Used for float predicate types.
          - string — String value. Used for text, url and date predicate types. For date type, the value is ISO-8601 formatted (YYYY-MM-DD, YYYY-MM, or YYYY).
          - object — Entity reference object. Used for entity and location types.
            - `id` integer, required — Entity ID
            - `properties` object[], required — Array of properties. Same format as the root properties. Since this is a reference, it only includes the name property.
              - …
          - object — Integer Range Value
            - `gte` integer, required — Range start numeric value (inclusive)
            - `lte` integer, required — Range end numeric value (inclusive)
          - object — JSON object value. Used for json predicate type. For json type, the schema is predicate specific. See predicate schema resource for details.
        - `citations` PublicAPICitation[], required — Arrays of citations
          - `title` string, required — Citation Title
          - `url` string, required — Citation URL value
  - `objectJsonPredicates` PublicAPIPredicateReference[], required — For predicates of type json, this defines the associated subpredicates. The object value will be an object where each key is a subpredicate ID and each value is the associated subpredicate value.
    - `id` string, required — Predicate ID
  - `isFilterable` boolean, required — Can be used to filter entities with filterPredicateId query string param

## Other responses

- `400`
- `403`
- `404`
- `429`
- `500`

---

[API](https://skmtc.net/golden/apis/golden-api-v2.md) · [All operations](https://skmtc.net/golden/apis/golden-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/golden/golden-api-v2/revisions/66afe5c78608/schema)