v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Companies

Get companies

Retrieve a list of companies based on provided filters

Required scopes: flex.community.companies.read

get/api/v2/organizations/{orgSlug}/companies

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring

The exact id of the company you are looking for.

namestring

The exact name of the company you are looking for.

locationstring

Filter by location id.

The status of the company.

Filter by the status of the company. Accepts either a single status value or an array operator filter for multiple values. Available status values: active, former, pending, inactive, not_approved, drop-in, lead

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

propertiesstring

Example:properties[customProperty1]=value1

Filter by custom properties. Uses deepObject style in query. Only string values are supported.

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

$sortstring

Example:propertyName:asc

Sort expression in the format <field>:<order>, where order is asc or desc

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "properties": {
        "customProperty1": "value1",
        "customProperty2": "value2"
      },
      "_id": "603dfbc260f4054084125d33",
      "startDate": "2025-02-25T00:00:00.000Z",
      "location": "603dfbc260f4054084125d33",
      "name": "My Company",
      "description": "This is the description of the company.",
      "email": "example@gmail.com",
      "image": "image-url.com",
      "url": "company-url.com",
      "address": {
        "country": "United States",
        "state": "California",
        "city": "San Francisco",
        "street": "123 Main St",
        "zip": "94105"
      },
      "billingDetails": {
        "billingName": "OfficeRnD",
        "date": 15,
        "vatNumber": "1234",
        "registrationNumber": "4321",
        "paymentMethod": "Cash",
        "taxRate": "6780f1ba1e2f3a4b5c6d7e8f",
        "shouldSendOverdueReminders": true,
        "billingAddress": {
          "country": "United States",
          "state": "California",
          "city": "San Francisco",
          "street": "123 Main St",
          "zip": "94105"
        }
      },
      "portalPrivacy": {
        "isVisible": true,
        "showContactDetails": true,
        "showSocialProfiles": true
      },
      "hasActiveMembersAllowance": true,
      "activeMembersAllowanceLimit": 10,
      "tags": [
        "tag1",
        "tag2",
        "tag3"
      ],
      "createdAt": "2025-02-25T00:00:00.000Z",
      "createdBy": "603dfbc260f4054084125d33",
      "modifiedAt": "2025-02-25T00:00:00.000Z",
      "modifiedBy": "603dfbc260f4054084125d33"
    }
  ]
}