Introduction

For most of the API requests you will perform, your organization ID will be required. This article outlines the process of obtaining your organization ID.

To perform this procedure, you will need to be granted access to our Swagger API Interface, and you will need to have created and authorized your API key, created in the Field Effect MDR Portal. See Accessing Field Effect's API Documentation for more on gaining this required access.

Procedure

Begin by navigating to the Swagger API Interface at https://services.fieldeffect.net/apidocs. 

On the page, navigate to the following API call, found in the Organizations section:

GET/v1/organizations

Expand this API call and click the Try it out button. 

The Try it out button will become a Cancel button, signifying you are in "try it out mode". While in this mode, scroll down the expanded API call and click Execute. 

The following response will be provided. The string value for "ID" will be your organization ID. Be sure to store this securely for use with subsequent API calls.