Skip to main content
GET
/
clients
List clients
curl --request GET \
  --url https://api-sandbox.ledgersyncappv2.com/v3/clients \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "cli_01HXYZ8A6N7K2W9PQ4T5Z3V6E0",
      "created_at": "2023-11-07T05:31:56Z",
      "external_id": "<string>",
      "email": "jsmith@example.com",
      "name": "<string>",
      "metadata": {},
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Pass your secret key in the Authorization header as a Bearer token: Authorization: Bearer sk_test_... (sandbox) or Bearer sk_live_... (production).

Keys are created in the developer portal and the plaintext secret is shown exactly once at creation. Treat them like passwords — never embed them in mobile apps or front-end code.

Query Parameters

​
cursor
string

Opaque cursor returned by a previous list response.

​
limit
integer
default:25

Max items per page (1–100).

Required range: 1 <= x <= 100
​
email
string<email>

Look up a Client by exact email match. Useful when you only know the user by their email.

Response

OK

​
data
object[]
required