HT Partner API

Retrieve client

Staging

https://apis.hellotech.com

GET

/api/partners/clients/{id}

Clients

Request

Authorization

Add parameter in header

Api-Key

Example:

Api-Key: ********************

Path Params

string

required

Client ID

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Client object

application/json

Body

integer

optional

The unique identifier of the client.

external_id

string

optional

The external unique identifier of the client.

first_name

string

optional

The first name of the client.

last_name

string

optional

The last name of the client.

string <email>

optional

The email address of the client.

phone

string

optional

The phone number of the client.

full_address

string

optional

The full address of the client.

address

object

optional

city

string

optional

The city of the client's address.

state

string

optional

The state of the client's address.

zip

string

optional

The zip code of the client's address.

street

string

optional

The street address of the client.

authentication_token

string

required

Example

{
    "id": 0,
    "external_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "phone": "string",
    "full_address": "string",
    "address": {
        "city": "string",
        "state": "string",
        "zip": "string",
        "street": "string"
    },
    "authentication_token": "string"
}

🟠400Error response

🟠404Error response

Modified at 2024-09-27 13:12:28

Create client

Update client