- General
- Endpoints
Retrieve Single Relation
GET
/relation/{relation_id}
Request
Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************API Key
Add parameter in header
x-api-env
Example:
x-api-env: ********************or
Path Params
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.vplan.com/v1/relation/' \
--header 'x-api-key;' \
--header 'x-api-env;'Responses
🟢200Ok
application/json
Body
Example
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"type": "string",
"note": "string",
"phone": "string",
"fax": "string",
"email": "user@example.com",
"website": "http://example.com",
"external_ref": "fb1033a2ed70",
"created_at": "2024-04-11T10:22:15Z",
"updated_at": "2024-04-11T10:22:15Z"
}🟠404Not Found
🟠401Not Logged In
Modified at 2025-07-22 14:20:42