List accounts

Returns a paginated list of accounts. Supports filtering by status, industry, size, and tag.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token: Authorization: Bearer sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

X-API-Key<token>

API key via header: X-API-Key: sk_live_.... Use sk_live_ prefixed keys for production data and sk_test_ prefixed keys for sandbox/test data.

In: header

Query Parameters

pageinteger

Page number

Default: 1

limitinteger

Items per page (max 100)

Default: 20Maximum: 100

searchstring

Search term

statusstring

Value in: "active" | "inactive" | "prospect" | "customer" | "churned"

industrystring

sizestring

Value in: "small" | "medium" | "large" | "enterprise"

tagstring

Filter by tag

curl -X GET "https://clientsphere.io/api/v1/accounts?page=1&limit=20&search=%3Cstring%3E&status=active&industry=%3Cstring%3E&size=small&tag=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Paginated list of accounts

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
      "name": "string",
      "website": "string",
      "industry": "string",
      "size": "small",
      "phone": "string",
      "address": "string",
      "extraInformation": "string",
      "status": "active",
      "assignedTo": 0,
      "ownerId": 0,
      "tags": [
        "string"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 20,
      "totalCount": 137,
      "totalPages": 7
    }
  }
}

List accounts

Authorization

Query Parameters

Response

TypeScript