logo
CompaniesList companies

List companies

curl -X GET "/api/v1/companies?page=25&per_page=25&query=example_string&q=example_string&sort=name&order=asc" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (API key (ixk_...))"
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "John Doe",
      "domains": [
        "example_string"
      ],
      "contact_count": 10,
      "created_at": "2024-12-25T10:00:00Z"
    }
  ],
  "meta": {
    "page": 25,
    "per_page": 25,
    "total": 42
  }
}
GET
/companies
GET
Bearer Token (API key (ixk_...))
Bearer Tokenstring
Required

API key from Settings → API. Pass as Authorization: Bearer <key>

API key from Settings → API. Pass as Authorization: Bearer <key>
query
querystring

Filter by name (ilike)

query
sortstring
Options: name, created_at, contact_count
query
orderstring
Options: asc, desc
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (API key (ixk_...)). API key from Settings → API. Pass as Authorization: Bearer <key>

Query Parameters

querystring

Filter by name (ilike)

sortstring
Allowed values:namecreated_atcontact_count
orderstring
Allowed values:ascdesc

Responses

dataarray
metaobject