{"info":{"_postman_id":"8afbc8ee-243c-4dff-8bea-164062b8489a","name":"FileInvite for Lending API Documentation","description":"

Getting Started

Welcome to the FileInvite for Lending API Guide. This guide helps you connect FileInvite’s API with your existing lending systems—whether you're streamlining client onboarding or handling document collection throughout the loan process.

Feedback

If you have additional use cases you’d like the API to support, please reach out to your Customer Success Representative. Your feedback helps us prioritize enhancements that best serve your needs.

API Guide

Follow the steps below in the recommended order to integrate FileInvite’s API into your workflows.

Authentication
FileInvite uses OAuth 2.0 (Client Credentials grant type) for secure access. See the Authentication Guide for token generation and user attribution.
\n
Invites
Use the Invites API to automate document requests. Create, send, edit, and track invites to streamline your document collection process.
\n
Contacts
Sync your customer, client, or borrower records with FileInvite. Use the Contacts API to create, update, or retrieve contact details.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"}],"owner":"24470732","collectionId":"8afbc8ee-243c-4dff-8bea-164062b8489a","publishedId":"2sAYX6ngiL","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-05-09T08:22:02.000Z"},"item":[{"name":"Authentication","item":[],"id":"fafe6857-af86-401b-9dcb-03717ede72ce","description":"

The FileInvite API uses OAuth2 authentication, specifically the Client Credentials grant type. This ensures secure access to the API.

How to Get Access to the API

To use the FileInvite API, your organization needs its own set of API credentials.

Step 1: Contact your FileInvite account manager.
\n
Step 2: Request the following unique ids from your account manager
- Client ID
- Client Secret
- Organisation id (code) A short hash unique identifier of the organization
- Account id (code) A short hash unique identifier of the account. There can be multiple accounts under a single organisation.
\n

What to Do After You Receive Your API Credentials

Once you have your Client ID and Secret:

You need to generate an Access Token to make API requests.
\n
Access tokens are required to use any API endpoints.
\n

You can find technical documentation on how to get an access token and refresh token in our Authentication API Reference.

Is the API client linked to a specific user?

No, the API client is not linked to a specific user but directly linked to the organisation. But the API calls are recorded as the Organisation owner made them.

Can I force a specific user to make API calls?

Yes, if you pass a custom header triggered-by-user-email with the user's email, the API request will be recorded as if the specific user has made the API calls.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6613f5d6-f734-4ec5-a25a-7eb445ec5b0a","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"006ec35f-14ba-4079-834e-6c0ab94b64a2","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"fafe6857-af86-401b-9dcb-03717ede72ce"},{"name":"Invites","item":[{"name":"Creating & Sending an Invite","item":[],"id":"a137cd67-7730-479a-a0b6-db76b664684a","description":"

This guide walks you through creating an Invite using the FileInvite API. Invites allow you to request documents, signatures, and other information from your Contacts.

Prerequisite

Before creating an Invite, ensure the following are set up in your FileInvite app:

Templates
Templates streamline the Invite creation process by preloading a list of Request (documents to upload, forms to sign etc.). Learn how to create and manage Templates in our Templates Help Articles.

Step 1: Selecting a template

Use the Get Templates endpoint to retrieve available Templates.

The API will return up to 25 Templates by default, sorted by the most recently created.
Allow the user to select a Template ID that matches the required requests.

Step 2: Create & Send an Invite

Calling the Dispatch Invite endpoint automatically:

Creates the Invite.
\n
Generates the Portal for each Contact.
\n
Sends the Invite email to the specified Contacts (unless explicitly disabled).
\n

Required Parameters:

Contact’s Email: Specify up to 10 Contact Emails.
\n
Template ID: Provide the Template ID to use for the Invite.
\n

Create & Send Variations

There are three ways to handle Invite creation, depending on whether you want to send the email immediately or review it first.

1. Conventional Create & Send (Default Behavior)

This is the standard flow, where the Invite email is sent as soon as the Invite is created.

Steps:

Call the Dispatch Invite endpoint with the required parameters.
\n
The API responds with a 200 status, confirming that:
\n
- The Portal is created for each Contact.
  \n
- The Invite email is sent automatically to the specified Contacts.
  \n
\n

No further action is needed to send the Invite email in this scenario.

2. Create & Send - Disable the Invite Email

If you prefer to send the Invite email using your own email engine instead of FileInvite:

Steps:

Call the Dispatch Invite endpoint.
\n
Set the notify to false in your request.
\n
The API responds with a 200 status, confirming that:
\n
- The Portal is created for each Contact.
  \n
- The Invite email is NOT sent by FileInvite.
  \n
- The Portal link is returned in the response.
  \n
\n

You can now use the returned Portal link to send your custom email.

3. Create & Send - Review Before Sending the Email

If you want to review the Invite details before sending the email, follow this process:

Steps:

Call the Dispatch Invite endpoint with notify to false in your request.
\n
The API responds with a 200 status, confirming that:
\n
- The Portal is created for each Contact.
  \n
- The Invite email is NOT sent by FileInvite.
  \n
- The Portal link is returned in the response.
  \n
\n
Retrieve the Invite details using the Get Invite endpoint to review:
\n
- Contacts
  \n
- Subject & Message
  \n
- Requests
  \n
- Due Dates & Reminder Settings
  \n
\n
If modifications are needed, follow the Edit Invite Guide.
\n
Once finalized, call the Resend Invite endpoint with the Invite ID and the Contact ID (or IDs) for the customers you want to resend the email to.
\n

What’s Next?

Edit an Invite: Modify an Invite after creation (e.g., add Contacts, update details).
\n
Add More Request Items: Learn how to include additional items in an Invite.
\n

\n","_postman_id":"a137cd67-7730-479a-a0b6-db76b664684a"},{"name":"Updating an Invite","item":[],"id":"2d57fbc2-7e83-4267-b8b7-431eaafc4981","description":"

If you need to make changes to an Invite, this guide covers the following use cases:

Updating basic Invite details, such as the Subject, Message, Due Date, or Point of Contact.
\n
Deleting a redundant request.
\n
Adding or removing Contacts from the Invite.
\n

Updating basic Invite details

To update details of an existing Invite:

Pass the Invite ID and the updated value for the parameter(s) you want to modify to the Update Invite API.
\n
Examples of editable parameters:
\n
- Subject
  \n
- Message
  \n
- Due Date
  \n
- Point of Contact
  \n
\n

Delete a request

If a request on an Invite is no longer needed:

Pass the Invite ID and the Request ID of the request you want to delete to the Get Invite Request endpoint.
\n
This action removes the redundant request from the Invite.
\n

Adding or Removing Contacts form the Invite

Adding Contacts

Pass the Invite ID and the Contact ID(s) to the Add Contact to an Invite endpoint.
\n
Note: An Invite can have a maximum of 10 Contacts.
\n

Removing Contacts

Pass the Invite ID and the Contact ID(s) to the Remove Contact From an Invite endpoint.
\n
Important: Every Invite must have at least one Contact. Ensure you do not remove the last Contact.
\n

What's next?

Add More Request Items: Learn how to include additional items in an Invite.
\n
Retrieve Files and Documents: Access files submitted through the Invite.
\n

\n","_postman_id":"2d57fbc2-7e83-4267-b8b7-431eaafc4981"},{"name":"Add More Requests to an Invite","item":[],"id":"cdaa9cf7-9014-4790-a84a-8cc1a9e8f4cc","description":"

This guide walks you through creating a Follow-up using the FileInvite API. A Follow-up allows you to request additional documents, signatures, or information from your Contacts after an Invite has already been sent.

Prerequisites

Before creating a Follow-up, ensure the following are set up in your FileInvite app:

Templates
Follow-ups must use Templates to predefine the additional requests. Learn how to create and manage Templates in our Templates Help Articles.

Invite ID
Since Follow-ups are appended to an existing Invite, you must have a valid Invite ID to associate the Follow-up with an Invite.

Step 1: Create & Send a Follow-up

Note: The Create Follow-up API endpoint is not yet available, but this guide illustrates how it will behave once implemented.

Calling the Create Follow-up endpoint will:

Append additional requests to the existing Invite.
\n
Generate the Follow-up Name for tracking.
\n
Automatically send the Follow-up email to the Contacts (unless explicitly disabled).
\n

Required Parameters:

Invite ID: The ID of the existing Invite.
\n
Template ID: The ID of the Template that contains the predefined request items.
\n
Follow-up Name: A label for the Follow-up (e.g., \"Underwriting Documents\").
\n

Follow-up Variations

There are three ways to handle Follow-ups, depending on whether you want to send the email immediately or review it first.

1. Conventional Create & Send (Default Behavior)

This is the standard flow, where the Follow-up email is sent as soon as the Follow-up is created.

Steps:

Call the Create Follow-up endpoint with the required parameters.
\n
The API responds with a 200 status, confirming that:
\n
- The Follow-up is created and linked to the Invite.
  \n
- The Follow-up email is sent automatically to the specified Contacts.
  \n
\n

2. Follow-up Without Triggering Email

If you prefer to send the Follow-up email using your own email engine instead of FileInvite:

Steps:

Call the Create Follow-up endpoint.
\n
Set the email_flag to 0 in your request.
\n
The API responds with a 200 status, confirming that:
\n
- The Follow-up is created and linked to the Invite.
  \n
- The Follow-up email is NOT sent by FileInvite.
  \n
- The Portal link remains the same as the original Invite.
  \n
\n

3. Follow-up with Review Steps

If you want to review the Follow-up details before sending the email, follow this process:

Steps:

Call the Create Follow-up endpoint with email_flag: 0.
\n
The API responds with a 200 status, confirming that:
\n
- The Follow-up is created and linked to the Invite.
  \n
- The Follow-up email is NOT sent by FileInvite.
  \n
- The Portal link remains unchanged (same as the original Invite).
  \n
\n
Retrieve the Follow-up details using the Get Invite Requests endpoint to review:
\n
- Contacts
  \n
- Follow-up Name
  \n
- Reminder Settings
  \n
\n
If modifications are needed, follow the Edit Invite Guide.
\n
Once finalized, call the Resend Invite endpoint with the Invite ID to manually trigger the Follow-up email.
\n

What’s Next?

Retrieve Files & Documents: Learn how to access submitted files through the Invite.
\n
Archive an Invite: Close the Invite when all requests are completed.
\n

\n","_postman_id":"cdaa9cf7-9014-4790-a84a-8cc1a9e8f4cc"},{"name":"Retreiving returned documents, or signed forms","item":[],"id":"ec9c4f74-abb4-4e70-9bce-f3b13b804f28","description":"

When your customers begin submitting documents or completing forms, you can access these files through the Invite. The Download API allows you to retrieve all files and forms that have been uploaded or completed at a given time.

How to retrieve files

Retrieve File IDs
\n
1. Pass the Invite ID to the Get Invite Requests endpoint.
  \n
2. This endpoint will return a list of File IDs.
  \n
\n
Download File
\n
1. Pass each File ID to the Download File endpoint.
  \n
2. This endpoint will return a File URL, which expires in 5 minutes.
  \n
\n

Future Enhancements

In future updates, we plan to introduce a webhook that will notify you when new files or completed forms are ready for download. This will eliminate the need for frequent polling.

What’s Next?

Archive an Invite: Close the Portal when all submissions are complete and the Invite is no longer active.

\n","_postman_id":"ec9c4f74-abb4-4e70-9bce-f3b13b804f28"},{"name":"Archiving an Invite","item":[],"id":"00ad1019-8869-46e5-972e-4339b76b36e4","description":"

When an Invite is complete, and you’ve downloaded all the documents submitted through it, you may want to close the Portal to prevent further submissions. Archiving the Invite allows you to finalize and close the workflow.

How to Archive an Invite

To archive an Invite:

Pass the Invite ID of the Invite you wish to archive to the Archive Invite endpoint.
\n
Once archived, the Portal will be closed, and no further submissions will be allowed.
\n

Key Notes:

Ensure all required documents have been downloaded before archiving, as the Portal will no longer be accessible to Contacts once archived.
\n
Archived Invites are still available for reference and reporting purposes in the system.
\n

\n","_postman_id":"00ad1019-8869-46e5-972e-4339b76b36e4"}],"id":"8f1b7f7a-e317-46ef-9f3f-4d8fd4ea07c3","description":"

In FileInvite, an Invite is the primary tool for collecting documents or information from your customers, clients, or applicants. It simplifies document requests by combining all required items (called Requests) into a single, streamlined workflow.

Requests: Individual tasks within an Invite that you are asking your customers to fulfill, such as uploading files, completing forms, or signing documents.
\n
When an Invite is sent, your Contacts will receive an email containing a link to the Portal, where they can complete the requested tasks. For example:
\n
- Upload documents like bank statements or identification.
  \n
- Fill out and sign forms.
  \n
\n

Invites eliminate manual follow-ups by automating document collection and tracking in one place, ensuring a seamless experience for both your team and your clients.

Prerequisites

We recommend that you have Templates already set up in the FileInvite app. Templates is a convenient way to streamlime the Invite creation process by preloading an exisitng list of requests that you would need to have on the Invite. The Templates help article explains how to create and set up Templates.

How to Interact with Invites via the API

The FileInvite API allows you to integrate Invites into your existing tools and workflows, so your team doesn’t have to switch between multiple systems. Below is a step-by-step guide for using the Invites API:

Create and Send Invite
Set up a new Invite by specifying the Contact(s), Request items, and any additional details (e.g., deadlines, instructions) and dispatch the Invite to your Contacts.
\n
Update an Invite
Modify an existing Invite to update details like due dates, or add more contacts to the Invite.
\n
Adding Additional Request Items (Follow-Up)
Include new tasks or document requests in an already-sent Invite to keep the process flexible.
\n
Retrieving Returned Files, Documents, or Signed Forms
Access the files, forms, or other items submitted by your Contacts through the Invite.
\n
Archiving an Invite
Mark an Invite as completed and archive it for future reference or record-keeping.
\n

What are the different Invite Statuses

Invite status transition can be used to build workflows on your end. Following are the different invite statuses and their description

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Description
draft	An Invite is created but not yet sent
scheduled	An Invite is scheduled to be sent.
sent	An Invite is sent
progressing	An Invite is sent and the end-user has viewed the portal but not yet submitted documents or forms.
ready_for_review	The end-user/borrower has submitted documents and forms
in_review	The lender/app user has accepted some requests but not all the requests yet.
completed	The lender has marked all the requests accepted and happy with the forms and documents received so the invite is completed.
archived	The invite is no longer is use it is archived.

What are indicators?

Indicators are used visual indication of the progress of an Invite. Use the indicators to build a UI to display a view at an Invite level.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Indicator	Description
sent	Invite has been sent to all the contact/s
no_progress	Invite has been sent to contact/s but there is no activity for more than a day.
progressing	There is activity from the contact/s on this request but they haven’t yet pressed submit
awaiting_review	Contact has returned files and it is now available to be reviewed by the customer.
in_review	FileInvite customer has rejected the items returned by borrower. The Invite requires action from the borrower to proceed.
accepted	The FileInvite customer has approved the items returned by the borrower
due_today	The invite is due today, not all the requests are complete
overdue	The invite has past the due date not all the requests are complete.
complete	All contacts on all requests have had their returned items approved (and before the due date)

","_postman_id":"8f1b7f7a-e317-46ef-9f3f-4d8fd4ea07c3"},{"name":"Contacts","item":[],"id":"0fac8f29-67ac-4b3a-8599-d9eb35d7097c","description":"

Contacts in FileInvite represent your customers, clients, or borrowers—the individuals who will interact with the Portal when an Invite is sent. Managing Contacts is a crucial first step before you can send Invites or collect documents.

Importing contacts into FileInvite

If you’re just starting out with FileInvite (welcome!), you’ll need to import your customer contact information into the system. Here’s how you can do it:

Using the FileInvite UI
Export your contacts as a CSV file and upload them via the FileInvite user interface. Learn how to import contacts via the UI.
\n
Using the API
Use the Import Contact endpoint to programmatically upload your contacts as a CSV or TXT file.
\n

Keeping contact list and contacts updated on FileInvite

After importing your contacts, you can manage changes to ensure your contact list stays up to date.

For Existing Contacts:

Update a Contact: Modify contact details as needed using the Update Contact endpoint.
\n
Delete a Contact: Remove a contact from the system when they are no longer needed using the Delete Contact endpoint.
\n

For New Contacts:

Add a Contact: Use the Add Contact endpoint to add new customers, clients, or borrowers to your system.

Accessing and displaying Contacts

When you need to work with your contact list, the following endpoints will help:

List Contacts: Retrieve a complete list of all contacts using the List Contact endpoint.
\n
Get Contact: Fetch details for a specific contact using the Get Contact endpoint.
\n

Who can interact with Contacts?

Contact-related actions depend on user roles and permissions. Refer to this article for details on which roles can perform specific actions with Contacts.

What's next?

Now that you’ve set up and managed your Contacts, you’re ready to:

Create, send, and edit Invites to collect documents.
\n
Retrieve returned files and archive completed Invites.
\n

\n","_postman_id":"0fac8f29-67ac-4b3a-8599-d9eb35d7097c"},{"name":"API Reference","item":[{"name":"Authentication","item":[{"name":"Refresh Token","event":[{"listen":"test","script":{"id":"16cb5c29-52ef-4de2-af5e-a505fca9f2fe","exec":["const response = pm.response.json();","pm.environment.set(\"access_token\", response.access_token)","pm.environment.set(\"refresh_token\", response.refresh_token)"],"type":"text/javascript","packages":{}}}],"id":"a79b4e19-ba2a-4f4e-878b-e5aadf4c8233","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"refresh_token","type":"text"},{"key":"refresh_token","value":"{{refresh_token}}","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"},{"key":"scope","value":"","type":"text"},{"key":"Origin","value":"{{cors_origin}}","type":"text"}]},"url":"{{region}}.fileinvite.app/2023-02/token","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","id":"99068099-e00d-4e53-aaca-05f4d5c453e9","name":"API Reference","type":"folder"}},"urlObject":{"path":["2023-02","token"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"9453ddad-5c5a-47ab-bdd2-60b33f3638ed","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"refresh_token\",\n \"refresh_token\": {{refresh_token}},\n \"client_id\": {{client_id}},\n \"scope\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/token"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.23.2","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-Powered-By","value":"PHP/8.1.13","enabled":true},{"key":"pragma","value":"no-cache","enabled":true},{"key":"Cache-Control","value":"no-store, private","enabled":true},{"key":"Date","value":"Mon, 12 Dec 2022 22:29:25 GMT","enabled":true},{"key":"X-RateLimit-Limit","value":"60","enabled":true},{"key":"X-RateLimit-Remaining","value":"59","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600,\n \"access_token\": \"access_token\",\n \"refresh_token\": \"refresh_token\"\n}"}],"_postman_id":"a79b4e19-ba2a-4f4e-878b-e5aadf4c8233"},{"name":"Access token","event":[{"listen":"test","script":{"id":"16cb5c29-52ef-4de2-af5e-a505fca9f2fe","exec":["const response = pm.response.json();","pm.environment.set(\"access_token\", response.access_token)","pm.environment.set(\"refresh_token\", response.refresh_token)"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ef92f3b3-0c19-4f64-8afe-bad7c753392e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"{{client_credentials_client_id}}","type":"text"},{"key":"client_secret","value":"{{client_secret}}","type":"text","uuid":"1295f79a-1acd-4739-a2ee-4c606c0f6707"},{"key":"scope","value":"","type":"text"},{"key":"Origin","value":"{{cors_origin}}","type":"text"}]},"url":"{{region}}.fileinvite.app/2023-02/token","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","id":"99068099-e00d-4e53-aaca-05f4d5c453e9","name":"API Reference","type":"folder"}},"urlObject":{"path":["2023-02","token"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"2c246dff-364c-44ec-8fa9-ab74d92f2fd7","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"refresh_token\",\n \"refresh_token\": {{refresh_token}},\n \"client_id\": {{client_id}},\n \"scope\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"app.fileinvite.co/2023-02/token"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Server","value":"nginx/1.23.2","enabled":true},{"key":"Content-Type","value":"application/json; charset=UTF-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-Powered-By","value":"PHP/8.1.13","enabled":true},{"key":"pragma","value":"no-cache","enabled":true},{"key":"Cache-Control","value":"no-store, private","enabled":true},{"key":"Date","value":"Mon, 12 Dec 2022 22:29:25 GMT","enabled":true},{"key":"X-RateLimit-Limit","value":"60","enabled":true},{"key":"X-RateLimit-Remaining","value":"59","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600,\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIzIiwianRpIjoiOGEyZDc3ZTRmM2QxOTdhODU4MDMyMjQxMmU0ZTNlYTUzYzRiM2JlNzA1MmEzODVjMGRkMmQyZWYwYjZiMTNlOTk4Y2Y4M2UxNzE5NzgyNzUiLCJpYXQiOjE2NzA4ODQxNjQuOTYyMDc0LCJuYmYiOjE2NzA4ODQxNjQuOTYyMDgsImV4cCI6MTcwMjQyMDE2NC44NDM1NDIsInN1YiI6IjEiLCJzY29wZXMiOltdfQ.DlrzcA3hTgBA3edSKPIsbiiJn1q8h6ucGedBH7Qfg3Axf55qKdgdwSqWV3mqFOrl7UcYHGP8zZbb6g1-7IU8vQxvOAlV4AUchhRwLu_Yu3OVmtSjGvp-XqfcrRGeu9z4WmJSGcFUX9Ql8prUTBJWaTbNkT7J7idEttJgJeagNXQbkI2L45dyMyOfZxuYzoGup0T48JSSOK7_hiy4hUWdGM93rSlnZ_0ul7TveLZLkJU3iqdVlMGmCcy4EwpnCUKAot4d2qz10fZvh5F4PUDgSpQa1YGG3llHVAJokxRMou3_NiDdLNgRvi_G70CwwzU5lgbmZ2e9W9ppcimesjhnD7gZcZlfNtphlSmmN4I46qM4_ngxtGDqJQ-shcD2pvWpW577wZNews9WH4C5DEGF5TDNfXt_akaeoGkd7hHyaEG3p38vahHJAlDiWAeGWepoMAeZJeBs8RLrNjKJ3JZWDYxrEs4x3k72Tr3KRK1vrwLACVmsj9_jp1lrVmYfXP6PRknZEwxEDGrOh19iSHtq4jrT14GtsQ4cikJqhKtvEpuVL-RVKqlZ-17PmW3k5qvo3UejvTpd12sSk9sL2ATV38nZaVIl7xAPTJpqDBYHbO1pcJLTjE8svzhjUxS87vW0yLAtIqztnNlxCfd9EixrN2p1L8LzA4zeXQgbVn5401Q\",\n \"refresh_token\": \"def50200f18d4b8388081719ec7928c3e48f82af96bd31511029f4d9ef039e2fadc245f912000da370d4d2205f636bdd1283c33ed715bcfaba168221c7d2e1ee6f9936e691beac833742eb097409923d75844c633f91bdbfd52de25e9567d1613c744edf83199cf4772fce086219868f26e229fe497450b6a5b2ad396ea3a4611912fe5788902e880193bde81d1c1439cbdd95a4dfccb2de4652bb65f3e77b1677bb178c1c323b286d3222c9c0182c04b374469fa0f14c88847f0ba3334c8940bc5209a55a1e0aa3d0d83e893b9a4ae403c292fb93e896628dcd2f5da180ab31a22c9220096dee438ee154c9ebafecf37bc7d68602a55848a6bd89bef5b2e3c22f0adb545ec3f374ae07c526e2a5869e99b267722f7fec30ce7473b955e52b895efe3b716347c3b62d87c260f19140cdf6cd5a57f1b780b872a64ae590b62c798f5df1a5b4159baaf68a5afaf754c6be0bac2293701a71475c80a17a7692731761\"\n}"}],"_postman_id":"ef92f3b3-0c19-4f64-8afe-bad7c753392e"}],"id":"ae88ec7e-5ad5-41b6-b8be-e62caff73c95","_postman_id":"ae88ec7e-5ad5-41b6-b8be-e62caff73c95","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","id":"99068099-e00d-4e53-aaca-05f4d5c453e9","name":"API Reference","type":"folder"}}},{"name":"Contacts","item":[{"name":"Import Contacts","event":[{"listen":"test","script":{"id":"faf71a44-b388-433f-8a16-6359b4b3c3c3","exec":["const response = pm.response.json();","pm.environment.set(\"contact_id\", response.data.contact.id);"],"type":"text/javascript","packages":{}}}],"id":"f092f42d-27da-48e8-b642-531ba2c6415b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"{{organisation_id}}"},{"key":"account-id","value":"{{account_id}}"}],"body":{"mode":"raw","raw":"{\n \"file\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts/import","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
first_name	string	required	Max 150 characters.
last_name	string	required	Max 150 characters.
email	string	required	Max 150 characters. Must be a valid email address. Email does not already exist in the account (Note: Can exist in another account within the organisation).
number	string	optional	Max 15 characters Should be a valid phone number. Should be a Mobile Number (Not a landline).
country_number_code	string	optional (If the number exists)	Must be a valid country code.
country_iso2_code	string	optional (If the number exists)	Must be a valid country iso code. Example: AU, NZ, PH, US

","urlObject":{"path":["2023-02","contacts","import"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"76810592-0cfd-44b2-8e45-6391f1d6a228","name":"201 Created - Contact added","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"stZGMPZ5ZX"},{"key":"organisation-id","value":"stZGMPZ5ZX"}],"body":{"mode":"raw","raw":"{\n \"file\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts/import"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"message\": \"Your csv file was imported successfully.\"\n}"},{"id":"5f6dee85-2f55-4298-800e-19655513bf1d","name":"422 Unprocessable Entity - Fields validation errors","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"stZGMPZ5ZX"},{"key":"organisation-id","value":"stZGMPZ5ZX"}],"url":"{{region}}.fileinvite.app/2023-02/contacts/import"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The file field is required.\",\n \"errors\": {\n \"file\": [\n \"The file field is required.\"\n ]\n }\n}"},{"id":"6b20a84e-65c9-4487-b002-f07128e3f4db","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"00000000-0000-0000-000000000000","type":"text"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000","type":"text"}],"body":{"mode":"raw","raw":"{\n \"file\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts/import"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Something went wrong. Please try again. If the problem continue to persist, contact us.\"\n}"}],"_postman_id":"f092f42d-27da-48e8-b642-531ba2c6415b"},{"name":"Update Contact","id":"e32da8ce-b469-44ba-8c84-76a704dce340","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"{{organisation_id}}"},{"key":"account-id","value":"{{account_id}}"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Vilma\",\n \"last_name\": \"Huels\",\n \"email\": \"{{username}}+aede2a83-81fd-46eb-bf66-1da4a48a6714@fileinvite.com\",\n \"phone\": {\n \"country_number_code\": \"{{phone.country_number_code}}\",\n \"number\": \"{{phone.number}}\",\n \"country_iso2_code\": \"{{phone.country_iso2_code}}\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts/{{contact_id}}","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
first_name	string	required	Max 150 characters.
last_name	string	required	Max 150 characters.
email	string	required	Max 150 characters. Must be a valid email address. Email does not already exist in the account (Note: Can exist in another account within the organisation).
number	string	optional	Max 15 characters Should be a valid phone number. Should be a Mobile Number (Not a landline).
country_number_code	string	optional (If the number exists)	Must be a valid country code.
country_iso2_code	string	optional (If the number exists)	Must be a valid country iso code. Example: AU, NZ, PH, US

","urlObject":{"path":["2023-02","contacts","{{contact_id}}"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"b1825f5c-e9d5-4718-80ee-16e447b16405","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"{{organisation_id}}"},{"key":"account-id","value":"{{account_id}}"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Mafalda\",\n \"last_name\": \"Aufderhar\",\n \"email\": \"{{username}}+f03c2f8b-a6fc-4429-8b97-46e326505664@fileinvite.com\",\n \"phone\": {\n \"country_number_code\": \"{{phone.country_number_code}}\",\n \"number\": \"{{phone.number}}\",\n \"country_iso2_code\": \"{{phone.country_iso2_code}}\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts/{{contact_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"contact\": {\n \"id\": \"9dd2c69d-06d1-4fb8-84f2-cc9d6214f973\",\n \"first_name\": \"Travis\",\n \"last_name\": \"Schimmel\",\n \"email\": \"l.machado+11ae1331-cf00-4a6b-8404-79d7b2e2c2ae@fileinvite.com\",\n \"phone\": {\n \"id\": \"304a4a29-ea5e-4278-a0b6-1da411717ac8\",\n \"number\": \"123456789\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2024-01-19T08:26:18+11:00\"\n }\n },\n \"message\": \"Record has been updated.\"\n}"},{"id":"e37e6342-8381-471b-ba06-076f6068005f","name":"422 Unprocessable Content","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"{{organisation_id}}"},{"key":"account-id","value":"{{account_id}}"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Hermann\",\n \"last_name\": \"Ferry\",\n \"phone\": {\n \"number\": \"{{phone.number}}\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts/{{contact_id}}"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The email field is required. (and 2 more errors)\",\n \"errors\": {\n \"email\": [\n \"The email field is required.\"\n ],\n \"phone.country_number_code\": [\n \"The phone.country number code field is required.\"\n ],\n \"phone.country_iso2_code\": [\n \"The phone.country iso2 code field is required.\"\n ]\n }\n}"},{"id":"82fa9fa9-9d31-49ac-9846-0e85a32eacbf","name":"401 Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"{{organisation_id}}"},{"key":"account-id","value":"{{account_id}}"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Kayli\",\n \"last_name\": \"Flatley\",\n \"email\": \"{{username}}+744798b5-25c8-47f4-9bb3-6a2fdcf924ca@fileinvite.com\",\n \"phone\": {\n \"country_number_code\": \"{{phone.country_number_code}}\",\n \"number\": \"{{phone.number}}\",\n \"country_iso2_code\": \"{{phone.country_iso2_code}}\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts/{{contact_id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthenticated.\"\n}"},{"id":"7be01dac-e39d-4985-80bb-30b9b3094f34","name":"500 Internal Server Error","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"00000000-0000-0000-000000000000"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@fileinvite.com\", \n \"phone\": {\n \"country_number_code\": \"+64\",\n \"number\": \"972-3040\",\n \"country_iso2_code\": \"NZ\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts/{{contact_id}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Something went wrong. Please try again. If the problem continue to persist, contact us.\"\n}"}],"_postman_id":"e32da8ce-b469-44ba-8c84-76a704dce340"},{"name":"Delete Contact","id":"66b75b4c-a83f-4377-966f-509e419d2d83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"contacts\" : [\"{{contact_id}}\"]\n}"},"url":"{{region}}.fileinvite.app/2023-02/contacts","description":"

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
type	string	required	The entity to which the file will be associated. At the moment, the allowed value is request.
uuid	string	optional	UUID of the type resource.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Status	Description
files	array	required	Associated with the type that the file belongs to Supports an array of file objects. There should be at least 1 file.

