Reference information

GET 
/parent-companies/:parentCompanyID/references/:id

Reference information

Request

Path Parameters

id uuidrequired

Responses

200

success - a reference information

application/json

Schema

Schema

id uuidrequired

The references ID.

companyId uuidrequired

The company in which the reference is part of.

created stringnullablerequired

The date of creation of the reference.

tag stringnullable

The tag of the reference.

entities

object[]

required

Array [

id uuidnullable

The ID of the aggregation entity.

type stringnullable

Possible values: [customer, prospect, relation]

The type of the aggregation entity.

]

access

object[]

required

Array [

managerId uuidrequired

The ID of the manager who has access to the reference.

primary boolean

Whether the manager is the primary contact for the reference.

]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "companyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created": "2024-01-01T00:00:00.000Z",
  "tag": "VIP",
  "entities": [
    {
      "id": "e1f2d3c4-b5a6-7b8c-9d0e-f1a2b3c4d5e6",
      "type": "customer"
    }
  ],
  "access": [
    {
      "managerId": "e1f2d3c4-b5a6-7b8c-9d0e-f1a2b3c4d5e6",
      "primary": true
    }
  ]
}

Loading...