Skip to main content
GET
/
companies
/
v2
/
rs
List companies of an organization
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/companies/v2/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "name": "Company Name",
      "comment": "Company comment",
      "location": "Company address",
      "type": 1,
      "archivedAt": "2024-12-10T10:00:00.000Z",
      "email": "[email protected]",
      "phones": [
        "phone1",
        "phone2"
      ],
      "primaryContactId": 1,
      "technicalInstallations": [
        {
          "id": 1,
          "name": "establishment_informations.installation_ascenseurs",
          "image": {
            "id": 1,
            "presignedUrl": "https://example.com/presigned-url"
          },
          "tradKey": "establishment_informations.installation_ascenseurs",
          "isDefault": false
        }
      ],
      "labels": [
        {
          "id": 1,
          "name": "Urgent",
          "color": "#FF5733"
        }
      ],
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true
      },
      "contacts": [
        {
          "id": 1,
          "name": "Company Contact Name",
          "email": "[email protected]",
          "phones": [
            "phone1",
            "phone2"
          ],
          "comment": "Company contact comment",
          "notifyAt": "2024-12-05T14:56:23.000Z"
        }
      ],
      "establishmentIds": [
        1
      ]
    }
  ],
  "totalCount": 100,
  "pagination": {
    "page": 1,
    "pageSize": 50
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Session-Token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

​
Content-Type
enum<string>
required

Content type, must be "application/json".

Available options:
application/json
​
x-sites
string

List of site IDs.

Example:

"['1', '2']"

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "technical-installations": Get information about technical installations linked to the report

  • "labels": Get the labels linked to the companies

  • "actions-info": Give information about actions that can be done on the Company

  • "contacts": Get the contacts linked to the companies

  • "establishmentIds": Get information about the establishment IDs linked to these companies.

Available options:
technical-installations,
labels,
actions-info,
contacts,
establishmentIds
​
whereName
string

Filter by name

Example:

"string"

​
whereComment
string

Filter by comment

Example:

"string"

​
whereLocation
string

Filter by location

Example:

"string"

​
whereType
integer[]

Filter by type

Example:
[1, 2, 3]
​
whereEmail
string

Filter by email

Example:

"string"

​
wherePhones
string

Filter by phone numbers

Example:

"string"

​
whereEstablishmentIds
integer[]

Filter by establishments

Example:
[1, 2, 3]
​
whereTechnicalInstallationIds
integer[]

Filter by technicalInstallations

Example:
[1, 2, 3]
​
whereLabelIds
string

Filter by labels

Example:

"string"

​
whereLabelName
string

Filter by label name

Example:

"string"

​
whereText
string

Filter by name or location

Example:

"string"

​
whereArchivedAt
string

Filter by archivedAt

Example:

"2021-01-01T00:00:00.000Z"

​
whereIsArchived
boolean

Filter by archived status

Example:

true

​
whereCreatedAt
string

Filter by createdAt

Example:

"2021-01-01T00:00:00.000Z"

​
orderBy
object[]
​
whereContactName
string

Filter by name

Example:

"string"

​
whereContactEmail
string

Filter by email

Example:

"string"

​
whereContactPhones
string

Filter by phone numbers

Example:

"string"

​
whereContactComment
string

Filter by comment

Example:

"string"

​
whereContactCreatedAt
string

Filter by createdAt

Example:

"2021-01-01T00:00:00.000Z"

​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

Example:

1

​
pageSize
integer
default:50

Page size.

Example:

50

​
findId
integer

Get the page where the item with this id is located.

Example:

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

Example:

10

Response

200 - application/json

List of companies

​
data
object[]
required
​
totalCount
integer

Total count of items.

Example:

100

​
pagination
object

Pagination information.