","urlObject":{"path":["2023-02","contacts"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"3dd28b51-55e2-430c-9e39-c4ea74e9a734","name":"200 OK - Contacts removed","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000"},{"key":"account-id","value":"00000000-0000-0000-000000000000"}],"body":{"mode":"raw","raw":"{\n \"contacts\" : [\"00000000-0000-0000-000000000000\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"message\": \"Multiple record has been deleted.\"\n}"},{"id":"585bdb74-9342-49e6-9576-fdd237568c20","name":"401 Unauthorized - No access token","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"files\" : [\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/files/{{fileable_type}}/{{fileable_id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthenticated.\"\n}"},{"id":"5257b131-2a47-4baf-80bb-6d7ad553653c","name":"422 Unprocessable Entity - Field validation errors","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"00000000-0000-0000-000000000000"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000"}],"body":{"mode":"raw","raw":"{\n \"contacts\" : [\"00000000-0000-0000-000000000000\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The selected contacts.0 is invalid.\",\n \"errors\": {\n \"files.0.id\": [\n \"The selected contacts.0 is invalid.\"\n ]\n }\n}"}],"_postman_id":"66b75b4c-a83f-4377-966f-509e419d2d83"},{"name":"Add Contact","event":[{"listen":"test","script":{"id":"faf71a44-b388-433f-8a16-6359b4b3c3c3","exec":["const response = pm.response.json();","pm.environment.set(\"contact_id\", response.data.contact.id);"],"type":"text/javascript","packages":{}}}],"id":"47ed50ff-450e-468f-a94c-882491cf7532","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"{{organisation_id}}"},{"key":"account-id","value":"{{account_id}}"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"Violet\",\n \"last_name\": \"Dibbert\",\n \"email\": \"{{username}}+fff56138-73a6-4d93-853b-7953b14054bb@fileinvite.com\",\n \"phone\": {\n \"country_number_code\": \"{{phone.country_number_code}}\",\n \"number\": \"{{phone.number}}\",\n \"country_iso2_code\": \"{{phone.country_iso2_code}}\"\n },\n \"company\": \"\",\n \"position\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
first_name	string	required	Max 150 characters.
last_name	string	required	Max 150 characters.
email	string	required	Max 150 characters. Must be a valid email address. Email does not already exist in the account (Note: Can exist in another account within the organisation).
number	string	optional	Max 15 characters Should be a valid phone number. Should be a Mobile Number (Not a landline).
country_number_code	string	optional (If the number exists)	Must be a valid country code.
country_iso2_code	string	optional (If the number exists)	Must be a valid country iso code. Example: AU, NZ, PH, US

","urlObject":{"path":["2023-02","contacts"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"47a7f6d5-a3a8-4714-b7c5-ad5536c3dc00","name":"201 Created - Contact added","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"stZGMPZ5ZX"},{"key":"organisation-id","value":"stZGMPZ5ZX"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@fileinvite.com\", \n \"phone\": {\n \"country_number_code\": \"+64\",\n \"number\": \"9723040\",\n \"country_iso2_code\": \"NZ\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"contact\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@fileinvite.com\",\n \"phone\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"number\": \"9723040\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n }\n}"},{"id":"1eb94c6d-bfa1-4e64-bda8-7df73183c55e","name":"422 Unprocessable Entity - Fields validation errors","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"stZGMPZ5ZX"},{"key":"organisation-id","value":"stZGMPZ5ZX"}],"url":"{{region}}.fileinvite.app/2023-02/contacts"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The first name field is required. (and 5 more errors)\",\n \"errors\": {\n \"first_name\": [\n \"The first name field is required.\"\n ],\n \"last_name\": [\n \"The last name must not be greater than 150 characters.\"\n ],\n \"email\": [\n \"The email field is required.\"\n ],\n \"phone.country_number_code\": [\n \"The phone.country number code field is required.\",\n \"The phone.country number code is invalid.\"\n ],\n \"phone.country_iso2_code\": [\n \"The phone.country iso2 code is invalid.\",\n \"The phone.country iso2 code must not be greater than 2 characters.\"\n ]\n }\n}"},{"id":"207fd0a2-fdb6-465b-af61-961c40d949ef","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"00000000-0000-0000-000000000000","type":"text"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@fileinvite.com\", \n \"phone\": {\n \"country_number_code\": \"+64\",\n \"number\": \"972-3040\",\n \"country_iso2_code\": \"NZ\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/contacts"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Something went wrong. Please try again. If the problem continue to persist, contact us.\"\n}"}],"_postman_id":"47ed50ff-450e-468f-a94c-882491cf7532"},{"name":"List Contacts","id":"5069e43a-c415-4f81-b3ce-745daecab496","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"{{organisation_id}}"},{"key":"account-id","value":"{{account_id}}"},{"key":"Origin","value":"http://localhost:3001","type":"text"}],"url":"{{region}}.fileinvite.app/2023-02/contacts?filter[full_name]=&sort[column]=created_at&sort[order]=desc&per_page=25&page=1","description":"

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
filter[full_name]	string	optional	Filters first name or full name (The order is first name, last name).
sort[column]	string	optional (required if the sort[order] exists)	The column to be sorted. Only allow created_at value. Note: If both sort[column] and sort[order] do not exist the default sort[column] is created_at and sort[order] is desc.
sort[order]	string	optional (required if the sort[column] exists)	The direction of the sorting. Only allows asc or desc value. Note: If both sort[column] and sort[order] do not exist the default sort[column] is created_at and sort[order] is desc.
per_page	integer	optional	The number of items returned on the page. Allowed values 10, 25, 50, 100. If not set, the default value will be 25.
page	integer	optional	The page number to return. The default is 1.

","urlObject":{"path":["2023-02","contacts"],"host":["{{region}}.fileinvite.app"],"query":[{"key":"filter[full_name]","value":""},{"key":"sort[column]","value":"created_at"},{"key":"sort[order]","value":"desc"},{"key":"per_page","value":"25"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"37eb93a9-df57-4467-8e04-58e9ea30c8b8","name":"200 OK - Complete list of contacts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"stZGMPZ5ZX"},{"key":"account-id","value":"stZGMPZ5ZX"}],"url":{"raw":"app.fileinvite.co/2023-02/contacts?filter[full_name]=&sort[column]=created_at&sort[order]=desc&per_page=25&page=1","host":["app","fileinvite","co"],"path":["2023-02","contacts"],"query":[{"key":"filter[full_name]","value":""},{"key":"sort[column]","value":"created_at"},{"key":"sort[order]","value":"desc"},{"key":"per_page","value":"25"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@djpich.com\",\n \"phone\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"number\": \"33719747\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"phone\": {\n \"id\": \"364785c893d2-6f059507-ae98-4a42-b3f2\",\n \"number\": \"34854046\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Atkinson\",\n \"email\": \"jatkinson@dogemn.com\",\n \"phone\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"number\": \"33030933\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"Pat\",\n \"last_name\": \"Andersen\",\n \"email\": \"pandersen@gam1fy.com\",\n \"phone\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"number\": \"38319895\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/contacts?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/contacts\",\n \"per_page\": 25,\n \"to\": 4\n },\n \"message\": \"Contact(s) retrieved successfully.\"\n}"},{"id":"e697ef56-4678-42d2-8acf-1eb11b8e5333","name":"200 OK - Filter first name or full name with contacts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"stZGMPZ5ZX"},{"key":"account-id","value":"stZGMPZ5ZX"}],"url":{"raw":"{{region}}.fileinvite.app/2023-02/contacts?filter[full_name]=John&sort[column]=created_at&sort[order]=desc&per_page=25&page=1","host":["{{region}}.fileinvite.app"],"path":["2023-02","contacts"],"query":[{"key":"filter[full_name]","value":"John"},{"key":"sort[column]","value":"created_at"},{"key":"sort[order]","value":"desc"},{"key":"per_page","value":"25"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@djpich.com\",\n \"phone\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"number\": \"33719747\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Atkinson\",\n \"email\": \"jatkinson@dogemn.com\",\n \"phone\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"number\": \"33030933\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/contacts?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/contacts\",\n \"per_page\": 25,\n \"to\": 2\n },\n \"message\": \"Contact(s) retrieved successfully.\"\n}"},{"id":"60416fdf-54d3-479d-b6cf-d55bdd1cb46e","name":"200 OK - Empty list of contacts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"stZGMPZ5ZX"},{"key":"account-id","value":"stZGMPZ5ZX"}],"url":{"raw":"{{region}}.fileinvite.app/2023-02/contacts?filter[full_name]=&sort[column]=created_at&sort[order]=desc&per_page=25&page=1","host":["{{region}}.fileinvite.app"],"path":["2023-02","contacts"],"query":[{"key":"filter[full_name]","value":""},{"key":"sort[column]","value":"created_at"},{"key":"sort[order]","value":"desc"},{"key":"per_page","value":"25"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"contacts\": []\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/contacts?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": null,\n \"path\": \"{{region}}.fileinvite.app/2023-02/contacts\",\n \"per_page\": 25,\n \"to\": null\n },\n \"message\": \"No contact(s) found.\"\n}"},{"id":"8f92f79f-76e3-46e3-a335-39450fffc727","name":"200 OK - Filter first name or full name without contacts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"stZGMPZ5ZX"},{"key":"account-id","value":"stZGMPZ5ZX"}],"url":{"raw":"{{region}}.fileinvite.app/2023-02/contacts?filter[full_name]=John&sort[column]=created_at&sort[order]=desc&per_page=25&page=1","host":["{{region}}.fileinvite.app"],"path":["2023-02","contacts"],"query":[{"key":"filter[full_name]","value":"John"},{"key":"sort[column]","value":"created_at"},{"key":"sort[order]","value":"desc"},{"key":"per_page","value":"25"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"contacts\": []\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/contacts?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": null,\n \"path\": \"{{region}}.fileinvite.app/2023-02/contacts\",\n \"per_page\": 25,\n \"to\": null\n },\n \"message\": \"No contact(s) found.\"\n}"},{"id":"313aa4b3-92b3-4e9b-ac1b-3911fa2e5c2a","name":"401 Unauthorized - No access token","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{region}}.fileinvite.app/2023-02/contacts?filter[full_name]=John&sort[column]=created_at&sort[order]=desc&per_page=10&page=1","host":["{{region}}.fileinvite.app"],"path":["2023-02","contacts"],"query":[{"key":"filter[full_name]","value":"John"},{"key":"sort[column]","value":"created_at"},{"key":"sort[order]","value":"desc"},{"key":"per_page","value":"10"},{"key":"page","value":"1"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthenticated.\"\n}"}],"_postman_id":"5069e43a-c415-4f81-b3ce-745daecab496"},{"name":"Get Contact","id":"42c63a4a-6ff5-474c-ac5b-cc881c3d6139","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/contacts/{{contact_id}}","description":"

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
contact_uuid		required	UUID of the contact.

","urlObject":{"path":["2023-02","contacts","{{contact_id}}"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"d05e4aec-8171-4e36-a683-2b55cde7c1c3","name":"200 OK - Invite retrieved","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/contacts/{{contact_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"contact\": {\n \"id\": \"5ddf24a7-94cf-4f78-a4d8-4ef218f76b37\",\n \"first_name\": \"Dimitri\",\n \"last_name\": \"Rogahn\",\n \"email\": \"langosh.karelle@gmail.com\",\n \"company\": null,\n \"position\": null,\n \"phone\": null,\n \"invites_count\": 0,\n \"creator\": {\n \"id\": \"8f9b0a22-c111-41cd-bcb2-81036c64977c\",\n \"first_name\": \"Sunny\",\n \"last_name\": \"Quitzon\",\n \"email\": \"wyman.mills@hotmail.com\",\n \"avatar_url\": null,\n \"created_at\": \"2024-10-03T16:54:52+13:00\",\n \"last_login_at\": null\n },\n \"created_at\": \"2024-10-03T16:54:52+13:00\",\n \"completed_at\": null\n }\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"a48dd6a4-14e4-4954-8e2a-ebd754390754","name":"401 Unauthorized - No access token","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"{{region}}.fileinvite.app/2023-02/contacts/{{contact_id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthenticated.\"\n}"},{"id":"bca48e5b-9f3b-4752-8b24-5283cf78517b","name":"403 Forbidden - No organisation-id header","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"}],"url":"app.fileinvite.co/2023-02/contacts/{{contact_id}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - organization-id\"\n}"},{"id":"684a2832-3806-4279-beee-f1d9ceb50843","name":"404 Not Found - Invalid invite ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Resource not found.\"\n}"}],"_postman_id":"42c63a4a-6ff5-474c-ac5b-cc881c3d6139"}],"id":"9c0916b7-a2cf-4967-aeef-3b45bc026b9f","_postman_id":"9c0916b7-a2cf-4967-aeef-3b45bc026b9f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","id":"99068099-e00d-4e53-aaca-05f4d5c453e9","name":"API Reference","type":"folder"}}},{"name":"Invites","item":[{"name":"Requests","item":[{"name":"Create Invite Request","event":[{"listen":"test","script":{"id":"4ebcbb34-d69d-4a60-9e8c-df026f1b15ef","exec":["const response = pm.response.json();","pm.environment.set(\"request_id\", response.data.request.id);"],"type":"text/javascript","packages":{}}}],"id":"2a518bbe-a200-47bf-8b11-4cf99e89e469","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"rem ipsa est\",\n \"description\": \"Quaerat nisi quis earum voluptas consectetur. Dolorum quo et eligendi sunt nam. Iusto voluptas ipsum delectus facilis nisi eveniet non. Cupiditate omnis nulla aut ea perspiciatis dolor. Et ex est accusantium facilis porro nihil harum.\",\n \"type\": \"file-upload\",\n \"pdf_redactions\": []\n}"},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests","description":"

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Status	Description
invite_id	string	required	Valid invite uuid

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Status	Description
title	string	required	Max 150 characters.
description	string	optional
order	string	required	Order of the request.
type	string	required	Type of request.
pdf_redactions	array	optional	Valid pdf redaction uuid

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
invite_ids	string	required	Invite UUIDs to be deleted
description	string	optional
type	string	required	Type of reques

","urlObject":{"path":["2023-02","invites","{{invite_id}}","requests"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"2563acf1-f3d5-4c75-916c-2ce0aa9e1655","name":"200 OK - Invite request deleted","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"stZGMPZ5ZX"},{"key":"organisation-id","value":"stZGMPZ5ZX"}],"body":{"mode":"raw","raw":"{\n \"requests\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites//{{invite_id}}/requests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"message\": \"Record has been deleted.\"\n}"},{"id":"7e0c5851-f580-4d85-92d2-1bc8547f0bf0","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"00000000-0000-0000-000000000000"}],"body":{"mode":"raw","raw":"{\n \"requests\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites//{{invite_id}}/requests"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - organization-id\"\n}"},{"id":"51c38d48-279c-4f31-87ca-abf1b618f75c","name":"422 Unprocessable Entity - Field validation errors","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"00000000-0000-0000-000000000000"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000"}],"body":{"mode":"raw","raw":"{\n \"requests\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites//{{invite_id}}/requests"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The selected requests.0.id is invalid.\",\n \"errors\": {\n \"requests.0.id\": [\n \"The selected requests.0.id is invalid.\"\n ]\n }\n}"},{"id":"b83404d4-df63-416d-98d3-30077284a8ea","name":"422 Unprocessable Entity - Empty","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"00000000-0000-0000-000000000000"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites//{{invite_id}}/requests"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The requests field is required.\",\n \"errors\": {\n \"requests\": [\n \"The requests field is required.\"\n ]\n }\n}"}],"_postman_id":"1b966342-b9d4-47cd-9916-20fd16382a5e"},{"name":"Get Invite Requests","id":"3f94961a-445f-4611-8ae5-f2219c333b3c","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests?filter[exclude_follow_up_requests]=1","urlObject":{"path":["2023-02","invites","{{invite_id}}","requests"],"host":["{{region}}.fileinvite.app"],"query":[{"key":"filter[exclude_follow_up_requests]","value":"1"}],"variable":[]}},"response":[{"id":"2f3e9327-3815-4408-8dcc-e50c05b8e9ee","name":"200 OK - Without a file","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"requests\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"title\": \"illum sed rerum\",\n \"description\": \"asd\",\n \"type\": \"file-upload\",\n \"order\": 12,\n \"status\": \"draft\",\n \"meta\": \"{}\",\n \"pdf_redactions\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"SSN redaction (US)\",\n \"created_at\": \"2024-01-31T09:09:03+11:00\"\n }\n ],\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": null,\n \"last_name\": null,\n \"email\": \"john.doe2@fileinvite.com\",\n \"region\": \"AU\",\n \"avatar_url\": \"{{s3_endpoint}}/ap-southeast-2.api.gen2.co/users/e39f263b-cf0b-4eba-a2e7-890fb1a71b4e/uploads/j3uLHJsPEJsJVIrxYUHh7uyt9FzFB6GbFMMXpZvO.jpg\"\n },\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000001\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@fileinvite.com\",\n \"status\": \"draft\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000002\",\n \"first_name\": \"Joe\",\n \"last_name\": \"Mango\",\n \"email\": \"jmango@fileinvite.com\",\n \"status\": \"draft\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ],\n \"files\": [],\n \"created_at\": \"2023-06-08T23:47:28+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests\",\n \"per_page\": 15,\n \"to\": 10\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"8b653f49-d3f8-40f7-b33c-966e2bbbdc38","name":"200 OK - With files","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"requests\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"title\": \"abcd\",\n \"description\": \"aa\",\n \"type\": \"file-upload\",\n \"order\": 3,\n \"status\": \"progressing\",\n \"meta\": \"{}\",\n \"pdf_redactions\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"SSN redaction (US)\",\n \"created_at\": \"2024-01-31T09:09:03+11:00\"\n }\n ],\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": null,\n \"last_name\": null,\n \"email\": \"john.doe2@fileinvite.com\",\n \"region\": \"AU\",\n \"avatar_url\": \"{{s3_endpoint}}/ap-southeast-2.api.gen2.co/users/e39f263b-cf0b-4eba-a2e7-890fb1a71b4e/uploads/j3uLHJsPEJsJVIrxYUHh7uyt9FzFB6GbFMMXpZvO.jpg\"\n },\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000001\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"status\": \"progressing\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000002\",\n \"first_name\": \"Joe\",\n \"last_name\": \"Mango\",\n \"email\": \"jmango@fileinvite.com\",\n \"status\": \"draft\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ],\n \"files\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"original_name\": \"suscipit-quidem-maxime.pdf\",\n \"mime_type\": \"application/pdf\",\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@djpich.com\",\n \"type\": \"user\"\n },\n \"created_at\": \"2023-06-09T02:54:34+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"original_name\": \"alias-voluptatem-voluptas.pdf\",\n \"mime_type\": \"application/pdf\",\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"type\": \"contact\"\n },\n \"created_at\": \"2023-06-09T02:54:37+00:00\"\n }\n ],\n \"created_at\": \"2023-05-24T06:58:04+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests\",\n \"per_page\": 15,\n \"to\": 10\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"14aba209-9c39-424a-8053-040aab0ec32a","name":"200 OK - With Live Forms","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"requests\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"title\": \"abcd\",\n \"description\": \"aa\",\n \"type\": \"live-form\",\n \"order\": 3,\n \"status\": \"progressing\",\n \"meta\": \"{}\",\n \"pdf_redactions\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"SSN redaction (US)\",\n \"created_at\": \"2024-01-31T09:09:03+11:00\"\n }\n ],\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": null,\n \"last_name\": null,\n \"email\": \"john.doe2@fileinvite.com\",\n \"region\": \"AU\",\n \"avatar_url\": \"{{s3_endpoint}}/ap-southeast-2.api.gen2.co/users/e39f263b-cf0b-4eba-a2e7-890fb1a71b4e/uploads/j3uLHJsPEJsJVIrxYUHh7uyt9FzFB6GbFMMXpZvO.jpg\"\n },\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000001\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"status\": \"progressing\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ],\n \"files\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"original_name\": \"suscipit-quidem-maxime.pdf\",\n \"mime_type\": \"application/pdf\",\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@djpich.com\",\n \"type\": \"user\"\n },\n \"created_at\": \"2023-06-09T02:54:34+00:00\",\n \"liveform\": {\n \"fields\": {\n \"id\": \"98fad5eb-c7ed-4193-ad0a-4bad8ae5f7f1\",\n \"xfdf_data\": \"liveform field xfdf\",\n \"json_data\": \"{}\"\n },\n \"values\": [\n {\n \"id\": \"98fad5eb-c7ed-4193-ad0a-4bad8ae5f7f2\",\n \"xfdf_data\": \"liveform value xfdf\",\n \"json_data\": null,\n \"creator\": {\n \"id\": \"6dd46ddb-ef6c-430a-8432-db22a6fb4694\",\n \"first_name\": \"Carmelo\",\n \"last_name\": \"Runolfsdottir\",\n \"email\": \"j.doe@fileinvite.com\",\n \"type\": \"contact\"\n }\n }\n ]\n }\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"original_name\": \"alias-voluptatem-voluptas.pdf\",\n \"mime_type\": \"application/pdf\",\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"type\": \"contact\"\n },\n \"created_at\": \"2023-06-09T02:54:37+00:00\"\n }\n ],\n \"created_at\": \"2023-05-24T06:58:04+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests\",\n \"per_page\": 15,\n \"to\": 10\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"85435318-8ba4-4d69-aaa7-cf522ed16ace","name":"200 OK - Request Revision","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"requests\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"title\": \"abcd\",\n \"description\": \"aa\",\n \"type\": \"file-upload\",\n \"order\": 3,\n \"status\": \"progressing\",\n \"meta\": \"{}\",\n \"pdf_redactions\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"SSN redaction (US)\",\n \"created_at\": \"2024-01-31T09:09:03+11:00\"\n }\n ],\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": null,\n \"last_name\": null,\n \"email\": \"john.doe2@fileinvite.com\",\n \"region\": \"AU\",\n \"avatar_url\": \"{{s3_endpoint}}/ap-southeast-2.api.gen2.co/users/e39f263b-cf0b-4eba-a2e7-890fb1a71b4e/uploads/j3uLHJsPEJsJVIrxYUHh7uyt9FzFB6GbFMMXpZvO.jpg\"\n },\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000001\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"status\": \"progressing\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000002\",\n \"first_name\": \"Joe\",\n \"last_name\": \"Mango\",\n \"email\": \"jmango@fileinvite.com\",\n \"status\": \"draft\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ],\n \"files\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"original_name\": \"suscipit-quidem-maxime.pdf\",\n \"mime_type\": \"application/pdf\",\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@djpich.com\",\n \"type\": \"user\"\n },\n \"created_at\": \"2023-06-09T02:54:34+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"original_name\": \"alias-voluptatem-voluptas.pdf\",\n \"mime_type\": \"application/pdf\",\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"type\": \"contact\"\n },\n \"created_at\": \"2023-06-09T02:54:37+00:00\"\n }\n ],\n \"revision_notes\": [\n {\n \"message\": \"Please include a valid passport\",\n \"created_at\": \"2024-06-18T06:23:21+12:00\",\n \"user\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe2@fileinvite.com\",\n \"avatar_url\": null\n },\n \"contact\": {\n \"first_name\": \"Karen\",\n \"last_name\": \"Ramsay\",\n \"email\": \"karen.ramsay@fileinvite.com\"\n }\n }\n ],\n \"created_at\": \"2023-05-24T06:58:04+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests\",\n \"per_page\": 15,\n \"to\": 10\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"1e740706-d4da-4140-bb72-9fbcdd2cf7af","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - organization-id\"\n}"}],"_postman_id":"3f94961a-445f-4611-8ae5-f2219c333b3c"},{"name":"Update Invite Request","id":"5228756d-9edd-4c2f-9c92-d102bce8b6bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account_id}}","type":"text"},{"key":"organisation-id","value":"{{organisation_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"sit suscipit officiis\",\n \"description\": \"Necessitatibus excepturi laboriosam voluptatem nesciunt cupiditate. Sit architecto animi rerum vitae exercitationem et. Quidem non et temporibus sequi non. Cum aut veritatis. Tempore quia voluptate sequi. Velit natus qui at in.\",\n \"type\": \"written-response\",\n \"pdf_redactions\": []\n}"},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}","description":"

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
invite_id	string	required	UUID of the invite.
request_id	string	required	UUID of the invite request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
title	string	required	Max 150 characters.
description	string	optional
type	string	required	Type of request.
pdf_redactions	array	optional	PDF Redaction UUID

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
invite_id	string	required	UUID of the invite.
request_id	string	required	UUID of the invite request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
contact_ids	string	required	Contact UUids
message	string	optional	Max 500 characters.

