Rocket Lawyer Interviews API is one of 8 APIs that Rocket Lawyer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Interviews. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and release notes.
This API exposes
9 operations
across 5 paths,
and defines 44 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api-sandbox.rocketlawyer.com/partners/v1/auth, https://api.rocketlawyer.com/partners/v1/auth.
9 operations5 paths44 schemas1 DELETE4 GET1 PATCH2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Rocket Lawyer Interviews API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerTokenAuth).
Paths & Operations 9
Across 5 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Interviews 9
POST
/interviews
Create an Interview
create-interviewbody→ 201400401
GET
/interviews
List All Interviews
list-interviews1 param→ 200400401
GET
/interviews/{interviewId}
Retrieve Interview by ID
retrieve-interview1 param→ 200400401
PUT
/interviews/{interviewId}
Update an Interview
update-interview1 parambody→ 200400401
DELETE
/interviews/{interviewId}
Delete an Interview
delete-interview1 param→ 204400401
POST
/interviews/{interviewId}/completions
Complete an Interview
complete-interview1 param→ 201400401
GET
/interviews/{interviewId}/pages/{pageId}
Retrieve a Page
2 params→ 200400401
PATCH
/interviews/{interviewId}/pages/{pageId}
Update an Interview Page's Answers
update-page2 paramsbody→ 200400401
GET
/interviews/{interviewId}/tagged-answers
Retrieve Interview Data
retrieve-tagged-answers1 param→ 200400401
Schemas 44
The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are interview (12 properties), question (6 properties), pageResponse (5 properties), field (5 properties). Each schema is shown below with its type and property counts.
answersPayload
object
A key-value object to include all provided answers. Each key refers to a answer unique identifier in the system (Flfmulpp4orak5), with its value being the actu…
help
string
interviewUpdateRequest
object
1 property
binder
object
Return the binderId and documentId.
2 properties2 required
pageId
string
An opaque ID for a page. Do not depend on the format of these IDs.
nextPageDataPatchRequest
object
1 property
binderId
string
The unique identifier of the Binder to which the interview will be added. ⚠️ This parameter is mutually exclusive with partyEmailAddress. ⚠️
storageType
string
Specifies the type of backend data storage strategy used for this interview.
pageDataDisplayCommon
object
5 properties4 required
pageDataDisplayCyclicalElements
object
4 properties3 required
pageDataReference
object
2 properties2 required
partyEmailAddress
string
The email address of the party for whom the interview is being created. If provided, a new Binder is created for this email address. ⚠️ This parameter is mutua…
templateId
string
The unique identifier of the document template to be used for the interview. This template defines the structure and content of the interview. Retrieve a list…
tamEntityClass
string
The classification of the field within the entity. This defines the type or category of the field, aligning with the entity's role and characteristics.
fieldType
object
Metadata type suggesting what this field should contain and loosely describing how a UI might display it for user interaction. The field type provides hints on…
interview
object
12 properties7 required
pageDataDisplaySingleElements
object
2 properties2 required
tamRole
string
A list of roles that the entity plays within the interview context. Roles define the specific function or position of the entity in the interview, such as 'App…
field
object
The UI can choose which UI display component is best to display the type of data represented by these names.
5 properties4 required
tamClass
string
The classification of the entity. Can be either: - Person - Organization - Property
previousPageDataPatchRequest
object
1 property
tamEntity
object
Represents an entity involved in the interview process. Entities can be individuals, organizations, or properties, each playing specific roles within the conte…
4 properties3 required
question
object
6 properties4 required
InterviewCompleteResponse
object
1 property
pageResponse
object
5 properties
previewMimeType
string
Mime-type for the preview.
pagePatchRequest
object
5 properties
create_interview_with_party_email
1 required
tamField
object
Each field corresponds to a data point in the interview, allowing for the collection and retrieval of user-entered information. These fields are pre-filled wit…
5 properties4 required
currentPageDataPatchRequest
object
1 property
create_interview_with_binder
1 required
InterviewCreateRequest
interviewsGetResponse
array
pageDataDisplayCyclical
preview
object
2 properties2 required
tam
object
The Tagged Answer Model (TAM) represents the structured format for injecting data into an interview or retrieving data from an interview. This model maps the i…
4 properties3 required
pageDataPatch
string
Describes the type of page data: - reference: Contains only the pageId and is used for iterating through an interview, providing navigation without detailed co…
previewPatchRequest
object
1 property
tamEntityName
string
The name of the entity. This could be the name of a person, organization, or property involved in the interview.
questions
array
interviewId
string
The unique identifier of the Interview.
partnerEndUserId
string
A unique identifier for the end user provided by the partner application. This helps in linking the interview to a specific user within the partner's system.
pageDataDisplaySingle
createInterview
object
3 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Rocket Lawyer Interviews API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
