Skip to main content

Get all schemas containing category

GET 
/schemas/by/category/:categoryId

Get all schemas containing category

Request​

Path Parameters

    categoryId categoryIdrequired

    The categoryId of the schema

Query Parameters

    name string

    Search for schema by name

    startDate date-time

    Search by start date

    endDate date-time

    Search by end date

    page integer

    Possible values: >= 1

    Default value: 1

    Specify the page number for pagination (default is 1).

    limit integer

    Default value: 10

    Specify the number of projects per page (default is 10, 0 gets all results).

    orderBy string

    Possible values: [createdAt, type, name, state]

    Field to order the results by (e.g., 'createdAt', 'ownerId'). Default is 'createdAt'.

    sortOrder string

    Possible values: [asc, desc]

    Default value: desc

    'asc' for ascending or 'desc' for descending order. Default is 'desc'.

Responses​

Schemas successfully retrieved

Schema

  • Array [

    • thumbnail urinullable

    Url for schema's thumbnail

    voteThresholdSettings string

    Vote threshold

    state schemaState (string)

    Possible values: [draft, open, closed]

    approvalMethod string
    displayInteractive string
    type string
    name schemaName (string)required

    Possible values: <= 32 characters

    Name of the schema

    id string

    Unique identifier for Schema

    description string

    Possible values: <= 3000 characters

    createdAt date-time

    Time representation of schema creation

    projectId projectId (string)required

    Unique identifier for Project

    category object[]

    Categories for schema

    tags string[]
    categoryId string

    Unique identifier for Category

    displayThumbnail string
    postProcessing string

    A json holding certain regulations for the post processing of submissions assigned to the schema

    data stringrequired

  • ]

Loading...