","urlObject":{"path":["2023-02","invites","{{invite_id}}","requests","{{request_id}}","revision"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"2c8a1fa9-c601-40fa-b727-814535450ad2","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"contact_ids\": [\n \"00000000-0000-0000-000000000000\",\n \"00000000-0000-0000-000000000001\"\n ],\n \"message\": \"Hi Karen and Joe, I am rejecting your bank statement for the following reasons\"\n}","options":{"raw":{"language":"json"}}},"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}/requests/{{request_id}}/request_revision"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"message\": \"You've requested Shanelle Nicolas to revise their returned items.\"\n}"},{"id":"971c6298-7b2a-4636-9281-b04d4124bf21","name":"422 Unprocessable Entity - Field validation errors","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"contact_ids\": [\n \"00000000-0000-0000-000000000000\"\n ],\n \"message\": \"Hi Karen, I am rejecting your bank statement for the following reasons...\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}/request_revision"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The message must not be greater than 500 characters. (and 1 more error)\",\n \"errors\": {\n \"message\": [\n \"The message must not be greater than 500 characters.\"\n ],\n \"contact_ids.1\": [\n \"The selected contact_ids.1 is invalid.\"\n ]\n }\n}"},{"id":"31949452-7490-4427-90ba-f68099db7c0e","name":"403 Forbidden Copy","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"00000000-0000-0000-000000000000"}],"body":{"mode":"raw","raw":"{\n \"contact_ids\": [\n \"00000000-0000-0000-000000000000\",\n \"00000000-0000-0000-000000000001\"\n ],\n \"message\": \"Hi Karen and Joe, I am rejecting your bank statement for the following reasons\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites//{{invite_id}}/requests/request_revision"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - organization-id\"\n}"}],"_postman_id":"0414aa83-1415-4012-a755-6a6484d9f8b5"},{"name":"Accept Contact Request","id":"1598aebb-de55-427b-9983-5e070c656787","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"contact_ids\": [\n \"{{contact_id}}\"\n ],\n \"message\": \"saepe aut non\"\n}"},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}/accept","description":"

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
invite_id	string	required	UUID of the invite.
request_id	string	required	UUID of the invite request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
contact_ids	string	required	Contact UUids
message	string	optional	Max 500 characters.

