BBB API
API and SDK Documentation
Version: v1
General Usage
The CBBB API is organized around RESTful principles - each resource has a unique URI and HTTP verbs are used to specify the action to perform on that resource. In order to write or modify a client application for CBBB, you should use a full-featured HTTP client library that supports the HTTP verbs: GET, POST, PUT and DELETE. Most modern development environments including .NET, PHP, and Java will communicate with the CBBB API. Before you get started, please ensure you familiarize yourself with the API's Authentication model and Response format.Rate limits
Global rate limits are applied inclusive of all API calls made by an app per access token, regardless of the particular endpoint. Rate limits also apply to invalid or malformed requests.| Rate | Limit |
|---|---|
| Max Requests per Month | 5,000 |
| Max Requests per Day | 500 |
| Max Requests per Hour | 100 |
| Max Requests per Minute | 20 |
Record Limit
Max Requests per Month 50,000
Authentication
Information on How We Handle Authentication
The CBBB Service API requires authentication with valid, pre-registered credentials. In order to use the API, the consumer must first authenticate their username and password. Every request made after the consumer login credentials are authenticated must include an "Authorization" header key with a Bearer token in the format of "Authorization": "Bearer <token>".
If you are interested in using the CBBB API, please contact us to register and get your user credentials.
How to Register a Token
Workflow Overview:
- Register your account with Council.
- Make the first call to the API to get an authorization token.
- After a 10 second delay, the desired endpoint may be called using that token.
- Tokens are reusable - subsequent calls to the API are made using the same token issued in step #1. There is no need to wait (assuming you don’t exceed the 100 request per minute rate limit, which can be adjusted per partner if necessary).
- If the calls made in step #3 fail because of a 401 – unauthorized error, discard your current token and return to step #1.
Authenticating the consumer username and password to obtain an authorization token:
|
URL to obtain token |
https://api.bbb.org/token |
|
HTTP method |
POST |
|
Header values |
Content-Type: application/x-www-form-urlencoded |
|
Request body |
grant_type=password&username=<username>&password=<password> Example: grant_type=password&username=someuser&password=abc123 |
Once successfully authenticated, the service will respond with an object that contains the following attributes:
.expires - what date/time the token will expire
.issued - date/time when the token was issued
access_token - the full token that will be used
expires_in - seconds until the token expires
token_type - will always be 'bearer'
username - the username (email address) used for authentication
Sample Authorization Token Request:
request to: https://api.bbb.org/token
header: content-type: application/x-www-form-url-encoded
request body: grant_type=password&username=username&password=abc123
Sample Authorization Response Body:
{
"access_token": "VOIxCyANd9dJxQ4nsAxw-93-...",
"token_type": "bearer",
"expires_in": 86313599,
"userName": "user@address.com",
".issued": "Mon, 29 Sep 2014 17:54:00 GMT",
".expires": "Sat, 24 Jun 2017 17:54:00 GMT"
}
Making Requests with the Token:
Every request after the consumer login credentials are authenticated must include an "Authorization" header key with a Bearer token in the format of "Authorization": "Bearer <token>"
Authorization header:
All requests will need to include an "Authorization" bearer header in the following format:
Authorization: Bearer VOIxCyANd9dJxQ4nsAxw-93-hViJ123ezt1xH... (shortened for readability)
Once the request is made, the API will decrypt the token and determine if it is valid. If the token is valid, the incoming request is mapped to the appropriate user, including that user's roles and attributes.
Expired Tokens:
Users should be aware that a token can expire after a specific amount of time or it can be revoked manually by Council. In these cases, the user must request another token. It is useful to build the possibility of expired tokens into your authentication process.
Unauthorized Responses:
The user will receive a 401 - Unauthorized exception if one of the following conditions occurs:
- The user's credentials are invalid when requesting a token.
- The user's token is invalid, has expired or has been revoked.
- The user's credentials and token are valid, but the user is not authorized to access a specific endpoint.
User Login/Access Token API Call (HTML Code is below form)
The token generated with a successful login will be used in the subsequent calls.
| Username: |
| Password: |
| Access Token: |
Organization Search
This endpoint will allow consumers to search for Organizations known to the BBB. Organizations may include businesses or charities. It supports pagination of results using the 'TotalResults' in the output, which displays the total number of matches by the search critieria. PageNumber and PageSize query parameters allow you to page through total results and get smaller sets at a time
/api/orgs/search
Usage and SDK Samples
curl -X get "https://api.bbb.org/api/orgs/search?pageSize=&pageNumber=&primaryOrganizationName=&organizationNameExact=&businessId=&bBBID=&bBBRating=&isBBBAccredited=&altOrganizationNames=&organizationName=&isReportable=&primaryCategory=&reportUrl=&ratingLastChanged=&organizationLastChanged=&accreditationStatusLastChanged=&organizationType=&contactFirstName=&contactLastName=&contactMiddleName=&contactTitle=&contactPrefix=&phone=&address=&city=&stateProvince=&postalCode=&businessUrl=&collectionId=&isCharity=&entityId="import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OrganizationSearchApi;
import java.io.File;
import java.util.*;
public class OrganizationSearchApiExample {
public static void main(String[] args) {
OrganizationSearchApi apiInstance = new OrganizationSearchApi();
Integer pageSize = 56; // Integer |
Integer pageNumber = 56; // Integer |
String primaryOrganizationName = primaryOrganizationName_example; // String |
String organizationNameExact = organizationNameExact_example; // String |
String businessId = businessId_example; // String |
String bBBID = bBBID_example; // String |
String bBBRating = bBBRating_example; // String |
Boolean isBBBAccredited = true; // Boolean |
String altOrganizationNames = altOrganizationNames_example; // String |
String organizationName = organizationName_example; // String |
Boolean isReportable = true; // Boolean |
String primaryCategory = primaryCategory_example; // String |
String reportUrl = reportUrl_example; // String |
Date ratingLastChanged = 2013-10-20T19:20:30+01:00; // Date |
Date organizationLastChanged = 2013-10-20T19:20:30+01:00; // Date |
Date accreditationStatusLastChanged = 2013-10-20T19:20:30+01:00; // Date |
String organizationType = organizationType_example; // String |
String contactFirstName = contactFirstName_example; // String |
String contactLastName = contactLastName_example; // String |
String contactMiddleName = contactMiddleName_example; // String |
String contactTitle = contactTitle_example; // String |
String contactPrefix = contactPrefix_example; // String |
String phone = phone_example; // String |
String address = address_example; // String |
String city = city_example; // String |
String stateProvince = stateProvince_example; // String |
String postalCode = postalCode_example; // String |
String businessUrl = businessUrl_example; // String |
Integer collectionId = 56; // Integer |
Integer isCharity = 56; // Integer |
String entityId = entityId_example; // String |
try {
inline_response_200 result = apiInstance.organizationGetOrganization(pageSize, pageNumber, primaryOrganizationName, organizationNameExact, businessId, bBBID, bBBRating, isBBBAccredited, altOrganizationNames, organizationName, isReportable, primaryCategory, reportUrl, ratingLastChanged, organizationLastChanged, accreditationStatusLastChanged, organizationType, contactFirstName, contactLastName, contactMiddleName, contactTitle, contactPrefix, phone, address, city, stateProvince, postalCode, businessUrl, collectionId, isCharity, entityId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganizationSearchApi#organizationGetOrganization");
e.printStackTrace();
}
}
}import io.swagger.client.api.OrganizationSearchApi;
public class OrganizationSearchApiExample {
public static void main(String[] args) {
OrganizationSearchApi apiInstance = new OrganizationSearchApi();
Integer pageSize = 56; // Integer |
Integer pageNumber = 56; // Integer |
String primaryOrganizationName = primaryOrganizationName_example; // String |
String organizationNameExact = organizationNameExact_example; // String |
String businessId = businessId_example; // String |
String bBBID = bBBID_example; // String |
String bBBRating = bBBRating_example; // String |
Boolean isBBBAccredited = true; // Boolean |
String altOrganizationNames = altOrganizationNames_example; // String |
String organizationName = organizationName_example; // String |
Boolean isReportable = true; // Boolean |
String primaryCategory = primaryCategory_example; // String |
String reportUrl = reportUrl_example; // String |
Date ratingLastChanged = 2013-10-20T19:20:30+01:00; // Date |
Date organizationLastChanged = 2013-10-20T19:20:30+01:00; // Date |
Date accreditationStatusLastChanged = 2013-10-20T19:20:30+01:00; // Date |
String organizationType = organizationType_example; // String |
String contactFirstName = contactFirstName_example; // String |
String contactLastName = contactLastName_example; // String |
String contactMiddleName = contactMiddleName_example; // String |
String contactTitle = contactTitle_example; // String |
String contactPrefix = contactPrefix_example; // String |
String phone = phone_example; // String |
String address = address_example; // String |
String city = city_example; // String |
String stateProvince = stateProvince_example; // String |
String postalCode = postalCode_example; // String |
String businessUrl = businessUrl_example; // String |
Integer collectionId = 56; // Integer |
Integer isCharity = 56; // Integer |
String entityId = entityId_example; // String |
try {
inline_response_200 result = apiInstance.organizationGetOrganization(pageSize, pageNumber, primaryOrganizationName, organizationNameExact, businessId, bBBID, bBBRating, isBBBAccredited, altOrganizationNames, organizationName, isReportable, primaryCategory, reportUrl, ratingLastChanged, organizationLastChanged, accreditationStatusLastChanged, organizationType, contactFirstName, contactLastName, contactMiddleName, contactTitle, contactPrefix, phone, address, city, stateProvince, postalCode, businessUrl, collectionId, isCharity, entityId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling OrganizationSearchApi#organizationGetOrganization");
e.printStackTrace();
}
}
}Integer *pageSize = 56; // (optional)
Integer *pageNumber = 56; // (optional)
String *primaryOrganizationName = primaryOrganizationName_example; // (optional)
String *organizationNameExact = organizationNameExact_example; // (optional)
String *businessId = businessId_example; // (optional)
String *bBBID = bBBID_example; // (optional)
String *bBBRating = bBBRating_example; // (optional)
Boolean *isBBBAccredited = true; // (optional)
String *altOrganizationNames = altOrganizationNames_example; // (optional)
String *organizationName = organizationName_example; // (optional)
Boolean *isReportable = true; // (optional)
String *primaryCategory = primaryCategory_example; // (optional)
String *reportUrl = reportUrl_example; // (optional)
Date *ratingLastChanged = 2013-10-20T19:20:30+01:00; // (optional)
Date *organizationLastChanged = 2013-10-20T19:20:30+01:00; // (optional)
Date *accreditationStatusLastChanged = 2013-10-20T19:20:30+01:00; // (optional)
String *organizationType = organizationType_example; // (optional)
String *contactFirstName = contactFirstName_example; // (optional)
String *contactLastName = contactLastName_example; // (optional)
String *contactMiddleName = contactMiddleName_example; // (optional)
String *contactTitle = contactTitle_example; // (optional)
String *contactPrefix = contactPrefix_example; // (optional)
String *phone = phone_example; // (optional)
String *address = address_example; // (optional)
String *city = city_example; // (optional)
String *stateProvince = stateProvince_example; // (optional)
String *postalCode = postalCode_example; // (optional)
String *businessUrl = businessUrl_example; // (optional)
Integer *collectionId = 56; // (optional)
Integer *isCharity = 56; // (optional)
String *entityId = entityId_example; // (optional)
OrganizationSearchApi *apiInstance = [[OrganizationSearchApi alloc] init];
// Search for Organizations
[apiInstance organizationGetOrganizationWith:pageSize
pageNumber:pageNumber
primaryOrganizationName:primaryOrganizationName
organizationNameExact:organizationNameExact
businessId:businessId
bBBID:bBBID
bBBRating:bBBRating
isBBBAccredited:isBBBAccredited
altOrganizationNames:altOrganizationNames
organizationName:organizationName
isReportable:isReportable
primaryCategory:primaryCategory
reportUrl:reportUrl
ratingLastChanged:ratingLastChanged
organizationLastChanged:organizationLastChanged
accreditationStatusLastChanged:accreditationStatusLastChanged
organizationType:organizationType
contactFirstName:contactFirstName
contactLastName:contactLastName
contactMiddleName:contactMiddleName
contactTitle:contactTitle
contactPrefix:contactPrefix
phone:phone
address:address
city:city
stateProvince:stateProvince
postalCode:postalCode
businessUrl:businessUrl
collectionId:collectionId
isCharity:isCharity
entityId:entityId
completionHandler: ^(inline_response_200 output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var CouncilOfBetterBusinessBureausApi = require('council_of_better_business_bureaus_api');
var api = new CouncilOfBetterBusinessBureausApi.OrganizationSearchApi()
var opts = {
'pageSize': 56, // {Integer}
'pageNumber': 56, // {Integer}
'primaryOrganizationName': primaryOrganizationName_example, // {String}
'organizationNameExact': organizationNameExact_example, // {String}
'businessId': businessId_example, // {String}
'bBBID': bBBID_example, // {String}
'bBBRating': bBBRating_example, // {String}
'isBBBAccredited': true, // {Boolean}
'altOrganizationNames': altOrganizationNames_example, // {String}
'organizationName': organizationName_example, // {String}
'isReportable': true, // {Boolean}
'primaryCategory': primaryCategory_example, // {String}
'reportUrl': reportUrl_example, // {String}
'ratingLastChanged': 2013-10-20T19:20:30+01:00, // {Date}
'organizationLastChanged': 2013-10-20T19:20:30+01:00, // {Date}
'accreditationStatusLastChanged': 2013-10-20T19:20:30+01:00, // {Date}
'organizationType': organizationType_example, // {String}
'contactFirstName': contactFirstName_example, // {String}
'contactLastName': contactLastName_example, // {String}
'contactMiddleName': contactMiddleName_example, // {String}
'contactTitle': contactTitle_example, // {String}
'contactPrefix': contactPrefix_example, // {String}
'phone': phone_example, // {String}
'address': address_example, // {String}
'city': city_example, // {String}
'stateProvince': stateProvince_example, // {String}
'postalCode': postalCode_example, // {String}
'businessUrl': businessUrl_example, // {String}
'collectionId': 56, // {Integer}
'isCharity': 56, // {Integer}
'entityId': entityId_example // {String}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.organizationGetOrganization(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class organizationGetOrganizationExample
{
public void main()
{
var apiInstance = new OrganizationSearchApi();
var pageSize = 56; // Integer | (optional)
var pageNumber = 56; // Integer | (optional)
var primaryOrganizationName = primaryOrganizationName_example; // String | (optional)
var organizationNameExact = organizationNameExact_example; // String | (optional)
var businessId = businessId_example; // String | (optional)
var bBBID = bBBID_example; // String | (optional)
var bBBRating = bBBRating_example; // String | (optional)
var isBBBAccredited = true; // Boolean | (optional)
var altOrganizationNames = altOrganizationNames_example; // String | (optional)
var organizationName = organizationName_example; // String | (optional)
var isReportable = true; // Boolean | (optional)
var primaryCategory = primaryCategory_example; // String | (optional)
var reportUrl = reportUrl_example; // String | (optional)
var ratingLastChanged = 2013-10-20T19:20:30+01:00; // Date | (optional)
var organizationLastChanged = 2013-10-20T19:20:30+01:00; // Date | (optional)
var accreditationStatusLastChanged = 2013-10-20T19:20:30+01:00; // Date | (optional)
var organizationType = organizationType_example; // String | (optional)
var contactFirstName = contactFirstName_example; // String | (optional)
var contactLastName = contactLastName_example; // String | (optional)
var contactMiddleName = contactMiddleName_example; // String | (optional)
var contactTitle = contactTitle_example; // String | (optional)
var contactPrefix = contactPrefix_example; // String | (optional)
var phone = phone_example; // String | (optional)
var address = address_example; // String | (optional)
var city = city_example; // String | (optional)
var stateProvince = stateProvince_example; // String | (optional)
var postalCode = postalCode_example; // String | (optional)
var businessUrl = businessUrl_example; // String | (optional)
var collectionId = 56; // Integer | (optional)
var isCharity = 56; // Integer | (optional)
var entityId = entityId_example; // String | (optional)
try
{
// Search for Organizations
inline_response_200 result = apiInstance.organizationGetOrganization(pageSize, pageNumber, primaryOrganizationName, organizationNameExact, businessId, bBBID, bBBRating, isBBBAccredited, altOrganizationNames, organizationName, isReportable, primaryCategory, reportUrl, ratingLastChanged, organizationLastChanged, accreditationStatusLastChanged, organizationType, contactFirstName, contactLastName, contactMiddleName, contactTitle, contactPrefix, phone, address, city, stateProvince, postalCode, businessUrl, collectionId, isCharity, entityId);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling OrganizationSearchApi.organizationGetOrganization: " + e.Message );
}
}
}
}<?php require_once(__DIR__ . '/vendor/autoload.php' );
$api_instance=new Swagger\Client\Api\OrganizationSearchApi();
$pageSize=56; // Integer |
$pageNumber = 56; // Integer |
$primaryOrganizationName = primaryOrganizationName_example; // String |
$organizationNameExact = organizationNameExact_example; // String |
$businessId = businessId_example; // String |
$bBBID = bBBID_example; // String |
$bBBRating = bBBRating_example; // String |
$isBBBAccredited = true; // Boolean |
$altOrganizationNames = altOrganizationNames_example; // String |
$organizationName = organizationName_example; // String |
$isReportable = true; // Boolean |
$primaryCategory = primaryCategory_example; // String |
$reportUrl = reportUrl_example; // String |
$ratingLastChanged = 2013-10-20T19:20:30+01:00; // Date |
$organizationLastChanged = 2013-10-20T19:20:30+01:00; // Date |
$accreditationStatusLastChanged = 2013-10-20T19:20:30+01:00; // Date |
$organizationType = organizationType_example; // String |
$contactFirstName = contactFirstName_example; // String |
$contactLastName = contactLastName_example; // String |
$contactMiddleName = contactMiddleName_example; // String |
$contactTitle = contactTitle_example; // String |
$contactPrefix = contactPrefix_example; // String |
$phone = phone_example; // String |
$address = address_example; // String |
$city = city_example; // String |
$stateProvince = stateProvince_example; // String |
$postalCode = postalCode_example; // String |
$businessUrl = businessUrl_example; // String |
$collectionId = 56; // Integer |
$isCharity = 56; // Integer |
$entityId = entityId_example; // String |
try {
$result = $api_instance->organizationGetOrganization($pageSize, $pageNumber, $primaryOrganizationName, $organizationNameExact, $businessId, $bBBID, $bBBRating, $isBBBAccredited, $altOrganizationNames, $organizationName, $isReportable, $primaryCategory, $reportUrl, $ratingLastChanged, $organizationLastChanged, $accreditationStatusLastChanged, $organizationType, $contactFirstName, $contactLastName, $contactMiddleName, $contactTitle, $contactPrefix, $phone, $address, $city, $stateProvince, $postalCode, $businessUrl, $collectionId, $isCharity, $entityId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling OrganizationSearchApi->organizationGetOrganization: ', $e->getMessage(), PHP_EOL;
}
?>use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OrganizationSearchApi;
my $api_instance = WWW::SwaggerClient::OrganizationSearchApi->new();
my $pageSize = 56; # Integer |
my $pageNumber = 56; # Integer |
my $primaryOrganizationName = primaryOrganizationName_example; # String |
my $organizationNameExact = organizationNameExact_example; # String |
my $businessId = businessId_example; # String |
my $bBBID = bBBID_example; # String |
my $bBBRating = bBBRating_example; # String |
my $isBBBAccredited = true; # Boolean |
my $altOrganizationNames = altOrganizationNames_example; # String |
my $organizationName = organizationName_example; # String |
my $isReportable = true; # Boolean |
my $primaryCategory = primaryCategory_example; # String |
my $reportUrl = reportUrl_example; # String |
my $ratingLastChanged = 2013-10-20T19:20:30+01:00; # Date |
my $organizationLastChanged = 2013-10-20T19:20:30+01:00; # Date |
my $accreditationStatusLastChanged = 2013-10-20T19:20:30+01:00; # Date |
my $organizationType = organizationType_example; # String |
my $contactFirstName = contactFirstName_example; # String |
my $contactLastName = contactLastName_example; # String |
my $contactMiddleName = contactMiddleName_example; # String |
my $contactTitle = contactTitle_example; # String |
my $contactPrefix = contactPrefix_example; # String |
my $phone = phone_example; # String |
my $address = address_example; # String |
my $city = city_example; # String |
my $stateProvince = stateProvince_example; # String |
my $postalCode = postalCode_example; # String |
my $businessUrl = businessUrl_example; # String |
my $collectionId = 56; # Integer |
my $isCharity = 56; # Integer |
my $entityId = entityId_example; # String |
eval {
my $result = $api_instance->organizationGetOrganization(pageSize => $pageSize, pageNumber => $pageNumber, primaryOrganizationName => $primaryOrganizationName, organizationNameExact => $organizationNameExact, businessId => $businessId, bBBID => $bBBID, bBBRating => $bBBRating, isBBBAccredited => $isBBBAccredited, altOrganizationNames => $altOrganizationNames, organizationName => $organizationName, isReportable => $isReportable, primaryCategory => $primaryCategory, reportUrl => $reportUrl, ratingLastChanged => $ratingLastChanged, organizationLastChanged => $organizationLastChanged, accreditationStatusLastChanged => $accreditationStatusLastChanged, organizationType => $organizationType, contactFirstName => $contactFirstName, contactLastName => $contactLastName, contactMiddleName => $contactMiddleName, contactTitle => $contactTitle, contactPrefix => $contactPrefix, phone => $phone, address => $address, city => $city, stateProvince => $stateProvince, postalCode => $postalCode, businessUrl => $businessUrl, collectionId => $collectionId, isCharity => $isCharity, entityId => $entityId);
print Dumper($result);
};
if ($@) {
warn "Exception when calling OrganizationSearchApi->organizationGetOrganization: $@\n";
}from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.OrganizationSearchApi()
pageSize = 56 # Integer | (optional)
pageNumber = 56 # Integer | (optional)
primaryOrganizationName = primaryOrganizationName_example # String | (optional)
organizationNameExact = organizationNameExact_example # String | (optional)
businessId = businessId_example # String | (optional)
bBBID = bBBID_example # String | (optional)
bBBRating = bBBRating_example # String | (optional)
isBBBAccredited = true # Boolean | (optional)
altOrganizationNames = altOrganizationNames_example # String | (optional)
organizationName = organizationName_example # String | (optional)
isReportable = true # Boolean | (optional)
primaryCategory = primaryCategory_example # String | (optional)
reportUrl = reportUrl_example # String | (optional)
ratingLastChanged = 2013-10-20T19:20:30+01:00 # Date | (optional)
organizationLastChanged = 2013-10-20T19:20:30+01:00 # Date | (optional)
accreditationStatusLastChanged = 2013-10-20T19:20:30+01:00 # Date | (optional)
organizationType = organizationType_example # String | (optional)
contactFirstName = contactFirstName_example # String | (optional)
contactLastName = contactLastName_example # String | (optional)
contactMiddleName = contactMiddleName_example # String | (optional)
contactTitle = contactTitle_example # String | (optional)
contactPrefix = contactPrefix_example # String | (optional)
phone = phone_example # String | (optional)
address = address_example # String | (optional)
city = city_example # String | (optional)
stateProvince = stateProvince_example # String | (optional)
postalCode = postalCode_example # String | (optional)
businessUrl = businessUrl_example # String | (optional)
collectionId = 56 # Integer | (optional)
isCharity = 56 # Integer | (optional)
entityId = entityId_example # String | (optional)
try:
# Search for Organizations
api_response = api_instance.organizationGetOrganization(pageSize=pageSize, pageNumber=pageNumber, primaryOrganizationName=primaryOrganizationName, organizationNameExact=organizationNameExact, businessId=businessId, bBBID=bBBID, bBBRating=bBBRating, isBBBAccredited=isBBBAccredited, altOrganizationNames=altOrganizationNames, organizationName=organizationName, isReportable=isReportable, primaryCategory=primaryCategory, reportUrl=reportUrl, ratingLastChanged=ratingLastChanged, organizationLastChanged=organizationLastChanged, accreditationStatusLastChanged=accreditationStatusLastChanged, organizationType=organizationType, contactFirstName=contactFirstName, contactLastName=contactLastName, contactMiddleName=contactMiddleName, contactTitle=contactTitle, contactPrefix=contactPrefix, phone=phone, address=address, city=city, stateProvince=stateProvince, postalCode=postalCode, businessUrl=businessUrl, collectionId=collectionId, isCharity=isCharity, entityId=entityId)
pprint(api_response)
except ApiException as e:
print("Exception when calling OrganizationSearchApi->organizationGetOrganization: %s\n" % e)Parameters
Query parameters
| Name | Description |
|---|---|
| pageSize | |
| pageNumber | |
| primaryOrganizationName | |
| organizationNameExact | |
| businessId | |
| bBBID | |
| bBBRating | |
| isBBBAccredited | |
| altOrganizationNames | |
| organizationName | |
| isReportable | |
| primaryCategory | |
| reportUrl | |
| ratingLastChanged | |
| organizationLastChanged | |
| accreditationStatusLastChanged | |
| organizationType | |
| contactFirstName | |
| contactLastName | |
| contactMiddleName | |
| contactTitle | |
| contactPrefix | |
| phone | |
| address | |
| city | |
| stateProvince | |
| postalCode | |
| businessUrl | |
| collectionId | |
| isCharity | |
| entityId |