Customization

List Schemas Custom (POST)

Lists custom schema fragments.

POST
/schemas.custom.list
AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

app?array<string>

The list of app names.

cursor?string

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

Formattext
deprecated?booleanDeprecated

Whether only deprecated fragments should be filtered.

is_custom_leaf_type?boolean

Whether the leaf type corresponds to a custom object

is_deprecated?boolean

Whether the fragment has been deprecated.

leaf_type?array<string>

The list of leaf types.

limit?integer

The maximum number of items.

Formatint32
mode?list-mode

The iteration mode to use. If "after", then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If "before", then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

Value in"after" | "before"
prune?array<custom-schema-fragments-list-request-prune>

List of fields which are not required in the payload and can be pruned away.

sort_by?array<string>

The list of fields to sort the items by and how to sort them.

subtype?array<string>

The list of subtypes.

types?array<custom-schema-fragment-type>

Filters for custom schema fragment of the provided types.

Response Body

curl -X POST "https://api.devrev.ai/schemas.custom.list" \  -H "Content-Type: application/json" \  -d '{}'
{
  "next_cursor": "string",
  "prev_cursor": "string",
  "result": [
    {
      "type": "string"
    }
  ]
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}