","urlObject":{"path":["2023-02","invites","{{invite_id}}","requests","{{request_id}}","accept"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"4f031fbd-df14-42ef-a3cd-403aa85c9bac","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"contact_ids\": [\n \"00000000-0000-0000-000000000000\",\n \"00000000-0000-0000-000000000001\"\n ],\n \"message\": \"Hi Karen and Joe, I am rejecting your bank statement for the following reasons\"\n}","options":{"raw":{"language":"json"}}},"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}/requests/{{request_id}}/request_revision"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"message\": \"The returned items of Shanelle Nicolas was accepted.\"\n}"},{"id":"a8eedf6f-38eb-4dd3-88c4-2465ac39f4d4","name":"422 Unprocessable Entity - Field validation errors","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"contact_ids\": [\n \"00000000-0000-0000-000000000000\"\n ],\n \"message\": \"Hi Karen, I am rejecting your bank statement for the following reasons...\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}/request_revision"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The message must not be greater than 500 characters. (and 1 more error)\",\n \"errors\": {\n \"contact_ids.1\": [\n \"The selected contact_ids.1 is invalid.\"\n ]\n }\n}"},{"id":"062cf649-66e7-47cd-9244-f095317a6a37","name":"403 Forbidden Copy","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"00000000-0000-0000-000000000000"}],"body":{"mode":"raw","raw":"{\n \"contact_ids\": [\n \"00000000-0000-0000-000000000000\",\n \"00000000-0000-0000-000000000001\"\n ],\n \"message\": \"Hi Karen and Joe, I am rejecting your bank statement for the following reasons\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites//{{invite_id}}/requests/request_revision"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - organization-id\"\n}"}],"_postman_id":"1598aebb-de55-427b-9983-5e070c656787"},{"name":"Data extraction - Get LiveForm Key values","id":"9367afff-c823-4caa-a004-797ff13cdc7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}/form-fields-values","urlObject":{"path":["2023-02","invites","{{invite_id}}","requests","{{request_id}}","form-fields-values"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"4a4ddb5d-ede2-47c2-a5c5-2146564af0d3","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}/form-fields-values"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sun, 25 May 2025 22:56:11 GMT"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"contacts\": [\n {\n \"id\": \"58437086-fcc9-4919-9b27-ea1cda653b89\",\n \"first_name\": \"Ringo\",\n \"last_name\": \"Starr\",\n \"email\": \"r.starr@fileinvite.com\"\n },\n {\n \"id\": \"c3c01319-2e7c-45ad-8009-06faeb2362a7\",\n \"first_name\": \"John\",\n \"last_name\": \"Lennon\",\n \"email\": \"j.lennon@fileinvite.com\"\n }\n ],\n \"liveform_fields\": [\n {\n \"id\": \"01JVTR36578GGPB7M1TP2Q1AAV\",\n \"type\": \"TextField\"\n },\n {\n \"id\": \"01JVTR36598FGZ3YFT274B4BCC\",\n \"type\": \"signature\"\n },\n {\n \"id\": \"01JVTR3659BGKTSVRJ1WF0MHM6\",\n \"type\": \"signature\"\n },\n {\n \"id\": \"01JVTR3659CJ2JHJCS8WZBJJN9\",\n \"type\": \"ComboBox\"\n },\n {\n \"id\": \"01JVTR3659V41YHDHN8J80TNFB\",\n \"type\": \"ListBox\"\n }\n ],\n \"liveform_values\": [\n {\n \"contact_assigned\": \"c3c01319-2e7c-45ad-8009-06faeb2362a7\",\n \"field_id\": \"01JVTS7Z8APSQ8YK3MNZ8KF33T\",\n \"field_type\": \"TextField\",\n \"field_label\": \"01JVTR1FZ86KK3JX2EQX9G16QA\",\n \"updated_at\": \"2025-05-22 01:20:42\",\n \"01JVTR1FZ86KK3JX2EQX9G16QA\": \"5/25/2025 13:20\"\n },\n {\n \"contact_assigned\": \"c3c01319-2e7c-45ad-8009-06faeb2362a7\",\n \"field_id\": \"01JVTS7Z8BYWXJ96Q8VWRS9A9R\",\n \"field_type\": \"ComboBox\",\n \"field_label\": \"smc\",\n \"updated_at\": \"2025-05-22 01:20:42\",\n \"smc\": \"1\"\n },\n {\n \"contact_assigned\": \"c3c01319-2e7c-45ad-8009-06faeb2362a7\",\n \"field_id\": \"01JVTS7Z8BBTY4D7N1E8DX0MYK\",\n \"field_type\": \"ListBox\",\n \"field_label\": \"rds\",\n \"updated_at\": \"2025-05-22 01:20:42\",\n \"rds\": \"1\"\n }\n ],\n \"type\": \"individual\",\n \"request_status\": \"progressing\"\n },\n \"message\": \"Records retrieved successfully.\"\n}"}],"_postman_id":"9367afff-c823-4caa-a004-797ff13cdc7b"}],"id":"d4f615df-72cb-4999-8d6f-119ac364ae73","_postman_id":"d4f615df-72cb-4999-8d6f-119ac364ae73","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","id":"99068099-e00d-4e53-aaca-05f4d5c453e9","name":"API Reference","type":"folder"}}},{"name":"Create Invite","item":[{"name":"Get Templates","id":"7fd414d4-b087-43bf-87dd-be9e000ce952","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"{{organisation_id}}"},{"key":"account-id","value":"{{account_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/templates?sort[column]=created_at&sort[order]=desc&per_page=25&page=1","description":"

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
sort[column]	string	optional (required if the sort[order] exists)	The column to be sorted. Only allow created_at value. Note: If both sort[column] and sort[order] do not exist the default sort[column] is created_at and sort[order] is desc.
sort[order]	string	optional (required if the sort[column] exists)	The direction of the sorting. Only allows asc or desc value. Note: If both sort[column] and sort[order] do not exist the default sort[column] is created_at and sort[order] is desc.
per_page	integer	optional	The number of items returned on the page. Allowed values 10, 25, 50, 100. If not set, the default value will be 25.
page	integer	optional	The page number to return. The default is 1.

","urlObject":{"path":["2023-02","templates"],"host":["{{region}}.fileinvite.app"],"query":[{"key":"sort[column]","value":"created_at"},{"key":"sort[order]","value":"desc"},{"key":"per_page","value":"25"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"7afcdbbd-225a-4406-a1c5-05f84e87258d","name":"200 OK - Complete list of templates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":{"raw":"{{region}}.fileinvite.app/2023-02/templates?sort[column]=created_at&sort[order]=desc&per_page=25&page=1","host":["{{region}}.fileinvite.app"],"path":["2023-02","templates"],"query":[{"key":"sort[column]","value":"created_at"},{"key":"sort[order]","value":"desc"},{"key":"per_page","value":"25"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"templates\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"Test Template\",\n \"status\": \"active\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/templates?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/templates\",\n \"per_page\": 25,\n \"to\": 4\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"78f692aa-0307-4fab-b549-2b0ab931157d","name":"200 OK - Empty list of templates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":{"raw":"{{region}}.fileinvite.app/2023-02/templates?sort[column]=created_at&sort[order]=desc&per_page=25&page=1","host":["{{region}}.fileinvite.app"],"path":["2023-02","templates"],"query":[{"key":"sort[column]","value":"created_at"},{"key":"sort[order]","value":"desc"},{"key":"per_page","value":"25"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"templates\": []\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/templates?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/templates\",\n \"per_page\": 25,\n \"to\": 4\n },\n \"message\": \"No records found.\"\n}"}],"_postman_id":"7fd414d4-b087-43bf-87dd-be9e000ce952"},{"name":"Dispatch Invite","event":[{"listen":"prerequest","script":{"id":"b625712e-3e2d-4e62-9769-473824ad77e5","exec":["const moment = require('moment');","pm.environment.set(\"due_at\", moment().add(10, 'days').format('YYYY-MM-DD'));"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"7b2f3a4c-8a18-417b-955c-b4c34415f48e","exec":["const response = pm.response.json();","pm.environment.set(\"invite_id\", response.data.invite.id);"],"type":"text/javascript","packages":{}}}],"id":"c50e5f3f-fc40-4e03-b5a4-5c24fe664e65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"qui quia quis\",\n \"due_at\": \"{{due_at}}\",\n \"contacts\": [\n {\n \"first_name\": \"Caroline\",\n \"last_name\": \"Tillman\",\n \"email\": \"{{username}}+29795d62-7141-414c-ad50-cf4a59656dab@fileinvite.com\"\n }\n ],\n \"notify\": true,\n \"template_id\": \"{{template_id}}\"\n}"},"url":"{{region}}.fileinvite.app/2023-02/invites/dispatch","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Status	Description
due_at	string	required	Must be a valid date format \"Y-m-d\".
contacts	array	required	Array of contacts, email, first_name and last_name required
template_id	string	required	Must be a valid UUID of a template.
from_user_id	string	optional	The assigned sender of the invite. Must be a valid UUID of a user.

","urlObject":{"path":["2023-02","invites","dispatch"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"614d2d1f-301d-4009-b156-020b9402d364","name":"201 Created - Invite created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"from_user_id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"Test Invite Name\",\n \"subject\": \"Test Invite\",\n \"message\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod.\",\n \"due_at\": \"2023–06–14T20:02:03+08:00\",\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.gen2.co/2023-02/invites"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"invite\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"Test Invite Name\",\n \"subject\": \"Test Invite\",\n \"message\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod.\",\n \"status\": \"sent\",\n \"indicator\": \"sent\",\n \"progression_percentage\": 0,\n \"due_at\": \"2023–02–14T01:02:03Z\",\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@djpich.com\",\n \"phone\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"number\": \"33719747\",\n \"country_number_code\": \"64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"portal_url\": \"https://fileinvie.app/HI7EwQL01C/hIo7Us1YAy/portal/aaa6171d-3bc9-4802-9ddc-923a340f340a?signature=cdf1f856275e8950afff8bd8daa4903e71752403617707164eb9bb3cfd95bb1c959c6ace379e834159ca11aeba5a57e13aef92ab34b3a708cdc80280bffb09e4®ion=au\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ],\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n },\n \"message\": \"New record has been created.\"\n}\n"},{"id":"bbdcac32-5a6b-4701-b449-505cd02643a7","name":"422 Unprocessable Entity","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"due_at\": \"{{due_at}}\",\n \"contacts\": [\n {\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\"\n }\n ],\n \"template_id\": \"03f983bd-14aa-40d0-ab29-15fb8bc4e420\"\n}"},"url":"{{region}}.fileinvite.app/2023-02/invites/dispatch"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The contacts.0.email field is required.\",\n \"errors\": {\n \"contacts.0.email\": [\n \"The contacts.0.email field is required.\"\n ]\n }\n}"},{"id":"d70418c2-c70a-4614-9bc0-00ad0426410d","name":"422 Unprocessable Entity","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"due_at\": \"{{due_at}}\",\n \"contacts\": [\n {\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"j.freeman@gmail.com\"\n }\n ],\n \"template_id\": \"181b4f93-a28a-43ba-b78a-73063e4291cc\"\n}"},"url":"{{region}}.fileinvite.app/2023-02/invites/dispatch"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The selected template contains a live form request with multi-type fields, which is not supported on this endpoint.\",\n \"errors\": {\n \"template_id\": [\n \"The selected template contains a live form request with multi-type fields, which is not supported on this endpoint.\"\n ]\n }\n}"}],"_postman_id":"c50e5f3f-fc40-4e03-b5a4-5c24fe664e65"},{"name":"Get Invite","id":"7376b80e-7d3b-4027-92f7-8d9246bf3f1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}","description":"

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
invite_id	string	required	UUID of the invite.

","urlObject":{"path":["2023-02","invites","{{invite_id}}"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"4ad59159-2d4c-4858-ae10-1faefa62f379","name":"200 OK - Invite retrieved","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"invite\": {\n \"id\": \"33e4ca23-33be-4ed1-b649-a0d6e716f463\",\n \"subject\": \"corrupti placeat excepturi\",\n \"message\": \"Dolor incidunt officia beatae exercitationem error nemo. Sed illo sed non ex aut molestias. Neque nemo quod ducimus et aut autem dolorum. Illum voluptas dicta reiciendis perspiciatis similique ea excepturi.\",\n \"due_at\": \"2023-09-30T12:01:01+00:00\",\n /**\n * Invite status can be one of the following values\n * \n * draft, scheduled, sent, progressing, ready_for_review, in_review, completed, archived\n **/ \n \"status\": \"draft\", \n /**\n * Invite indicator can have one of following values\n *\n * draft,sent, no_progress, progressing, awaiting_review, accepted, in_review, complete, overdue, due_today\n * archived\n **/\n \"indicator\": \"draft\",\n \"progression_percentage\": 0,\n \"almost_due_reminder\": 0,\n \"overdue_reminder\": 0,\n \"from_user\": {\n \"id\": \"4d39c539-0a65-4d36-b80c-7abb51419075\",\n \"first_name\": \"Christian\",\n \"last_name\": \"Batz\",\n \"email\": \"testpostman123+affa002c-20c9-4d4c-9215-5f686b424e1a@fileinvite.com\",\n \"avatar_url\": null,\n \"created_at\": \"2024-04-08T20:46:21+12:00\"\n },\n \"contacts\": [\n {\n \"id\": \"839dc411-34e4-40f5-a67e-64338352fe0b\",\n \"first_name\": \"Gino\",\n \"last_name\": \"McClure\",\n \"email\": \"testpostman123+dffa002c-20c9-4d4c-9215-5f686b424afb@fileinvite.com\",\n \"phone\": {\n \"id\": \"400b5660-72cd-449d-8927-6bbb09065435\",\n \"number\": \"123456789\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"portal_url\": \"https://portal.dev.file-invite.org/023f8052-bddc-4a75-8b55-3bf2078721c0/00033da3-29c3-4c58-b13a-97cb7099b5c8/portal/85b20bfa-a189-4f7a-8495-9ea0b45d6ba8?signature=70d906ed39e0735e341b81680723a8aecabf835eef643a9f1848fa7ddc8e1d85b7e5f2a7c138628817b2a9a1049185a05ddb34c7fadf216197489860729e775d®ion=au\",\n \"created_at\": \"2023-09-19T23:16:56+00:00\"\n }\n ],\n \"created_at\": \"2023-09-19T23:20:39+00:00\",\n \"meta\": null,\n \"last_activity_at\": \"2023-09-19T23:20:39+00:00\"\n }\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"35c2e15a-5e9f-4d97-a78a-1476a4d2f2d7","name":"401 Unauthorized - No access token","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthenticated.\"\n}"},{"id":"77b4370d-e359-431c-9445-b523c5f35855","name":"403 Forbidden - No organisation-id header","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"}],"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - organization-id\"\n}"},{"id":"94a50f63-0f1f-41c8-86c7-747656f4dacc","name":"403 Forbidden - No account-id header","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - account-id\"\n}"},{"id":"6c878347-dafd-4b11-9fc2-b1b30993759d","name":"404 Not Found - Invalid invite ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Resource not found.\"\n}"}],"_postman_id":"7376b80e-7d3b-4027-92f7-8d9246bf3f1c"},{"name":"Dispatch Invite","event":[{"listen":"prerequest","script":{"id":"b625712e-3e2d-4e62-9769-473824ad77e5","exec":["const moment = require('moment');","pm.environment.set(\"due_at\", moment().add(10, 'days').format('YYYY-MM-DD'));"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"7b2f3a4c-8a18-417b-955c-b4c34415f48e","exec":["const response = pm.response.json();","pm.environment.set(\"invite_id\", response.data.invite.id);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"bb93990b-e080-47a8-a04b-272f9de16e0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"from_user_id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"Test Invite Name\",\n \"subject\": \"Test Invite\",\n \"message\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod.\",\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{region}}.fileinvite.app2023-02/invites","urlObject":{"protocol":"https","path":["invites"],"host":["{{region}}.fileinvite.app2023-02"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb93990b-e080-47a8-a04b-272f9de16e0e"}],"id":"e7707311-e84e-4323-81d7-57c65e52c9ed","_postman_id":"e7707311-e84e-4323-81d7-57c65e52c9ed","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","id":"99068099-e00d-4e53-aaca-05f4d5c453e9","name":"API Reference","type":"folder"}}},{"name":"Updating an Invite","item":[{"name":"Add Contact(s) To An Invite","id":"8fd37b6d-eca0-4413-9f0c-ab659588276e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"contact_ids\": [\n \"{{contact_id}}\"\n ],\n \"contact_group_ids\": [\n {{contact_group_id}}\n ]\n}"},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/contacts","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Status	Description
contacts	array	required	Associated with the account that the user belongs to. Supports an array of contact objects. There should be at least 1 contact. Max of 5 contacts per invite.

","urlObject":{"path":["2023-02","invites","{{invite_id}}","contacts"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"1693bdfd-499a-47a0-ad43-ec3d857a2726","name":"201 Created - Contacts assigned","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000"},{"key":"account-id","value":"00000000-0000-0000-000000000000"}],"body":{"mode":"raw","raw":"{\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000001\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000002\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"app.fileinvite.co/2023-02/invites/{uuid}/contacts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"invite\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000001\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@fileinvite.com\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000002\",\n \"first_name\": \"Joe\",\n \"last_name\": \"Mango\",\n \"email\": \"jmango@fileinvite.com\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ]\n },\n \"message\": \"New contact has been associated.\"\n }\n}"},{"id":"fb04c9b2-19e1-4edd-a9ba-91dde1b8fac5","name":"422 Unprocessable Entity - Max limit of contacts reached","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000"},{"key":"account-id","value":"00000000-0000-0000-000000000000"}],"body":{"mode":"raw","raw":"{\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites/{uuid}/contacts"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Maximum limit of 5 contacts per Invite. Contact Support to add more or try again with less contacts.\"\n}"},{"id":"9b4de2e2-2075-41df-bfda-523ffc42b3ce","name":"401 Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites/{uuid}/contacts"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthenticated.\"\n}"}],"_postman_id":"8fd37b6d-eca0-4413-9f0c-ab659588276e"},{"name":"Remove Contact From An Invite","id":"4504a669-15c0-4acf-9e1c-8b737b1638a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/contacts/{{contact_id}}","description":"

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
invite_id	string	required	UUID of the invite of the contact to be removed.
contact_id	string	required	UUID of the contact to be removed.

","urlObject":{"path":["2023-02","invites","{{invite_id}}","contacts","{{contact_id}}"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"d575d652-1ae7-470c-89f8-fb1face98689","name":"200 OK - Contact removed","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000"},{"key":"account-id","value":"00000000-0000-0000-000000000000"}],"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}/contacts/{{contact_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"invite\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"Bob\",\n \"last_name\": \"Doe\",\n \"email\": \"bob.doe@fileinvite.com\",\n \"created_at\": \"2023-05-22T08:51:54+00:00\"\n }\n ]\n }\n },\n \"message\": \"Record has been deleted.\"\n}"},{"id":"690bfc5a-5322-4608-a0c8-b74dbaaa0309","name":"401 Unauthorized - No access token","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/contacts/{{contact_id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthenticated.\"\n}"}],"_postman_id":"4504a669-15c0-4acf-9e1c-8b737b1638a9"},{"name":"Update Invite Request","id":"398e2693-a974-4cef-871e-7b86c89c7a2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account_id}}","type":"text"},{"key":"organisation-id","value":"{{organisation_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"voluptas molestiae quis\",\n \"description\": \"Exercitationem assumenda perspiciatis. Sed dicta quis saepe temporibus tempore eveniet. Distinctio ab rerum.\",\n \"type\": \"written-response\",\n \"pdf_redactions\": []\n}"},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}","description":"

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
invite_id	string	required	UUID of the invite.
request_id	string	required	UUID of the invite request.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
title	string	required	Max 150 characters.
description	string	optional
type	string	required	Type of request.
pdf_redactions	array	optional	PDF Redaction UUID

","urlObject":{"path":["2023-02","invites","{{invite_id}}","requests","{{request_id}}"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"2cda88b6-9e59-46aa-9d9c-a94b15aa1579","name":"200 OK - Invite request updated","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"ab culpa officiis\",\n \"description\": \"Quis fugit exercitationem qui non sapiente perferendis nobis sed alias. Repudiandae delectus asperiores. Occaecati porro magni blanditiis cumque qui non voluptatem. Eos aut dolore inventore inventore. Libero blanditiis nobis autem.\",\n \"type\": \"written-response\"\n}","options":{"raw":{"language":"json"}}},"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}/requests/{{request_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"request\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"title\": \"Sample upload title\",\n \"description\": \"Sample request description\", \n \"type\": \"written-response\",\n \"order\": 1,\n \"status\": \"draft\",\n \"pdf_redactions\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"SSN redaction (US)\",\n \"created_at\": \"2024-01-31T09:09:03+11:00\"\n }\n ],\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@fileinvite.com\",\n \"region\": \"AU\"\n },\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n },\n \"message\": \"Record has been updated.\"\n}"},{"id":"847c9db1-2eb2-4b60-91ee-f9ff081299ea","name":"401 Unauthorized - No access token","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"magnam ducimus doloribus\",\n \"description\": \"Veritatis numquam architecto odio. Nihil velit et consequatur qui sit temporibus vel. Corrupti quia ullam corporis voluptatem qui et. Sapiente illum dolor omnis sint ab sint magnam esse.\",\n \"type\": \"written-response\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthenticated.\"\n}"},{"id":"56aa9f4f-daca-49b6-bb09-80cf8767ba6c","name":"403 Forbidden - No organisation-id header","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"ut molestias rerum\",\n \"description\": \"Nihil quasi exercitationem mollitia eius vitae distinctio dolores deserunt omnis. Est nostrum rerum quibusdam voluptas sed.\",\n \"type\": \"written-response\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - organization-id\"\n}"},{"id":"70e90190-494e-4321-be26-180346580402","name":"403 Forbidden - No account-id header","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"organisation-id","value":"{{organisation_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"debitis similique reiciendis\",\n \"description\": \"Aut eum corrupti quae animi maiores sit doloribus qui quia. Quisquam est commodi iste dolor repudiandae rerum veniam veritatis. Quia qui consequatur perspiciatis harum provident placeat quia amet. Et exercitationem iusto. Vel aut commodi asperiores aut quia. Unde iste eveniet et corporis adipisci voluptatem.\",\n \"type\": \"written-response\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - account-id\"\n}"},{"id":"83460020-3eaa-4e9e-a9d8-55452ba18ad9","name":"404 Not Found - Invalid invite ID or request ID","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account_id}}","type":"text"},{"key":"organisation-id","value":"{{organisation_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"rerum ea maxime\",\n \"description\": \"Vitae ea aut natus modi velit. Qui fugiat enim minus esse omnis distinctio. Debitis dicta ipsum ea velit nulla tenetur. Nam quasi sint consequuntur enim fugit delectus. Corrupti laudantium dolorem eum dignissimos in.\",\n \"type\": \"written-response\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The resource was not found.\"\n}"},{"id":"80a61590-4126-4cf4-b4fb-e928c893d48d","name":"422 Unprocessable Entity - Field validation errors","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"account-id","value":"{{account_id}}","type":"text"},{"key":"organisation-id","value":"{{organisation_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"\",\n \"description\": \"Facere eligendi in totam architecto recusandae nihil doloribus. Voluptatem maiores et dolorem unde quisquam dolores impedit qui aut. Dolores asperiores exercitationem quibusdam quos nesciunt dolore et praesentium. Architecto reprehenderit sint laudantium id.\",\n \"type\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The title field is required. (and 1 more error).\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ]\n }\n}"}],"_postman_id":"398e2693-a974-4cef-871e-7b86c89c7a2d"},{"name":"Get Invite Requests","id":"adac5d76-3e80-4dc0-bd31-237b5b8b9b6f","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests?filter[exclude_follow_up_requests]=1","urlObject":{"path":["2023-02","invites","{{invite_id}}","requests"],"host":["{{region}}.fileinvite.app"],"query":[{"key":"filter[exclude_follow_up_requests]","value":"1"}],"variable":[]}},"response":[{"id":"10349b18-56c3-4e77-b1f6-20bc2d352a6a","name":"200 OK - Without a file","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"requests\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"title\": \"illum sed rerum\",\n \"description\": \"asd\",\n \"type\": \"file-upload\",\n \"order\": 12,\n /**\n * Request status will be one of the following:\n * draft, sent, progressing, ready_for_review, in_review, completed\n **/\n \"status\": \"draft\", \n \"meta\": \"{}\",\n \"pdf_redactions\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"SSN redaction (US)\",\n \"created_at\": \"2024-01-31T09:09:03+11:00\"\n }\n ],\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": null,\n \"last_name\": null,\n \"email\": \"john.doe2@fileinvite.com\",\n \"region\": \"AU\",\n \"avatar_url\": \"{{s3_endpoint}}/ap-southeast-2.api.gen2.co/users/e39f263b-cf0b-4eba-a2e7-890fb1a71b4e/uploads/j3uLHJsPEJsJVIrxYUHh7uyt9FzFB6GbFMMXpZvO.jpg\"\n },\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000001\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@fileinvite.com\",\n \"status\": \"draft\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000002\",\n \"first_name\": \"Joe\",\n \"last_name\": \"Mango\",\n \"email\": \"jmango@fileinvite.com\",\n \"status\": \"draft\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ],\n \"files\": [],\n \"created_at\": \"2023-06-08T23:47:28+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests\",\n \"per_page\": 15,\n \"to\": 10\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"baa5fcf8-3359-43d8-ba4d-875801973953","name":"200 OK - With files","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"requests\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"title\": \"abcd\",\n \"description\": \"aa\",\n \"type\": \"file-upload\",\n \"order\": 3,\n /**\n * Request status will be one of the following:\n * draft, sent, progressing, ready_for_review, in_review, completed\n **/\n \"status\": \"progressing\",\n \"meta\": \"{}\",\n \"pdf_redactions\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"SSN redaction (US)\",\n \"created_at\": \"2024-01-31T09:09:03+11:00\"\n }\n ],\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": null,\n \"last_name\": null,\n \"email\": \"john.doe2@fileinvite.com\",\n \"region\": \"AU\",\n \"avatar_url\": \"{{s3_endpoint}}/ap-southeast-2.api.gen2.co/users/e39f263b-cf0b-4eba-a2e7-890fb1a71b4e/uploads/j3uLHJsPEJsJVIrxYUHh7uyt9FzFB6GbFMMXpZvO.jpg\"\n },\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000001\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"status\": \"progressing\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000002\",\n \"first_name\": \"Joe\",\n \"last_name\": \"Mango\",\n \"email\": \"jmango@fileinvite.com\",\n \"status\": \"draft\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ],\n \"files\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"original_name\": \"suscipit-quidem-maxime.pdf\",\n \"mime_type\": \"application/pdf\",\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@djpich.com\",\n \"type\": \"user\"\n },\n \"created_at\": \"2023-06-09T02:54:34+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"original_name\": \"alias-voluptatem-voluptas.pdf\",\n \"mime_type\": \"application/pdf\",\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"type\": \"contact\"\n },\n \"created_at\": \"2023-06-09T02:54:37+00:00\"\n }\n ],\n \"created_at\": \"2023-05-24T06:58:04+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests\",\n \"per_page\": 15,\n \"to\": 10\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"ed19ded1-099f-44e6-a42b-7cb71148dde0","name":"200 OK - With Live Forms","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"requests\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"title\": \"abcd\",\n \"description\": \"aa\",\n \"type\": \"live-form\",\n \"order\": 3,\n /**\n * Request status will be one of the following:\n * draft, sent, progressing, ready_for_review, in_review, completed\n **/\n \"status\": \"progressing\",\n \"meta\": \"{}\",\n \"pdf_redactions\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"SSN redaction (US)\",\n \"created_at\": \"2024-01-31T09:09:03+11:00\"\n }\n ],\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": null,\n \"last_name\": null,\n \"email\": \"john.doe2@fileinvite.com\",\n \"region\": \"AU\",\n \"avatar_url\": \"{{s3_endpoint}}/ap-southeast-2.api.gen2.co/users/e39f263b-cf0b-4eba-a2e7-890fb1a71b4e/uploads/j3uLHJsPEJsJVIrxYUHh7uyt9FzFB6GbFMMXpZvO.jpg\"\n },\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000001\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"status\": \"progressing\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ],\n \"files\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"original_name\": \"suscipit-quidem-maxime.pdf\",\n \"mime_type\": \"application/pdf\",\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@djpich.com\",\n \"type\": \"user\"\n },\n \"created_at\": \"2023-06-09T02:54:34+00:00\",\n \"liveform\": {\n \"fields\": {\n \"id\": \"98fad5eb-c7ed-4193-ad0a-4bad8ae5f7f1\",\n \"xfdf_data\": \"liveform field xfdf\",\n \"json_data\": \"{}\"\n },\n \"values\": [\n {\n \"id\": \"98fad5eb-c7ed-4193-ad0a-4bad8ae5f7f2\",\n \"xfdf_data\": \"liveform value xfdf\",\n \"json_data\": null,\n \"creator\": {\n \"id\": \"6dd46ddb-ef6c-430a-8432-db22a6fb4694\",\n \"first_name\": \"Carmelo\",\n \"last_name\": \"Runolfsdottir\",\n \"email\": \"j.doe@fileinvite.com\",\n \"type\": \"contact\"\n }\n }\n ]\n }\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"original_name\": \"alias-voluptatem-voluptas.pdf\",\n \"mime_type\": \"application/pdf\",\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"type\": \"contact\"\n },\n \"created_at\": \"2023-06-09T02:54:37+00:00\"\n }\n ],\n \"created_at\": \"2023-05-24T06:58:04+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests\",\n \"per_page\": 15,\n \"to\": 10\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"adde7ab0-3070-497c-bff7-d4429aeb9fac","name":"200 OK - Request Revision","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true,"type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"requests\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"title\": \"abcd\",\n \"description\": \"aa\",\n \"type\": \"file-upload\",\n \"order\": 3,\n /**\n * Request status will be one of the following:\n * draft, sent, progressing, ready_for_review, in_review, completed\n **/\n \"status\": \"progressing\",\n \"meta\": \"{}\",\n \"pdf_redactions\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"SSN redaction (US)\",\n \"created_at\": \"2024-01-31T09:09:03+11:00\"\n }\n ],\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": null,\n \"last_name\": null,\n \"email\": \"john.doe2@fileinvite.com\",\n \"region\": \"AU\",\n \"avatar_url\": \"{{s3_endpoint}}/ap-southeast-2.api.gen2.co/users/e39f263b-cf0b-4eba-a2e7-890fb1a71b4e/uploads/j3uLHJsPEJsJVIrxYUHh7uyt9FzFB6GbFMMXpZvO.jpg\"\n },\n \"contacts\": [\n {\n \"id\": \"00000000-0000-0000-000000000001\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"status\": \"progressing\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000002\",\n \"first_name\": \"Joe\",\n \"last_name\": \"Mango\",\n \"email\": \"jmango@fileinvite.com\",\n \"status\": \"draft\",\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ],\n \"files\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"original_name\": \"suscipit-quidem-maxime.pdf\",\n \"mime_type\": \"application/pdf\",\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Freeman\",\n \"email\": \"jfreeman@djpich.com\",\n \"type\": \"user\"\n },\n \"created_at\": \"2023-06-09T02:54:34+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"original_name\": \"alias-voluptatem-voluptas.pdf\",\n \"mime_type\": \"application/pdf\",\n \"creator\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"type\": \"contact\"\n },\n \"created_at\": \"2023-06-09T02:54:37+00:00\"\n }\n ],\n \"revision_notes\": [\n {\n \"message\": \"Please include a valid passport\",\n \"created_at\": \"2024-06-18T06:23:21+12:00\",\n \"user\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe2@fileinvite.com\",\n \"avatar_url\": null\n },\n \"contact\": {\n \"first_name\": \"Karen\",\n \"last_name\": \"Ramsay\",\n \"email\": \"karen.ramsay@fileinvite.com\"\n }\n }\n ],\n \"created_at\": \"2023-05-24T06:58:04+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/invites/82e2c9e4-636b-42db-b2bc-838dad3e7daf/requests\",\n \"per_page\": 15,\n \"to\": 10\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"76303d24-c3aa-4963-80a9-2f3da4e77714","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - organization-id\"\n}"}],"_postman_id":"adac5d76-3e80-4dc0-bd31-237b5b8b9b6f"},{"name":"Update Invite","event":[{"listen":"prerequest","script":{"id":"a827d35e-03fc-403d-be1f-83892e5b9551","exec":["const moment = require('moment');","pm.environment.set(\"due_at\", moment().add(10, 'days').format('YYYY-MM-DD'));"],"type":"text/javascript","packages":{}}}],"id":"1f012944-5e55-4350-bd7b-540f19a2e309","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"from_user_id\": \"{{user_id}}\",\n \"assignee_user_id\": \"{{user_id}}\",\n \"subject\": \"quis in dolorem\",\n \"message\": \"Rerum nemo veniam nam. Aut atque sunt ea voluptatem amet sit et. Reprehenderit non nihil rem. Numquam nam assumenda porro inventore repellat facere quia. Sed explicabo pariatur quaerat et asperiores.\",\n \"due_at\": \"{{due_at}}\",\n \"almost_due_reminder\": 0,\n \"overdue_reminder\": 0\n}"},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Status	Description
subject	string	required if message is empty	Max 100 characters.
message	string	required if subject is empty
due_at	string	optional	Must be a valid date format \"Y-m-d\".
from_user_id	string	optional	The assigned sender of the invite. Must be a valid UUID of a user.

","urlObject":{"path":["2023-02","invites","{{invite_id}}"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"a930fb49-f0c3-4f8d-8e37-12bbdf280009","name":"200 OK - Invite updated","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"from_user_id\": \"00000000-0000-0000-000000000000\",\n \"subject\": \"Test Invite\",\n \"message\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod.\",\n \"due_at\": \"2023–06–14T20:02:03+08:00\"\n}","options":{"raw":{"language":"json"}}},"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"invite\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"subject\": \"Test Invite\",\n \"message\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod.\",\n \"due_at\": \"2023–02-14T01:02:03Z\",\n \"status\": \"draft\", //Statuses: draft, scheduled, sent, progressing, ready_for_review, in_review, completed, archived\n \"indicator\": \"draft\",\n \"progression_percentage\": 0,\n \"almost_due_reminder\": 0,\n \"overdue_reminder\": 0,\n \"created_at\": \"2023-02-13T05:50:46+00:00\",\n \"updated_at\": \"2023-02-13T05:50:46+00:00\",\n \"last_activity_at\": \"2023-09-19T23:20:39+00:00\"\n }\n },\n \"message\": \"Record has been updated.\"\n}\n"},{"id":"b3b4d519-f2a7-42b6-aab6-e264913376fe","name":"422 Unprocessable Entity - Field validation errors","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"stZGMPZ5ZX"},{"key":"organisation-id","value":"stZGMPZ5ZX"}],"body":{"mode":"raw","raw":"{\n \"from_user_id\": \"\",\n \"subject\": \"\",\n \"message\": \"\",\n \"due_at\": \"2023–06–\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The subject field is required. (and 4 more errors).\",\n \"errors\": {\n \"subject\": [\n \"A valid Subject or Message is required to save an Invite as a Draft.\"\n ],\n \"due_at\": [\n \"Invalid Date Format. Format should be ISO 8601 format YYYY-MM-DDThh:mm:ssZ\"\n ]\n }\n}"},{"id":"a8f82663-bf98-4f6a-bc2f-e6b52f226614","name":"403 Forbbiden","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from_user_id\": \"5f33919a-a1dd-44a1-a78d-99c81151ffff\",\n \"subject\": \"Test1\",\n \"message\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod\",\n \"due_at\": \"2023–06–14T20:02:03+08:00\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - organization-id\"\n}"},{"id":"ba0ba4be-ae1c-44dd-8700-3261bed5a726","name":"500 Internal Server Error","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"from_user_id\": \"5f33919a-a1dd-44a1-a78d-99c81151ffff\",\n \"subject\": \"Test1\",\n \"message\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod\",\n \"due_at\": \"2023–06–14T20:02:03+08:00\"\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Something went wrong. Please try again. If the problem continue to persist, contact us.\"\n}"}],"_postman_id":"1f012944-5e55-4350-bd7b-540f19a2e309"},{"name":"Resend Invite","id":"a52eca47-db74-44ed-82e0-477096c2f13e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"message\": \"Eos praesentium laborum non qui repudiandae facilis quam rem consequatur.\",\n \"contact_ids\": [\n \"b8de1a0e-82d2-48b9-86fc-3a6f86391024\"\n ]\n}"},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/resend","description":"

