Get companies

get

https://app.officernd.com/api/v2/organizations/{orgSlug}/companies

Retrieve a list of companies based on provided filters

Required scopes: flex.community.companies.read

Path Params

orgSlug

string

required

organization slug

Query Params

_id

string

The exact id of the company you are looking for.

name

string

The exact name of the company you are looking for.

location

string

Filter by location id.

status

string

enum

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

Allowed:

createdAt

string

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

modifiedAt

string

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

properties

string

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

$select

string

Select fields to return

$cursorNext

string

$cursorPrev

string

$limit

number

$sort

string

^[^:]+:(asc|desc)$

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

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200