Office Response

Complete Response

When an office is returned, a corpo record is credited against your credit balance.

📘

All counts provided in the counts node are an approximation of the number of records.

{
    "query": {
        "reveal_all_data": "boolean",
        "page_size": "integer",
        "page_number": "integer",
        "parameters": {
        }   
    },
    "counts": {
        "companies_total_results": "integer",
        "companies_total_returned": "integer",
        "offices_total_results": "integer",
        "offices_total_returned": "integer",
        "technologies_total_results": "integer",
        "technologies_total_returned": "integer",
        "profiles_total_results": "integer",
        "profiles_total_returned": "integer"
    },
    "results": [
        {
        "position": "integer",
        "office_data": {
            "office_last_modified_date": "string (YYYY-MM-DD HH:MM:SS)",
            "company_id": "string",
            "company_name": "string",
            "company_domain": "string",
            "company_description": "string",
            "company_logo_url": "string",
            "office_id": "string",
            "office_name": "string",
            "office_domain": "string",
            "office_type": "string",
            "office_number_of_detected_technologies": "integer",
            "office_number_of_profiles": "integer",
            "office_alternative_names": {
               "trade_names":["string"],
               "alias_names": ["string"],
               "previous_names": ["string"]
            },
            "office_phones": [
               {
               "phone": "string",
               "ddi": "boolean",
               "dnc": "boolean",
               "type": "string",
               "carrier": "string",
               "priority": "integer"
               }
            ],
            "office_fax": {
               "fax": "string",
               "type": "string",
               "carrier":"string"
            },
            "office_emails": [
               {
               "email": "string",
               "priority": "integer"
               }
            ],
            "office_web_address": {
               "url": "string",
               "rank": "integer"
            },
            "office_web_address_aliases": ["string"],
            "office_domain_aliases": ["string"],
            "office_social_links": {
               "linkedin": {
                  "url": "string"
               },
               "twitter": {
                     "url": "string"
               },
               "facebook": {
                     "url": "string"
               },
               "instagram": {
                     "url": "string"
               },
               "youtube": {
                     "url": "string"
               },
               "yelp": {
                     "url": "string"
               },
               "crunchbase": {
                     "url": "string"
               }
            },
            "office_tags": ["string"],
            "office_national_registration": {
               "name": "string",
               "number": "string"
            },
            "office_profile": {
               "date_founded": "string (YYYY-MM-DD)",
               "date_closed": "string (YYYY-MM-DD)",
               "marketable": "boolean"
            },
            "office_status": {
               "status": "string"
            },
            "office_employees": {
               "number_of_employees": "integer",
               "number_of_employees_code": "string"
            },
            "office_financials": [
               {
               "yearly_revenue": {
                     "revenue": "float",
                     "code": "string",
                     "currency": "string",
                     "year": "integer",
                     "reported_date": "string (YYYY-MM-DD)",
                     "type": "string"
                     },
               "yearly_growth": {
                  "percentage": "float",
                  "code": "string",
                  "type": "string",
                  "year": "integer"
               },
               "priority": "integer"
               }
           ],
           "office_revenue_in_usd": "float",
           "office_revenue_in_usd_code": "string",
           "office_industries": [
               {
               "id": "string",
               "code2": "string",
               "name2": "string",
               "code3": "integer",
               "name3": "string",
               "code4": "string",
               "name4": "string",
               "code5": "string",
               "name5": "string",
               "code6": "string",
               "name6": "string",
               "standard": "string",
               "activity_priority": "integer",
               "priority": "integer"
               }
         ],
            "office_primary_address": {
               "last_modified_date": "string (YYYY-MM-DD HH:MM:SS)",
               "formatted_address": "string",
               "street_address": "string",
               "place_id": "string",
               "lat": "float",
               "lng": "float",
               "accuracy": "string",
               "confidence_score": "float",
               "quality": "string",
               "administrative_area_level_1": "string",
               "administrative_area_level_2": "string",
               "administrative_area_level_3": "string",
               "administrative_area_level_4": "string",
               "administrative_area_level_5": "string",
               "continent": "string",
               "country": "string",
               "country_code": "string",
               "establishment": "string",
               "locality": "string",
               "postal_code": "string",
               "postal_town": "string",
               "premise":"string",    
               "county": "string",
               "state": "string",
               "city": "string",
               "street": "string",
               "street_number": "string",
               "sublocality": "string",
               "subpremise": "string",
               "score": "float"
            }
        },
        "office_metrics": {
            "marketability_score": "float",
            "completion_score": "float"
        }
        }
    ],
    "pagination": {
      "current": "integer",
      "next_page": "integer",
      "last_page": "integer"
   },
    "transaction_detail": {
        "id": "string",
        "account_number": "string",
        "account_type": "string",
        "product_name": "string",
        "endpoint": "string",
        "corpo_record_credits_used": "integer",
        "corpo_record_credits_available": "integer",
        "execute_at": "string (YYYY-MM-DD HH:MM:SS)",
        "total_time_taken": "float"
    }
}

What’s Next