Skip to main content
GET
/
v1
/
clients
/
{clientId}
Get client
curl --request GET \
  --url https://app.blinksale.test/api/v1/clients/{clientId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Client retrieved successfully",
  "data": {
    "id": "01jtbf0c9zaraqx3swthf88n5y",
    "name": "Acme Inc",
    "email": "[email protected]",
    "kind": "BUSINESS",
    "kind_name": "Business",
    "profile": {
      "company_name": "Acme Inc",
      "website": "https://acme.com"
    },
    "address": {
      "line1": "123 Main St",
      "line2": "Suite 101",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94107",
      "country": "US"
    },
    "document_defaults": {
      "currency": "USD"
    },
    "contact_count": 3,
    "note_count": 2,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Access token obtained from the /v1/auth/login endpoint

Path Parameters

​
clientId
string<uuid>
required

The ID of the client to retrieve

Response

Client retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Client retrieved successfully"

​
data
object