Get how-it-works blocks

Get the 'how it works' blocks for a company, filtered by type.

Auth: Both — authentication bearer token. Target company comes from the company_id query param; no ownership/partner-tree scoping, so any authenticated Partner or Account user can read any company's blocks. Role only changes which company_id you pass.

Rate limit: No rate limit.

Request

  • Query: company_id (integer, required) — must be an existing account.
  • Query: type (string, optional) — one of landing_page, widget. Note: the controller filters where('type', $type); when you omit type it filters on type = null, so pass type to get rows back.

Response{ data. } envelope (nested: controller wraps its own status/data array).

  • data.status (string) — literal "success".
  • data.data (array) — list of RsBlock records. Each item: id, company_id, type, content, image_url, image_direction, status, created_at, updated_at, deleted_at.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Required. Company whose blocks to fetch.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json