Skip to main content
GET
/
companies
/
v2
/
rs
/
{companyId}
/
contacts
List contacts of an company
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/companies/v2/rs/{companyId}/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'X-Session-Token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "name": "Company Contact Name",
      "email": "[email protected]",
      "phones": [
        "phone1",
        "phone2"
      ],
      "comment": "Company contact comment",
      "companyId": 1,
      "notifyAt": "2024-12-05T14:56:23.000Z",
      "updatedAt": "2024-12-05T14:56:23.000Z",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "company": {
        "id": 1,
        "name": "Company Name",
        "type": 1,
        "location": "Company address",
        "archivedAt": "2024-12-10T10:00:00.000Z",
        "createdAt": "2024-01-15T08:45:00.000Z"
      },
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true
      }
    }
  ],
  "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

Path Parameters

​
companyId
integer
required

Identifier of the associated company.

Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

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

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

Available options:
company,
actions-info
​
whereName
string

Filter by name

Example:

"string"

​
whereEmail
string

Filter by email

Example:

"string"

​
wherePhones
string

Filter by phone numbers

Example:

"string"

​
whereComment
string

Filter by comment

Example:

"string"

​
whereText
string

Filter by name or location

Example:

"string"

​
whereCreatedAt
string

Filter by createdAt

Example:

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

​
orderBy
object[]
​
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 contacts

​
data
object[]
required
​
totalCount
integer

Total count of items.

Example:

100

​
pagination
object

Pagination information.