SIsidequestvr
Snippets

Get Snippets

Changed on

Lists snippets newest first. Every snippet is public. Rows omit code -- read a single snippet for the markup. users_id narrows to one owner, q is a case-insensitive substring search over name, slug and description. limit is capped at 50.

get/v2/snippets

Request

  • Base URL
    https://api.sidequestvr.com
  • URL
    https://api.sidequestvr.com/v2/snippets
  • Auth
    none declared

Query parameters

skipinteger

Skips a number of objects from the start of the list. Used for paging.

limitinteger

Limits the number of objects returned.

users_idinteger

Filters the returned rows by the ID of the user that owns the snippet

slugstring

Filters the returned rows by the unique lowercase handle used by the public code endpoint (GET /v2/snippets/code/{slug}). The % (url encoded as %25) can be included in the string as a wildcard.

qstring

Filters the returned rows by Case-insensitive substring search over name, slug and description. The % (url encoded as %25) can be included in the string as a wildcard.

sortOnstring

Sorts the returned object by one or more parameters. Multiple values can be separated by a comma for sorting on multiple fields.

  • name - The name of the snippet
  • created_at - When the snippet was created
descendingstring

Orders the results in descending order based on the sortOn specified. If there are multiple sortOns specified, multiple values can be separated by a comma for each corresponding sortOn.

Response

Success

snippets_idinteger required

The unique ID of the snippet

users_idinteger required

The ID of the user that owns the snippet

user_namestring

The display name of the owning user

namestring required

The name of the snippet

slugstring required

The unique lowercase handle used by the public code endpoint (GET /v2/snippets/code/{slug})

descriptionstring

The description of the snippet

image_urlstring

A URL to the snippet's card image

codestring

The snippet markup. Omitted from list rows -- read a single snippet to get it.

created_atstring date-time required

A timestamp indicating when the snippet was created

last_modifiedstring date-time required

A timestamp indicating the last time the snippet was modified

Example response

[
  {
    "created_at": "1970-04-20 07:10:00+00",
    "last_modified": "1970-04-20 07:10:00+00"
  }
]

Changes