Skip to main content
GET
/
companies
/
v2
/
rs
/
{companyId}
/
contacts
/
{contactId}
Get contact of an company
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/companies/v2/rs/{companyId}/contacts/{contactId} \
  --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
    },
    "updatableFields": {
      "name": true,
      "email": true,
      "phones": true,
      "comment": true
    }
  }
}

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

​
contactId
integer
required

Unique identifier of the company contact.

Example:

1

​
companyId
integer
required

Identifier of the associated company.

Example:

1

Query Parameters

​
extend
enum<string>[]

Extend options:

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

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

  • "updatable-fields": Get information about the field that can be updated

Available options:
company,
actions-info,
updatable-fields

Response

200 - application/json

Get of contact

​
data
object
required