Methods

  • get - Search for a company

Resource

{
    "items": [
        {
            "company_name": "string",
            "company_number": "string",
            "company_status": "string",
            "company_type": "string",
            "kind": "string",
            "links": {
                "company_profile": "string"
            },
            "ordered_alpha_key_with_id": "string"
        }
    ],
    "kind": "string",
    "top_hit": {
        "company_name": "string",
        "company_number": "string",
        "company_status": "string",
        "company_type": "string",
        "kind": "string",
        "links": {
            "company_profile": "string"
        },
        "ordered_alpha_key_with_id": "string"
    }
}

Properties

Name Type Description Additional
items[] array Optional
items[].company_name string

The company name associated with the company

items[].company_number string

The company number of the company

items[].company_status string

The status of the company

items[].company_type string

The type of company associated with the company

items[].kind string

The type of search result

Possible values are:

  • search-results#alphabetical-search
Optional
items[].links object

The link to the company

items[].links.company_profile string

The link to the company

Optional
items[].ordered_alpha_key_with_id string

The alphakey with it's id associated with the company

Optional
kind string

Possible values are:

  • search#alphabetical-search
  • search#enhanced-search
Optional
top_hit object Optional
top_hit.company_name string

The company name associated with the company

top_hit.company_number string

The company number of the company

top_hit.company_status string

The status of the company

top_hit.company_type string

The type of company associated with the company

top_hit.kind string

The type of search result

Possible values are:

  • search-results#alphabetical-search
Optional
top_hit.links object

The link to the company

top_hit.links.company_profile string

The link to the company

Optional
top_hit.ordered_alpha_key_with_id string

The alphakey with it's id associated with the company

Optional