If your customers didn’t receive the Invite email or need the link sent again, this endpoint allows you to resend the Invite email to them.

Required Parameters:
Specify the Invite ID and the Contact ID (or IDs) for the customers you want to resend the Invite email to.
\n
Optional Parameter:
Include an optional custom message to appear in the resent Invite email.
\n

\n","urlObject":{"path":["2023-02","invites","{{invite_id}}","resend"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"e71b97eb-e0ac-42e8-bfb9-254c3b5334cd","name":"200 OK - Resend invite","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"message\": \"Sit dicta vitae non excepturi.\",\n \"contacts\": [\n {\n \"id\": \"b8de1a0e-82d2-48b9-86fc-3a6f86391024\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}/resend"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"message\": \"Invite was resent successfully\"\n}"},{"id":"a3309c36-3c06-4c2b-bc94-6df765f75ee9","name":"422 Unprocessable Entity","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"message\": \"a\",\n \"contacts\": [\n {\n \"id\": \"b8de1a0e-82d2-48b9-86fc-3a6f86391024\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}/resend"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The message must be at least 2 characters. (and 1 more error)\",\n \"errors\": {\n \"message\": [\n \"The message must be at least 2 characters.\"\n ],\n \"contacts.0.id\": [\n \"Contact does not belong to the invite.\",\n \"The selected contacts.0.id is invalid\"\n ]\n }\n}"}],"_postman_id":"a52eca47-db74-44ed-82e0-477096c2f13e"},{"name":"Delete Invite Request","id":"5c7b3918-4101-4629-8825-178c65152d17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"requests\": [\n {\n \"id\": \"{{request_id}}\"\n }\n ]\n}"},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
invite_ids	string	required	Invite UUIDs to be deleted
description	string	optional
type	string	required	Type of reques

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Status	Description
name	string	optional	Min 2 and Max 150 cha.

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Status	Description
name	string	optional	Min 2 and Max 150 cha.

