Equinix Fabric API v4 | Equinix Product Documentation

Search Company Profiles

Request

Search company profiles based on filter criteria ^Beta

Security

BearerAuth

Query

viewPointstring

Viewpoint for the request, either 'aSide' or 'zSide'

Default:"aSide"

Bodyapplication/jsonrequired

filterobject(CompanyProfileSearchFilters)

Filter criteria for company profile search. The and array combines conditions where all must match. Each item in and is either a simple expression (property/operator/values) or an or group. At most one or group is allowed per request.

Example:

{
  "and": [
    { … },
    { … }
  ]
}

paginationobject(Pagination)

Pagination response information

Example:

{
  "offset": 0,
  "limit": 20,
  "total": 0
}

sortobject(Sort)

Example:

{
  "property": "/changeLog/updatedDateTime",
  "direction": "DESC"
}

Payload

{
  "filter": {
    "and": [ … ]
  },
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 0
  },
  "sort": {
    "property": "/changeLog/updatedDateTime",
    "direction": "DESC"
  }
}

Responses

Successful operation

Bodyapplication/json

paginationobject(Pagination)required

Pagination response information

dataArray of objects(CompanyProfileResponse)required

Response

{
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 0,
    "next": "string",
    "previous": "string"
  },
  "data": [
    { … }
  ]
}