← FlexAPI Documentation / API Calls / GetMeetings
The GetMeetings method retrieves meeting details, including the meeting links and status, for a transaction, or for every transaction that shares a meeting. Search by DocumentSetID, by MeetingUUID, or both. See Zoom Meeting Linking for the overview. Available in SIGNiX release 180.
DocumentSetID, a MeetingUUID, or both. At least one is required, and you cannot send an empty element.DocumentSetID to get the meetings for that one transaction.MeetingUUID to get every transaction that shares that meeting. Send Part with it, which is almost always 1.Data element.CustInfo credentials as your other requests (Sponsor, Client, UserId and Pswd).An annotated example of the request XML follows. Choose which identifiers to send, as described in the comments.
<?xml version="1.0" ?>
<GetMeetingsRq xmlns="urn:com:signix:schema:sdddc-1-1">
<CustInfo> <!-- Occurs once only -->
<!-- Assigned by SIGNiX when the Client is set up. All case sensitive. -->
<Sponsor>YOUR_SPONSOR</Sponsor>
<Client>YOUR_CLIENT</Client>
<UserId>YOUR_USER</UserId>
<Pswd>YOUR_PASSWORD</Pswd>
</CustInfo>
<Data> <!-- Occurs once only -->
<!-- Send DocumentSetID, MeetingUUID, or both. At least one is required. -->
<!-- The meetings for this one transaction. -->
<DocumentSetID>YOUR_DOCUMENT_SET_ID</DocumentSetID>
<!-- Every transaction that shares this meeting. -->
<MeetingUUID>YOUR_MEETING_UUID</MeetingUUID>
<Part>1</Part> <!-- Almost always 1 -->
</Data>
</GetMeetingsRq>
An annotated example of the response XML follows. See Status Codes on the main API page for the possible values and meanings of the StatusCode and StatusDesc elements.
MeetingMetadata element describes one meeting on one transaction.DocumentSetID, the response includes just the meetings for that transaction.Status shows Unavailable until the meeting's recording has been processed.SubmitterMeetingLink is the host link for the notary. Treat it as sensitive. The SignerMeetingLink is for signers and witnesses.<?xml version="1.0" ?>
<GetMeetingsRs xmlns="urn:com:signix:schema:sdddc-1-1">
<Status> <!-- Occurs once only -->
<StatusCode>0</StatusCode> <!-- One of the numeric SC_* values -->
<StatusDesc>success</StatusDesc> <!-- Human-readable version of StatusCode -->
</Status>
<Data> <!-- Occurs when Status.StatusCode is 0. -->
<MeetingMetadata> <!-- Occurs once for each meeting found -->
<DocumentSetID>YOUR_DOCUMENT_SET_ID</DocumentSetID>
<MeetingUUID>YOUR_MEETING_UUID</MeetingUUID>
<Part>1</Part>
<MeetingDateTime>10/05/2025 06:30 AM US/Eastern</MeetingDateTime>
<!-- Unavailable until the meeting recording has been processed. -->
<Status>Unavailable</Status>
<SubmitterMeetingLink>YOUR_SUBMITTER_MEETING_LINK</SubmitterMeetingLink> <!-- Host link (notary). Treat as sensitive. -->
<SignerMeetingLink>YOUR_SIGNER_MEETING_LINK</SignerMeetingLink> <!-- Participant link (signer / witness) -->
</MeetingMetadata>
</Data>
</GetMeetingsRs>
To list all the transactions associated with a single meeting, search by MeetingUUID. The response has one MeetingMetadata element for each transaction, each with its own DocumentSetID. In the same way, a transaction that has two meetings returns two MeetingMetadata elements when you search by its DocumentSetID.
<GetMeetingsRs xmlns="urn:com:signix:schema:sdddc-1-1">
<Status>
<StatusCode>0</StatusCode>
<StatusDesc>success</StatusDesc>
</Status>
<Data>
<!-- Same MeetingUUID, different transactions. -->
<MeetingMetadata>
<DocumentSetID>YOUR_FIRST_DOCUMENT_SET_ID</DocumentSetID>
<MeetingUUID>YOUR_MEETING_UUID</MeetingUUID>
<Part>1</Part>
<MeetingDateTime>10/05/2025 08:30 AM US/Eastern</MeetingDateTime>
<Status>Unavailable</Status>
<SubmitterMeetingLink>YOUR_SUBMITTER_MEETING_LINK</SubmitterMeetingLink>
<SignerMeetingLink>YOUR_SIGNER_MEETING_LINK</SignerMeetingLink>
</MeetingMetadata>
<MeetingMetadata>
<DocumentSetID>YOUR_SECOND_DOCUMENT_SET_ID</DocumentSetID>
<MeetingUUID>YOUR_MEETING_UUID</MeetingUUID>
<Part>1</Part>
<MeetingDateTime>10/05/2025 08:30 AM US/Eastern</MeetingDateTime>
<Status>Unavailable</Status>
<SubmitterMeetingLink>YOUR_SUBMITTER_MEETING_LINK</SubmitterMeetingLink>
<SignerMeetingLink>YOUR_SIGNER_MEETING_LINK</SignerMeetingLink>
</MeetingMetadata>
</Data>
</GetMeetingsRs>
If the transaction has no meeting linked, the request still succeeds. The response has a StatusCode of 0 and an empty Data element.
<GetMeetingsRs xmlns="urn:com:signix:schema:sdddc-1-1">
<Status>
<StatusCode>0</StatusCode>
<StatusDesc>success</StatusDesc>
</Status>
<Data/> <!-- Empty: no meeting is linked -->
</GetMeetingsRs>
1110 Market Street, Suite 402
Chattanooga, TN 37402
877.890.5350
info@SIGNiX.com
©2016 SIGNiX. All Rights Reserved.