Skip to main content
GET
List companies

Authorizations

x-metal-client-id
string
header
default:<client-id>
required

The Client ID of your API key.

x-metal-api-key
string
header
default:<api-key>
required

The secret value of your API key.

Query Parameters

page
integer
default:1

Page number, starting at 1 (max 100).

Required range: 1 <= x <= 100
limit
integer
default:100

Items per page (1 to 1000).

Required range: 1 <= x <= 1000
lt
string

Cursor: return items whose id is less than this value (use the last id from the previous page).

sort
string

Field to sort by. Defaults to id.

direction
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Response

A list of companies.

data
object[]