Companies / Index

Name	Companies / Index
Description	List Companies that belong to your Brokerage
Type	GET
URL	/v9/companies
Credential Type	API
Supports Pagination	Yes

Long Description

List Companies that belong to your Brokerage.

Parameters

Name	Description	Type	Presence	Location	Conditionals
`name`	Exact match of Company name	String	Optional	Query	No

Examples

Request

Response

GET /v9/companies

{
  "total_entries": 2,
  "current_page": 1,
  "companies": [
    {
      "name": "New Jersey Devils",
      "updated_at": "2012-07-12T15:25:51Z",
      "url": "/companies/1",
      "id": "1"
    },
      "name": "Moe’s Tavern",
      "updated_at": "2014-08-08T21:50:26Z",
      "url": "/companies/8052",
      "id": "8052"
    }
  ],
  "per_page": 100
}