Skip to main content
GET
/
api
/
Clients
/
Me
Get My Clients.
curl --request GET \
  --url https://api.example.com/api/Clients/Me
[
  {
    "id": 123,
    "legalName": "<string>",
    "statusName": "<string>",
    "siteID": 123,
    "siteName": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "address3": "<string>",
    "suburb": "<string>",
    "state": "<string>",
    "postcode": "<string>",
    "countryCode": "<string>",
    "countryName": "<string>",
    "parentCompany": 123,
    "parentCompanyName": "<string>",
    "statusID": 123,
    "phone": "<string>",
    "phone_Standardised": "<string>",
    "contacts": 123,
    "allJobs": 123,
    "openJobs": 123,
    "placements": 123,
    "contractors": 123,
    "sites": 123,
    "description": "<string>",
    "website": "<string>",
    "rating": 123,
    "createdByID": 123,
    "createdByName": "<string>",
    "updatedByID": 123,
    "updatedByName": "<string>",
    "primaryContact": 123,
    "primaryContactFirstName": "<string>",
    "primaryContactLastName": "<string>",
    "primaryContactName": "<string>",
    "primaryContactPhone": "<string>",
    "primaryContactEmail": "<string>",
    "primaryContactOptOut": true,
    "defaultBillingContactID": 123,
    "defaultBillingContactName": "<string>",
    "defaultTimesheetApproverID": 123,
    "defaultTimesheetApproverName": "<string>",
    "defaultBillingGroupID": 123,
    "defaultBillingGroupName": "<string>",
    "abn": "<string>",
    "acn": "<string>",
    "companyNumber": "<string>",
    "vatNumber": "<string>",
    "tradingName": "<string>",
    "divisions": "<string>",
    "cvDeadlinePerm": 123,
    "cvDeadlineContract": 123,
    "cvDeadlineFixedContract": 123,
    "photoName": "<string>",
    "photoUrl": "<string>",
    "defaultNoticePeriod": 123,
    "defaultNoticePeriodUnits": 123,
    "createdDate": "2023-11-07T05:31:56Z",
    "updatedDate": "2023-11-07T05:31:56Z",
    "lastActivityDate": "2023-11-07T05:31:56Z",
    "nextActivityDate": "2023-11-07T05:31:56Z",
    "lastContactDate": "2023-11-07T05:31:56Z",
    "nextContactDate": "2023-11-07T05:31:56Z",
    "lastMeetingDate": "2023-11-07T05:31:56Z",
    "nextMeetingDate": "2023-11-07T05:31:56Z",
    "lastJobDate": "2023-11-07T05:31:56Z",
    "lastPlacementDate": "2023-11-07T05:31:56Z",
    "linkedinURL": "<string>",
    "deleted": true,
    "ownerIds": [
      123
    ],
    "customField1": "<string>",
    "customField2": "<string>",
    "customField3": "<string>",
    "customField4": "<string>",
    "customField5": "<string>",
    "customField6": "<string>",
    "customField7": "<string>",
    "customField8": "<string>",
    "customField9": "<string>",
    "customField10": "<string>",
    "customField11": 123,
    "customField12": 123,
    "customField13": 123,
    "customField14": 123,
    "customField15": 123,
    "customField16": "2023-11-07T05:31:56Z",
    "customField17": "2023-11-07T05:31:56Z",
    "customField18": "2023-11-07T05:31:56Z",
    "customField19": "2023-11-07T05:31:56Z",
    "customField20": "2023-11-07T05:31:56Z",
    "customField21": "<string>",
    "customField22": "<string>",
    "customField23": "<string>",
    "customField24": "<string>",
    "customField25": "<string>",
    "customField26": "<string>",
    "customField27": "<string>",
    "customField28": "<string>",
    "customField29": "<string>",
    "customField30": "<string>",
    "customField31": "<string>",
    "customField32": "<string>",
    "customField33": "<string>",
    "customField34": "<string>",
    "customField35": "<string>",
    "customField36": "<string>",
    "customField37": "<string>",
    "customField38": "<string>",
    "customField39": "<string>",
    "customField40": "<string>",
    "customField41": 123,
    "customField42": 123,
    "customField43": 123,
    "customField44": 123,
    "customField45": 123,
    "customField46": 123,
    "customField47": 123,
    "customField48": 123,
    "customField49": 123,
    "customField50": 123,
    "customField51": "2023-11-07T05:31:56Z",
    "customField52": "2023-11-07T05:31:56Z",
    "customField53": "2023-11-07T05:31:56Z",
    "customField54": "2023-11-07T05:31:56Z",
    "customField55": "2023-11-07T05:31:56Z",
    "customField56": "2023-11-07T05:31:56Z",
    "customField57": "2023-11-07T05:31:56Z",
    "customField58": "2023-11-07T05:31:56Z",
    "customField59": "2023-11-07T05:31:56Z",
    "customField60": "2023-11-07T05:31:56Z",
    "tags": true,
    "creditLimit": 123,
    "creditRating": "<string>",
    "creditBalance": 123,
    "statisticsCounts": [
      {
        "type": "<string>",
        "value": 123
      }
    ],
    "statisticsDates": [
      {
        "type": "<string>",
        "value": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

Response

200 - application/json

OK

id
integer<int32>
statusName
string | null
siteID
integer<int32>
siteName
string | null
address1
string | null
address2
string | null
address3
string | null
suburb
string | null
state
string | null
postcode
string | null
countryCode
string | null
countryName
string | null
parentCompany
integer<int32>
parentCompanyName
string | null
statusID
integer<int32>
phone
string | null
phone_Standardised
string | null
contacts
integer<int32>
allJobs
integer<int32>
openJobs
integer<int32>
placements
integer<int32>
contractors
integer<int32>
sites
integer<int32>
description
string | null
website
string | null
rating
integer<int32>
createdByID
integer<int32>
createdByName
string | null
updatedByID
integer<int32>
updatedByName
string | null
primaryContact
integer<int32>
primaryContactFirstName
string | null
primaryContactLastName
string | null
primaryContactName
string | null
primaryContactPhone
string | null
primaryContactEmail
string | null
primaryContactOptOut
boolean
defaultBillingContactID
integer<int32>
defaultBillingContactName
string | null
defaultTimesheetApproverID
integer<int32>
defaultTimesheetApproverName
string | null
defaultBillingGroupID
integer<int32> | null
defaultBillingGroupName
string | null
abn
string | null
acn
string | null
companyNumber
string | null
vatNumber
string | null
tradingName
string | null
divisions
string | null
cvDeadlinePerm
integer<int32>
cvDeadlineContract
integer<int32>
cvDeadlineFixedContract
integer<int32>
photoName
string | null
photoUrl
string | null
defaultNoticePeriod
integer<int32>
defaultNoticePeriodUnits
integer<int32>
createdDate
string<date-time>
updatedDate
string<date-time>
lastActivityDate
string<date-time>
nextActivityDate
string<date-time>
lastContactDate
string<date-time>
nextContactDate
string<date-time>
lastMeetingDate
string<date-time>

Date of the last meeting with the client

nextMeetingDate
string<date-time>

Date of the next scheduled meeting with the client

lastJobDate
string<date-time>
lastPlacementDate
string<date-time>
linkedinURL
string | null
deleted
boolean
ownerIds
integer<int32>[] | null
customField1
string | null
customField2
string | null
customField3
string | null
customField4
string | null
customField5
string | null
customField6
string | null
customField7
string | null
customField8
string | null
customField9
string | null
customField10
string | null
customField11
number<double> | null
customField12
number<double> | null
customField13
number<double> | null
customField14
number<double> | null
customField15
number<double> | null
customField16
string<date-time>
customField17
string<date-time>
customField18
string<date-time>
customField19
string<date-time>
customField20
string<date-time>
customField21
string | null
customField22
string | null
customField23
string | null
customField24
string | null
customField25
string | null
customField26
string | null
customField27
string | null
customField28
string | null
customField29
string | null
customField30
string | null
customField31
string | null
customField32
string | null
customField33
string | null
customField34
string | null
customField35
string | null
customField36
string | null
customField37
string | null
customField38
string | null
customField39
string | null
customField40
string | null
customField41
number<double> | null
customField42
number<double> | null
customField43
number<double> | null
customField44
number<double> | null
customField45
number<double> | null
customField46
number<double> | null
customField47
number<double> | null
customField48
number<double> | null
customField49
number<double> | null
customField50
number<double> | null
customField51
string<date-time>
customField52
string<date-time>
customField53
string<date-time>
customField54
string<date-time>
customField55
string<date-time>
customField56
string<date-time>
customField57
string<date-time>
customField58
string<date-time>
customField59
string<date-time>
customField60
string<date-time>
tags
boolean

HasTags field

creditLimit
number<double>
creditRating
string | null
creditBalance
number<double>
statisticsCounts
object[] | null
statisticsDates
object[] | null