Skip to main content
GET
/
v1
/
clients
List clients
curl --request GET \
  --url https://app.blinksale.test/api/v1/clients \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "Resources 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"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 15,
    "to": 15,
    "total": 75
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

per_page
integer
default:15

Number of records per page

Search term to filter clients by name or email

Response

Clients retrieved successfully

success
boolean
required
Example:

true

message
string
required
Example:

"Resources retrieved successfully"

data
object[]
required
meta
object