","urlObject":{"path":["2023-02","invites","{{invite_id}}","follow-ups","{{follow_up_id}}"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"972c9416-0cad-4bef-a377-145be2941f2f","name":"200 OK - Follow retrieved","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":""},{"key":"organisation-id","value":""}],"url":"https://api.gen2.co/2023-02/invites/00000000-0000-0000-000000000000/follow-ups/00000000-0000-0000-000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"follow_up\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"Test Follow-up\",\n /**\n * Follow up status\n * Possible values: draft, sent, invalid\n **/\n \"status\": \"draft\",\n \"sent_at\": null\n }\n },\n \"message\": \"Records retrieved successfully.\"\n}\n"}],"_postman_id":"673f5bf2-aae0-4d18-938a-d1d34e78fe9e"},{"name":"List Follow-Up","id":"0f74b57e-2b65-4568-8880-e3d357026955","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/follow-ups?sort[column]=created_at&sort[order]=desc&per_page=25&page=1","urlObject":{"path":["2023-02","invites","{{invite_id}}","follow-ups"],"host":["{{region}}.fileinvite.app"],"query":[{"key":"sort[column]","value":"created_at"},{"key":"sort[order]","value":"desc"},{"key":"per_page","value":"25"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"a7d4334c-cc2e-4f44-9e8b-3b1cdfc22bd5","name":"200 OK - Follow-Up listed","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/00000000-0000-0000-000000000000/follow-ups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"follow_ups\": [\n {\n \"id\": \"b091519c-3813-4929-a136-0175c1ed15fd\",\n \"name\": \"reboot Mobility\",\n \"status\": \"draft\",\n \"sent_at\": null,\n \"requests\": [\n {\n \"id\": \"c07d04f6-ad53-47db-b54b-c05a59871d94\",\n \"title\": \"saepe magnam maxime\",\n \"description\": \"Delectus illum sed reprehenderit non voluptatem culpa quibusdam. Quibusdam commodi deleniti.\",\n \"type\": \"file-upload\",\n \"order\": 5,\n \"status\": \"draft\",\n \"indicator\": \"draft\",\n \"meta\": null,\n \"contacts\": [\n {\n \"id\": \"ad16c473-70a0-4753-a73a-13132c3e609b\",\n \"first_name\": \"Rosella\",\n \"last_name\": \"Littel\",\n \"email\": \"r.torres+4d783ec3-4cf8-45a4-abf2-dc780212e432@fileinvite.com\",\n \"status\": \"draft\",\n \"indicator\": \"draft\",\n \"created_at\": \"2024-08-28T14:48:22+12:00\",\n \"completed_at\": null\n }\n ],\n \"revision_notes\": [],\n \"created_at\": \"2024-08-28T23:30:28+12:00\"\n }\n ]\n }\n ]\n },\n \"links\": {\n \"first\": \"https://api.gen2.co/2023-02/invites/6975fdb1-70ee-48cd-9753-2b61843b37b5/follow-ups?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"https://api.gen2.co/2023-02/invites/6975fdb1-70ee-48cd-9753-2b61843b37b5/follow-ups\",\n \"per_page\": 25,\n \"to\": 1\n },\n \"message\": \"Records retrieved successfully.\"\n}"}],"_postman_id":"0f74b57e-2b65-4568-8880-e3d357026955"},{"name":"Send Follow Up","id":"37c148fd-5908-4c7e-bf4b-9a8d89006081","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/follow-ups/{{follow_up_id}}/send","urlObject":{"path":["2023-02","invites","{{invite_id}}","follow-ups","{{follow_up_id}}","send"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"16f4af4f-a075-4cef-8a53-c3268d6a0c72","name":"200 OK - Invite sent","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":""},{"key":"organisation-id","value":""}],"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}/follow-ups/{{follow_up_id}}/send"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [],\n \"message\": \"Follow-up was sent successfully\"\n}"},{"id":"8bb2f760-209f-48f7-a589-4ddb98abbe9b","name":"422 Unprocessable Entity - Field validation errors","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"00000000-0000-0000-000000000000"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000"}],"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}/follow-ups/{{follow_up_id}}/send"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"A valid Name is required to send this Follow-Up. (and 1 more error)\",\n \"errors\": {\n \"name\": [\n \"A valid Name is required to send this Follow-Up.\"\n ],\n \"requests\": [\n \"The Follow-Up should include at least 1 request before sending.\"\n ]\n }\n}"}],"_postman_id":"37c148fd-5908-4c7e-bf4b-9a8d89006081"},{"name":"Create Follow-Up","event":[{"listen":"prerequest","script":{"id":"b625712e-3e2d-4e62-9769-473824ad77e5","exec":["const moment = require('moment');","pm.environment.set(\"due_at\", moment().add(10, 'days').format('YYYY-MM-DD'));"],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"7b2f3a4c-8a18-417b-955c-b4c34415f48e","exec":["const response = pm.response.json();","pm.environment.set(\"follow_up_id\", response.data.follow_up.id);"],"type":"text/javascript","packages":{}}}],"id":"11d5963d-b4d0-4f6a-97ab-d1f232f0873d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Plastic matrix administration Steel deposit\"\n}"},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/follow-ups","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Status	Description
name	string	optional	Min 2 and Max 150 characters

