Communities::Spaces::Post::VideoEmbed

List Video Embeds

Changed on

List video embeds for a post

get/communities/spaces/posts/{post_id}/video_embeds

Request

Path parameters

post_idstring required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

Video Embed ID

public_idstring nullable

Video Embed public ID

post_idinteger

ID of the Post the video is attached to

provider'youtube' | 'vimeo' | 'loom' | 'voomly' | 'null' nullable

Video provider name, auto-detected from the URL. One of youtube, vimeo, loom, voomly.

urlstring nullable

Source URL of the video

dataobject nullable

Provider-specific metadata (arbitrary key/value pairs)

workspace_idinteger nullable

Workspace ID the post belongs to

created_atstring date-time nullable

Created at

updated_atstring date-time nullable

Updated at

Example response

[
  {
    "id": 501,
    "public_id": "EfGhIj",
    "post_id": 101,
    "provider": "youtube",
    "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "data": {
      "video_id": "dQw4w9WgXcQ",
      "duration": 212
    },
    "workspace_id": 42,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z"
  }
]

Changes

    • warning

      added the new undefined enum value to the / response property for the response status

    • info

      added the new optional query request parameter per_page

    • info

      for the path request parameter post_id, the type was generalized from integer to string

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status