Skip to content
OpenGTM

List Companies

GET
/api/entities/company
curl --request GET \
  --url 'http://localhost:8000/api/entities/company?min_corroboration=1&limit=100' \
  --header 'Authorization: Bearer <token>'

List canonical companies in the authenticated workspace.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
min_corroboration
Min Corroboration
integer
default: 1 >= 1
limit
Limit
integer
default: 100 <= 1000

Header Parameters

Section titled “Header Parameters”
x-workspace-id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}