Skip to main content

Get all schemas of projectId

GET 

/schemas/by/project/:projectId

Get all schemas of projectId

Request

Path Parameters

    projectId projectIdrequired

    The projectId to grab data about

Query Parameters

    state string

    The state of the schema

    tags string[]

    The tags of the schema

    includeAssets boolean

    Whether to include schema/project assets in the response or not

    matchTags boolean

    Whether to get the assets that match the schema tags

    name string

    Search for schema by name

    type string

    Search for schema by type

    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).

    sortBy string

    Possible values: [createdAt, name]

    Field to order the results by (e.g., 'createdAt'). 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 [

  • postProcessing string

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

    tags string[]
    description string

    Possible values: <= 3000 characters

    data stringrequired
    voteThresholdSettings string

    Vote threshold

    state schemaState (string)

    Possible values: [draft, open, closed]

    thumbnail string

    Url for thumbnail

    displayThumbnail string
    approvalMethod string
    type string
    createdAt date-time

    Time representation of schema creation

    projectId projectId (string)required

    Unique identifier for Project

    id string

    Unique identifier for Schema

    categoryId string

    Unique identifier for Category

    displayInteractive string
    name stringrequired
    category object[]

    Categories for schema

  • ]

Loading...