","urlObject":{"path":["2023-02","invites","{{invite_id}}","follow-ups"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"771a033b-1197-4783-bdde-872ce3e1fb29","name":"201 Created - Follow-up created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer "},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Follow-up\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.gen2.co/2023-02/invites/00000000-0000-0000-000000000000/follow-ups"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"follow_up\": {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"name\": \"Test Follow-up\",\n \"status\": \"draft\",\n \"sent_at\": null\n }\n },\n \"message\": \"New record has been created.\"\n}\n"}],"_postman_id":"11d5963d-b4d0-4f6a-97ab-d1f232f0873d"}],"id":"e3384310-c2bc-4be9-ab0f-85e040da6178","_postman_id":"e3384310-c2bc-4be9-ab0f-85e040da6178","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","id":"99068099-e00d-4e53-aaca-05f4d5c453e9","name":"API Reference","type":"folder"}}},{"name":"Archive Invite","item":[{"name":"Archive Invite","id":"26a005d6-80aa-4efc-9323-bc020b79e680","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{}"},"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/archive","urlObject":{"path":["2023-02","invites","{{invite_id}}","archive"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"d4be7667-7ae4-48f0-9c10-749c16eb45f0","name":"200 OK - Invite archived","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}/send"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {},\n \"message\": \"Invite was archived successfully\"\n}"}],"_postman_id":"26a005d6-80aa-4efc-9323-bc020b79e680"}],"id":"6aed7c37-7178-4c55-9bb1-8c8c8024dd91","_postman_id":"6aed7c37-7178-4c55-9bb1-8c8c8024dd91","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","id":"99068099-e00d-4e53-aaca-05f4d5c453e9","name":"API Reference","type":"folder"}}},{"name":"Retrieving returned documents","item":[{"name":"Download FIle","id":"b4cd15da-a10c-4d63-84c4-755fff507b54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"{{organisation_id}}"},{"key":"account-id","value":"{{account_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/files/{{file_id}}/download-url","description":"

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
filter[full_name]	string	optional	Filters first name or full name (The order is first name, last name).
sort[column]	string	optional (required if the sort[order] exists)	The column to be sorted. Only allow created_at value. Note: If both sort[column] and sort[order] do not exist the default sort[column] is created_at and sort[order] is desc.
sort[order]	string	optional (required if the sort[column] exists)	The direction of the sorting. Only allows asc or desc value. Note: If both sort[column] and sort[order] do not exist the default sort[column] is created_at and sort[order] is desc.
per_page	integer	optional	The number of items returned on the page. Allowed values 10, 25, 50, 100. If not set, the default value will be 25.
page	integer	optional	The page number to return. The default is 1.

","urlObject":{"path":["2023-02","files","{{file_id}}","download-url"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"dda3b9f6-6a9b-43e8-8a67-c6ab008ed1d0","name":"200 OK - File Download","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000"},{"key":"account-id","value":"00000000-0000-0000-000000000000"}],"body":{"mode":"raw","raw":"{\n \"files\" : [\n {\n \"id\": \"00000000-0000-0000-000000000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/files/{{file_id}}/download-url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"preview_url\": \"S3 Path\",\n \"target_name\": \"name.pdf\"\n },\n \"message\": \"Records retrieved successfully.\"\n}"}],"_postman_id":"b4cd15da-a10c-4d63-84c4-755fff507b54"},{"name":"Download all files as a Zip","id":"891a06a7-d02e-40bb-b6b7-c3705a7ec334","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/files/zip","description":"

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
invite_id	string	required	UUID of the invite.

","urlObject":{"path":["2023-02","invites","{{invite_id}}","files","zip"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"ca15b6b5-86f9-4dda-9833-69ff2612f8af","name":"200 OK - Invite Files Download","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/files/zip"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"signed_url\": \"/bucket/temp-uploads/users/ad167876-a2df-47bd-a80f-03eb33b23ec3/Sample%20Subject.zip?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=LKIAQAAAAAAAM6IE6QB3%2F20240121%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20240121T230749Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Signature=484a326f8eefdcbb0cc66bcf237465c70cfa23aee2247bef44ad1a432036d566\"\n },\n \"message\": \"Records retrieved successfully.\"\n}"}],"_postman_id":"891a06a7-d02e-40bb-b6b7-c3705a7ec334"}],"id":"aade2d6e-adfe-480c-a683-829129ae5446","_postman_id":"aade2d6e-adfe-480c-a683-829129ae5446","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","id":"99068099-e00d-4e53-aaca-05f4d5c453e9","name":"API Reference","type":"folder"}}},{"name":"Extract Liveform Data","item":[{"name":"Extract LiveForm Fields and Values","id":"f438aaa9-c0ca-4e46-8daa-b82aea734687","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}/form-fields-values","urlObject":{"path":["2023-02","invites","{{invite_id}}","requests","{{request_id}}","form-fields-values"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"3149a5c5-3180-47f7-b8cb-9e9fc12ec560","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}/requests/{{request_id}}/form-fields-values"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Sun, 25 May 2025 22:56:11 GMT"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"no-referrer"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"contacts\": [\n {\n \"id\": \"58437086-fcc9-4919-9b27-ea1cda653b89\",\n \"first_name\": \"Ringo\",\n \"last_name\": \"Starr\",\n \"email\": \"r.starr@fileinvite.com\"\n },\n {\n \"id\": \"c3c01319-2e7c-45ad-8009-06faeb2362a7\",\n \"first_name\": \"John\",\n \"last_name\": \"Lennon\",\n \"email\": \"j.lennon@fileinvite.com\"\n }\n ],\n \"liveform_fields\": [\n {\n \"id\": \"01JVTR36578GGPB7M1TP2Q1AAV\",\n \"type\": \"TextField\"\n },\n {\n \"id\": \"01JVTR36598FGZ3YFT274B4BCC\",\n \"type\": \"signature\"\n },\n {\n \"id\": \"01JVTR3659BGKTSVRJ1WF0MHM6\",\n \"type\": \"signature\"\n },\n {\n \"id\": \"01JVTR3659CJ2JHJCS8WZBJJN9\",\n \"type\": \"ComboBox\"\n },\n {\n \"id\": \"01JVTR3659V41YHDHN8J80TNFB\",\n \"type\": \"ListBox\"\n }\n ],\n \"liveform_values\": [\n {\n \"contact_assigned\": \"c3c01319-2e7c-45ad-8009-06faeb2362a7\",\n \"field_id\": \"01JVTS7Z8APSQ8YK3MNZ8KF33T\",\n \"field_type\": \"TextField\",\n \"field_label\": \"01JVTR1FZ86KK3JX2EQX9G16QA\",\n \"updated_at\": \"2025-05-22 01:20:42\",\n \"01JVTR1FZ86KK3JX2EQX9G16QA\": \"5/25/2025 13:20\"\n },\n {\n \"contact_assigned\": \"c3c01319-2e7c-45ad-8009-06faeb2362a7\",\n \"field_id\": \"01JVTS7Z8BYWXJ96Q8VWRS9A9R\",\n \"field_type\": \"ComboBox\",\n \"field_label\": \"smc\",\n \"updated_at\": \"2025-05-22 01:20:42\",\n \"smc\": \"1\"\n },\n {\n \"contact_assigned\": \"c3c01319-2e7c-45ad-8009-06faeb2362a7\",\n \"field_id\": \"01JVTS7Z8BBTY4D7N1E8DX0MYK\",\n \"field_type\": \"ListBox\",\n \"field_label\": \"rds\",\n \"updated_at\": \"2025-05-22 01:20:42\",\n \"rds\": \"1\"\n }\n ],\n \"type\": \"individual\",\n \"request_status\": \"progressing\"\n },\n \"message\": \"Records retrieved successfully.\"\n}"}],"_postman_id":"f438aaa9-c0ca-4e46-8daa-b82aea734687"}],"id":"14b59f05-af2d-4866-87f1-c0df66d194dc","_postman_id":"14b59f05-af2d-4866-87f1-c0df66d194dc","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","id":"99068099-e00d-4e53-aaca-05f4d5c453e9","name":"API Reference","type":"folder"}}},{"name":"Get Invite","id":"3305825e-49dc-49b6-8d33-51818e156ff9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}","description":"

URL Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Status	Description
invite_id	string	required	UUID of the invite.

","urlObject":{"path":["2023-02","invites","{{invite_id}}"],"host":["{{region}}.fileinvite.app"],"query":[],"variable":[]}},"response":[{"id":"9fbea3ed-6de6-4a0e-8de2-7672cd40ebbc","name":"200 OK - Invite retrieved","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"invite\": {\n \"id\": \"33e4ca23-33be-4ed1-b649-a0d6e716f463\",\n \"reference\": \"Test Invite Reference\",\n \"subject\": \"corrupti placeat excepturi\",\n \"message\": \"Dolor incidunt officia beatae exercitationem error nemo. Sed illo sed non ex aut molestias. Neque nemo quod ducimus et aut autem dolorum. Illum voluptas dicta reiciendis perspiciatis similique ea excepturi.\",\n \"url\": \"https://fileinvite.app/invite-listing/33e4ca23-33be-4ed1-b649-a0d6e716f463\",\n \"due_at\": \"2023-09-30T12:01:01+00:00\",\n \"status\": \"draft\",\n \"indicator\": \"draft\",\n \"progression_percentage\": 0,\n \"almost_due_reminder\": 0,\n \"overdue_reminder\": 0,\n \"from_user\": {\n \"id\": \"4d39c539-0a65-4d36-b80c-7abb51419075\",\n \"first_name\": \"Christian\",\n \"last_name\": \"Batz\",\n \"email\": \"testpostman123+affa002c-20c9-4d4c-9215-5f686b424e1a@fileinvite.com\",\n \"avatar_url\": null,\n \"created_at\": \"2024-04-08T20:46:21+12:00\"\n },\n \"contacts\": [\n {\n \"id\": \"839dc411-34e4-40f5-a67e-64338352fe0b\",\n \"first_name\": \"Gino\",\n \"last_name\": \"McClure\",\n \"email\": \"testpostman123+dffa002c-20c9-4d4c-9215-5f686b424afb@fileinvite.com\",\n \"phone\": {\n \"id\": \"400b5660-72cd-449d-8927-6bbb09065435\",\n \"number\": \"123456789\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"portal_url\": \"https://secure.fileinvite.app/023f8052-bddc-4a75-8b55-3bf2078721c0/00033da3-29c3-4c58-b13a-97cb7099b5c8/portal/85b20bfa-a189-4f7a-8495-9ea0b45d6ba8?signature=70d906ed39e0735e341b81680723a8aecabf835eef643a9f1848fa7ddc8e1d85b7e5f2a7c138628817b2a9a1049185a05ddb34c7fadf216197489860729e775d®ion=au\",\n \"created_at\": \"2023-09-19T23:16:56+00:00\"\n }\n ],\n \"created_at\": \"2023-09-19T23:20:39+00:00\",\n \"meta\": null,\n \"last_activity_at\": \"2023-09-19T23:20:39+00:00\"\n }\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"a842c1d9-bbf1-4d9f-810c-9242b467e22c","name":"401 Unauthorized - No access token","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"{{region}}.fileinvite.app/2023-02/invites/{{invite_id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthenticated.\"\n}"},{"id":"8c3cba27-a368-4202-a4fe-d87325823878","name":"403 Forbidden - No organisation-id header","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"}],"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - organization-id\"\n}"},{"id":"33b529ee-7ad2-4259-b55e-9bef2ea1d18a","name":"403 Forbidden - No account-id header","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid HTTP header - account-id\"\n}"},{"id":"b4318d0b-269e-41ce-a739-fa684976711a","name":"404 Not Found - Invalid invite ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"app.fileinvite.co/2023-02/invites/{{invite_id}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Resource not found.\"\n}"}],"_postman_id":"3305825e-49dc-49b6-8d33-51818e156ff9"}],"id":"848e9300-4fc0-48b4-9053-0553a82205b1","_postman_id":"848e9300-4fc0-48b4-9053-0553a82205b1","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","id":"99068099-e00d-4e53-aaca-05f4d5c453e9","name":"API Reference","type":"folder"}}},{"name":"Users","item":[{"name":"List Users","id":"2e813fe2-b269-4903-bef0-a82573ca20ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"url":"{{region}}.fileinvite.app/2023-02/users?filter[user]=&filter[full_name]=&filter[email]=&filter[permission]=&sort[column]=created_at&sort[order]=desc&per_page=25&page=1","description":"

Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Status	Description
email	string	required	Valid email address
first_name	string	required	Max 150 characters
last_name	string	required	Max 150 characters

","urlObject":{"path":["2023-02","users"],"host":["{{region}}.fileinvite.app"],"query":[{"key":"filter[user]","value":""},{"key":"filter[full_name]","value":""},{"key":"filter[email]","value":""},{"key":"filter[permission]","value":""},{"key":"sort[column]","value":"created_at"},{"key":"sort[order]","value":"desc"},{"key":"per_page","value":"25"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"d36299b4-8afd-444b-81a1-f4df3ad783d1","name":"422 Unprocessable Entity - Field validation errors","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"00000000-0000-0000-000000000000"},{"key":"organisation-id","value":"00000000-0000-0000-000000000000"}],"body":{"mode":"raw","raw":"{\n \"email\": \"developer@fileinvite.com\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/users"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthenticated.\"\n}"},{"id":"085cc862-95a8-4415-a73e-9774454be91c","name":"200 OK - User List","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"email\": \"developer@fileinvite.com\",\n \"first_name\": \"Jogn\",\n \"last_name\": \"Doe\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{region}}.fileinvite.app/2023-02/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.2.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 07 Feb 2024 20:51:11 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, Authorization, X-Requested-With, Application"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"users\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"developer@fileinvite.com\",\n \"avatar_url\": null,\n \"mfa_enabled\": false,\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"avatar_url\": null,\n \"mfa_enabled\": false,\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/users?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/users\",\n \"per_page\": 25,\n \"to\": 4\n },\n \"message\": \"Records retrieved successfully.\"\n}"},{"id":"2c585331-0f3c-4998-bc89-717474b4d120","name":"200 OK - Permission Filter","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"account-id","value":"{{account_id}}"},{"key":"organisation-id","value":"{{organisation_id}}"}],"body":{"mode":"raw","raw":"{\n \"email\": \"developer@fileinvite.com\",\n \"first_name\": \"Jogn\",\n \"last_name\": \"Doe\"\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{region}}.fileinvite.app/2023-02/users?filter[permission]=create_invite,delete_invite&per_page=25&page=1","host":["{{region}}.fileinvite.app"],"path":["2023-02","users"],"query":[{"key":"filter[permission]","value":"create_invite,delete_invite"},{"key":"per_page","value":"25"},{"key":"page","value":"1"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/8.2.13"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 07 Feb 2024 20:51:11 GMT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Accept, Authorization, X-Requested-With, Application"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"users\": [\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"developer@fileinvite.com\",\n \"avatar_url\": null,\n \"mfa_enabled\": false,\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n },\n {\n \"id\": \"00000000-0000-0000-000000000000\",\n \"first_name\": \"Kelly\",\n \"last_name\": \"Burke\",\n \"email\": \"kburke@coges64662@fitzola.com\",\n \"avatar_url\": null,\n \"mfa_enabled\": false,\n \"created_at\": \"2023-02-13T05:50:46+00:00\"\n }\n ]\n },\n \"links\": {\n \"first\": \"{{region}}.fileinvite.app/2023-02/users?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": null\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"{{region}}.fileinvite.app/2023-02/users\",\n \"per_page\": 25,\n \"to\": 4\n },\n \"message\": \"Records retrieved successfully.\"\n}"}],"_postman_id":"2e813fe2-b269-4903-bef0-a82573ca20ca"}],"id":"562b41cd-b2c9-4fe1-8d29-3207cf3d17d1","_postman_id":"562b41cd-b2c9-4fe1-8d29-3207cf3d17d1","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","id":"99068099-e00d-4e53-aaca-05f4d5c453e9","name":"API Reference","type":"folder"}}}],"id":"99068099-e00d-4e53-aaca-05f4d5c453e9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"_postman_id":"99068099-e00d-4e53-aaca-05f4d5c453e9","description":""}],"event":[{"listen":"prerequest","script":{"id":"bbf0aaea-f215-4532-a3bc-0352719f5ed1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"95c7df51-b2cf-488b-b630-72fbf80248ae","type":"text/javascript","exec":["pm.environment.set(\"xsrf-token\", decodeURIComponent(pm.cookies.get(\"XSRF-TOKEN\")))"]}}],"variable":[{"key":"api_domain","value":"{{region}}.fileinvite.app"},{"key":"state","value":""},{"key":"code_verifier","value":""}]}