Ringgold Identify REST API

Organizations

getOrganizationById

Retrieve an organization by id.


/organizations/{id}

Usage and SDK Samples

curl -X GET "https://api.ringgold.com/identify/rest/organizations/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrganizationsApi;

import java.io.File;
import java.util.*;

public class OrganizationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        

        OrganizationsApi apiInstance = new OrganizationsApi();
        
        Integer id = 56; // Integer | Numeric ID of the organization to get
        
        try {
            Organization result = apiInstance.getOrganizationById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationsApi#getOrganizationById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrganizationsApi;

public class OrganizationsApiExample {

    public static void main(String[] args) {
        OrganizationsApi apiInstance = new OrganizationsApi();
        
        Integer id = 56; // Integer | Numeric ID of the organization to get
        
        try {
            Organization result = apiInstance.getOrganizationById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationsApi#getOrganizationById");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"key"];


Integer *id = 56; // Numeric ID of the organization to get


OrganizationsApi *apiInstance = [[OrganizationsApi alloc] init];

// Retrieve an organization by id.
[apiInstance getOrganizationByIdWithCompletionHandler: :id
              ^(Organization output, NSError* error) {

                            if (output) {
                                NSLog(@"%@", output);
                            }

                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RinggoldIdentifyRestApi = require('ringgold_identify_rest_api');

var defaultClient = RinggoldIdentifyRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['key'] = "Token"



var api = new RinggoldIdentifyRestApi.OrganizationsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrganizationById(idcallback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrganizationByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("key", "Bearer");
            

            var apiInstance = new OrganizationsApi();
            
            
            var id = 56;  // Integer | Numeric ID of the organization to get
            
            
            

            try
            {
                
                // Retrieve an organization by id.
                
                Organization result = apiInstance.getOrganizationById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.getOrganizationById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');


$api_instance = new Swagger\Client\Api{{classname}}();
$id = 56; // Integer | Numeric ID of the organization to get


try {
    $result = $api_instance->getOrganizationById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganizationsApi->getOrganizationById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganizationsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'key'} = "Bearer";


my $api_instance = WWW::SwaggerClient::OrganizationsApi->new();
my $id = [56]; # Integer | Numeric ID of the organization to get


eval { 
    my $result = $api_instance->getOrganizationById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrganizationsApi->getOrganizationById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['key'] = 'Bearer'


# create an instance of the API class
api_instance = swagger_client.OrganizationsApi()
id = 56 # Integer | Numeric ID of the organization to get


try: 
    # Retrieve an organization by id.
    api_response = api_instance.get_organization_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationsApi->getOrganizationById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Numeric ID of the organization to get
Required

Responses

Status: 200 - Return a single organization by it's ringgold_id

Status: 404 - No record with that id


getOrganizationHierarchyById

Retrieve the organization hierarchy


/organizations/{id}/hierarchy

Usage and SDK Samples

curl -X GET "https://api.ringgold.com/identify/rest/organizations/{id}/hierarchy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrganizationsApi;

import java.io.File;
import java.util.*;

public class OrganizationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        

        OrganizationsApi apiInstance = new OrganizationsApi();
        
        Integer id = 56; // Integer | Numeric ID of the organization to get
        
        try {
            Object result = apiInstance.getOrganizationHierarchyById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationsApi#getOrganizationHierarchyById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrganizationsApi;

public class OrganizationsApiExample {

    public static void main(String[] args) {
        OrganizationsApi apiInstance = new OrganizationsApi();
        
        Integer id = 56; // Integer | Numeric ID of the organization to get
        
        try {
            Object result = apiInstance.getOrganizationHierarchyById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationsApi#getOrganizationHierarchyById");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"key"];


Integer *id = 56; // Numeric ID of the organization to get


OrganizationsApi *apiInstance = [[OrganizationsApi alloc] init];

// Retrieve the organization hierarchy
[apiInstance getOrganizationHierarchyByIdWithCompletionHandler: :id
              ^(Object output, NSError* error) {

                            if (output) {
                                NSLog(@"%@", output);
                            }

                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RinggoldIdentifyRestApi = require('ringgold_identify_rest_api');

var defaultClient = RinggoldIdentifyRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['key'] = "Token"



var api = new RinggoldIdentifyRestApi.OrganizationsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrganizationHierarchyById(idcallback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrganizationHierarchyByIdExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("key", "Bearer");
            

            var apiInstance = new OrganizationsApi();
            
            
            var id = 56;  // Integer | Numeric ID of the organization to get
            
            
            

            try
            {
                
                // Retrieve the organization hierarchy
                
                Object result = apiInstance.getOrganizationHierarchyById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.getOrganizationHierarchyById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');


$api_instance = new Swagger\Client\Api{{classname}}();
$id = 56; // Integer | Numeric ID of the organization to get


try {
    $result = $api_instance->getOrganizationHierarchyById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganizationsApi->getOrganizationHierarchyById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganizationsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'key'} = "Bearer";


my $api_instance = WWW::SwaggerClient::OrganizationsApi->new();
my $id = [56]; # Integer | Numeric ID of the organization to get


eval { 
    my $result = $api_instance->getOrganizationHierarchyById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrganizationsApi->getOrganizationHierarchyById: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['key'] = 'Bearer'


# create an instance of the API class
api_instance = swagger_client.OrganizationsApi()
id = 56 # Integer | Numeric ID of the organization to get


try: 
    # Retrieve the organization hierarchy
    api_response = api_instance.get_organization_hierarchy_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationsApi->getOrganizationHierarchyById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer (int32)
Numeric ID of the organization to get
Required

Responses

Status: 200 - An array of hierarchy members


getOrganizationsBySearch

Search for organizations


/organizations/search

Usage and SDK Samples

curl -X GET "https://api.ringgold.com/identify/rest/organizations/search?q=&city=&state=&country=&postCode=&limit=&offset=&ofr=&full=&pretty="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrganizationsApi;

import java.io.File;
import java.util.*;

public class OrganizationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyAuth
        ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
        ApiKeyAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyAuth.setApiKeyPrefix("Token");
        
        

        OrganizationsApi apiInstance = new OrganizationsApi();
        
        String q = q_example; // String | Query keyword string
        
        String city = city_example; // String | City filter
        
        String state = state_example; // String | State filter
        
        String country = country_example; // String | Country filter
        
        String postCode = postCode_example; // String | Post code filter
        
        Integer limit = 56; // Integer | 
        
        Integer offset = 56; // Integer | 
        
        Integer ofr = 56; // Integer | Filter by ofr presence. -- = any matching org,  0 = only orgs with no ofr,  1 = only orgs with ofr.

        
        Integer full = 56; // Integer | Whether to return full objects or just ringgold_ids. 0 return ringgold_ids, 1 return organization objects.

        
        Boolean pretty = true; // Boolean | Pretty prints output
        
        try {
            Object result = apiInstance.getOrganizationsBySearch(q, city, state, country, postCode, limit, offset, ofr, full, pretty);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationsApi#getOrganizationsBySearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OrganizationsApi;

public class OrganizationsApiExample {

    public static void main(String[] args) {
        OrganizationsApi apiInstance = new OrganizationsApi();
        
        String q = q_example; // String | Query keyword string
        
        String city = city_example; // String | City filter
        
        String state = state_example; // String | State filter
        
        String country = country_example; // String | Country filter
        
        String postCode = postCode_example; // String | Post code filter
        
        Integer limit = 56; // Integer | 
        
        Integer offset = 56; // Integer | 
        
        Integer ofr = 56; // Integer | Filter by ofr presence. -- = any matching org,  0 = only orgs with no ofr,  1 = only orgs with ofr.

        
        Integer full = 56; // Integer | Whether to return full objects or just ringgold_ids. 0 return ringgold_ids, 1 return organization objects.

        
        Boolean pretty = true; // Boolean | Pretty prints output
        
        try {
            Object result = apiInstance.getOrganizationsBySearch(q, city, state, country, postCode, limit, offset, ofr, full, pretty);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OrganizationsApi#getOrganizationsBySearch");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"key"];


String *q = q_example; // Query keyword string
String *city = city_example; // City filter (optional)
String *state = state_example; // State filter (optional)
String *country = country_example; // Country filter (optional)
String *postCode = postCode_example; // Post code filter (optional)
Integer *limit = 56; //  (optional)
Integer *offset = 56; //  (optional)
Integer *ofr = 56; // Filter by ofr presence. -- = any matching org,  0 = only orgs with no ofr,  1 = only orgs with ofr.
 (optional)
Integer *full = 56; // Whether to return full objects or just ringgold_ids. 0 return ringgold_ids, 1 return organization objects.
 (optional)
Boolean *pretty = true; // Pretty prints output (optional)


OrganizationsApi *apiInstance = [[OrganizationsApi alloc] init];

// Search for organizations
[apiInstance getOrganizationsBySearchWithCompletionHandler: :q
    city:city
    state:state
    country:country
    postCode:postCode
    limit:limit
    offset:offset
    ofr:ofr
    full:full
    pretty:pretty
              ^(Object output, NSError* error) {

                            if (output) {
                                NSLog(@"%@", output);
                            }

                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RinggoldIdentifyRestApi = require('ringgold_identify_rest_api');

var defaultClient = RinggoldIdentifyRestApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['key'] = "Token"



var api = new RinggoldIdentifyRestApi.OrganizationsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOrganizationsBySearch(qcallback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getOrganizationsBySearchExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyAuth
            Configuration.Default.ApiKey.Add("key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("key", "Bearer");
            

            var apiInstance = new OrganizationsApi();
            
            
            var q = q_example;  // String | Query keyword string
            
            
            
            
            var city = city_example;  // String | City filter (optional) 
            
            
            
            
            var state = state_example;  // String | State filter (optional) 
            
            
            
            
            var country = country_example;  // String | Country filter (optional) 
            
            
            
            
            var postCode = postCode_example;  // String | Post code filter (optional) 
            
            
            
            
            var limit = 56;  // Integer |  (optional) 
            
            
            
            
            var offset = 56;  // Integer |  (optional) 
            
            
            
            
            var ofr = 56;  // Integer | Filter by ofr presence. -- = any matching org,  0 = only orgs with no ofr,  1 = only orgs with ofr.
 (optional) 
            
            
            
            
            var full = 56;  // Integer | Whether to return full objects or just ringgold_ids. 0 return ringgold_ids, 1 return organization objects.
 (optional) 
            
            
            
            
            var pretty = true;  // Boolean | Pretty prints output (optional) 
            
            
            

            try
            {
                
                // Search for organizations
                
                Object result = apiInstance.getOrganizationsBySearch(q, city, state, country, postCode, limit, offset, ofr, full, pretty);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.getOrganizationsBySearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');


$api_instance = new Swagger\Client\Api{{classname}}();
$q = q_example; // String | Query keyword string
$city = city_example; // String | City filter
$state = state_example; // String | State filter
$country = country_example; // String | Country filter
$postCode = postCode_example; // String | Post code filter
$limit = 56; // Integer | 
$offset = 56; // Integer | 
$ofr = 56; // Integer | Filter by ofr presence. -- = any matching org,  0 = only orgs with no ofr,  1 = only orgs with ofr.

$full = 56; // Integer | Whether to return full objects or just ringgold_ids. 0 return ringgold_ids, 1 return organization objects.

$pretty = true; // Boolean | Pretty prints output


try {
    $result = $api_instance->getOrganizationsBySearch($q, $city, $state, $country, $postCode, $limit, $offset, $ofr, $full, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganizationsApi->getOrganizationsBySearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganizationsApi;

# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'key'} = "Bearer";


my $api_instance = WWW::SwaggerClient::OrganizationsApi->new();
my $q = [q_example]; # String | Query keyword string
my $city = [city_example]; # String | City filter
my $state = [state_example]; # String | State filter
my $country = [country_example]; # String | Country filter
my $postCode = [postCode_example]; # String | Post code filter
my $limit = [56]; # Integer | 
my $offset = [56]; # Integer | 
my $ofr = [56]; # Integer | Filter by ofr presence. -- = any matching org,  0 = only orgs with no ofr,  1 = only orgs with ofr.

my $full = [56]; # Integer | Whether to return full objects or just ringgold_ids. 0 return ringgold_ids, 1 return organization objects.

my $pretty = [true]; # Boolean | Pretty prints output


eval { 
    my $result = $api_instance->getOrganizationsBySearch(q => $q, city => $city, state => $state, country => $country, postCode => $postCode, limit => $limit, offset => $offset, ofr => $ofr, full => $full, pretty => $pretty);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OrganizationsApi->getOrganizationsBySearch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['key'] = 'Bearer'


# create an instance of the API class
api_instance = swagger_client.OrganizationsApi()
q = q_example # String | Query keyword string
city = city_example # String | City filter (optional)
state = state_example # String | State filter (optional)
country = country_example # String | Country filter (optional)
postCode = postCode_example # String | Post code filter (optional)
limit = 56 # Integer |  (optional)
offset = 56 # Integer |  (optional)
ofr = 56 # Integer | Filter by ofr presence. -- = any matching org,  0 = only orgs with no ofr,  1 = only orgs with ofr.
 (optional)
full = 56 # Integer | Whether to return full objects or just ringgold_ids. 0 return ringgold_ids, 1 return organization objects.
 (optional)
pretty = true # Boolean | Pretty prints output (optional)


try: 
    # Search for organizations
    api_response = api_instance.get_organizations_by_search(q, city=city, state=state, country=country, postCode=postCode, limit=limit, offset=offset, ofr=ofr, full=full, pretty=pretty)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrganizationsApi->getOrganizationsBySearch: %s\n" % e)

Parameters

Query parameters
Name Description
q*
String
Query keyword string
Required
city
String
City filter
state
String
State filter
country
String
Country filter
postCode
String
Post code filter
limit
Integer (int32)
offset
Integer (int32)
ofr
Integer (int32)
Filter by ofr presence. -- = any matching org, 0 = only orgs with no ofr, 1 = only orgs with ofr.
full
Integer (int32)
Whether to return full objects or just ringgold_ids. 0 return ringgold_ids, 1 return organization objects.
pretty
Boolean
Pretty prints output

Responses

Status: 200 - Success

Status: 400 - Malformed query