Relationships
Get a list of customer relationships
HTTP Request
[GET] /api/v6/accounts/relations
Query Parameters
Fields
| Fields | Type | Description |
|---|---|---|
| id | integer | Identifier |
| relation_name | string | Relationship name |
| relation_code | string | Relationship code |
| relation_order | string | Sort order |
| origin_name | string | Original name |
| color_bg | numeric | Background color |
| color_fill | string | Fill color |
| deleted_by | string | Deleter |
| created_at | string | Creation date |
| color_text | string | Text color |
| is_default | bool | Default relationship |
| created_by | integer | Creator |
| updated_by | integer | Editor |
| updated_at | timestamp | Edit date |
| deleted_at | timestamp | Deletion date |
| invalid | bool | Valid or not |
| description | string | Description |
| relation_step | string | Relationship step |
Filtering
| Fields | Support | Type | Description |
|---|---|---|---|
| id | eq,in | integer | Customer identifier |
| valid | is,in | integer | Valid or not |
Sort
| Sort (field) | Direction |
|---|---|
| id | asc,desc |
Limit & Offset
| Type | Description | |
|---|---|---|
| Limit | integer | Number of records to retrieve |
| Offset | integer | Number of records to skip |
Example
HTTP Request
GET api/v6/accounts/"https://v6/accounts/relations" HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json
Status
200 OK
Response
[
{
"relation_id": 1,
"relation_name": "New",
"relation_code": "new",
"deleted_by": null,
"created_at": "2019-07-30 14:04:35",
"created_by": 0,
"updated_by": 1,
"updated_at": "2021-01-20 16:59:36",
"deleted_at": null,
"description": "NVIDIA talks about computing projects in the era of AI"
}
]