Get Client detail information

2min
GET
This endpoind allows to retrieve all information about one specific client and query params are used to retreive the one specific client. 
AUTHENTICATION
Authorization
apiKey
QUERY PARAMETERS
guid
string
GUID format entity identifier generated by Frontu.
systemId
string
Entity identifier from external system.
title
string
Title.
email
string
Email address.
phone
string
Phone number.
companyCode
string
Company identifier.
companyVatCode
string
Company VAT code.
RESPONSES
200
Returned when successful
object
Returned when successful
version
integer
title
string
Client name
address
string
city
string
phone
string
email
string
creditStatus
object
Example: [object Object]
note
string
companyCode
string
companyVatCode
string
guid
string
Unique
created
string
updated
string
deleted
boolean
clientType
boolean
systemId
integer
Unique
customValues
object[]
Example: 
You will get custom values for example "guid": "version"
404
Entity not found
Curl
Python
PHP
Shell
C#
|
curl --location --request GET 'https://dev1.frontu.com/client/api/v2/clients/details' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --request GET 'https://dev1.frontu.com/client/api/v2/clients/details' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
RESPONSES
200
404
|
// Returned when successful 
{
  "version": 0,
  "title": "",
  "address": "",
  "city": "",
  "phone": "",
  "email": "",
  "creditStatus": {
    "title": "",
    "guid": "",
    "systemId": ""
  },
  "note": "",
  "companyCode": "",
  "companyVatCode": "",
  "guid": "",
  "created": "",
  "updated": "",
  "deleted": false,
  "clientType": false,
  "systemId": 0,
  "customValues": [
    {
      "guid": "",
      "value": ""
    }
  ]
}
// Returned when successful 
{
  "version": 0,
  "title": "",
  "address": "",
  "city": "",
  "phone": "",
  "email": "",
  "creditStatus": {
    "title": "",
    "guid": "",
    "systemId": ""
  },
  "note": "",
  "companyCode": "",
  "companyVatCode": "",
  "guid": "",
  "created": "",
  "updated": "",
  "deleted": false,
  "clientType": false,
  "systemId": 0,
  "customValues": [
    {
      "guid": "",
      "value": ""
    }
  ]
}
﻿
﻿
Updated 31 Jul 2023
Did this page help you?
Create / Update Client
Get workspaces list
Docs powered by
Archbee
Main

Get Client detail information
