Skip to main content
Salfio Docs

Search documentation

Type to search this documentation.

On this pageOverview

List clients

Returns the authenticated organization's non-deleted clients, ordered by opaque internal ID for a stable cursor anchor. Use the `cursor` returned in `meta.cursor` (if `meta.hasMore` is true) to fetch the next page. Today's response includes `id`, `name`, `domain`, `createdAt`, `updatedAt`. Additional fields (`email`, `phone`, `company`, `notes`) listed in the v1.0 spec are not yet populated.

GET

/clients

bearerAuth``

AuthorizationBearer <token>

Salfio API tokens start with the literal prefix sk_live_ followed by 32 base62 characters (≈190 bits of entropy). Tokens are hashed at rest with argon2id and shown to the user only once at creation.

In: header

limit?integer

Page size (default 20, max 100).

Default20

Range1 <= value <= 100

cursor?string

Opaque cursor from a previous response's meta.cursor.

application/json

application/json

application/json

application/json

curl -X GET "https://api.salfio.com/v1/clients"

{
  "meta": {
    "cursor": "string",
    "hasMore": true
  },
  "data": [
    {
      "id": "8b2d1c4e-3f5a-4e2b-9c8f-1e2d3c4b5a6f",
      "name": "Acme Corp",
      "domain": "acme.com",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "accountManagers": [
        {
          "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
          "firstName": "string",
          "lastName": "string",
          "email": "[email protected]"
        }
      ],
      "clientType": "active"
    }
  ]
}

{
  "error": {
    "code": "invalid_argument",
    "message": "limit must be an integer between 1 and 100"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Authentication required"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded",
    "details": {
      "retry_after_seconds": 30
    }
  }
}
Export
Suggest an edit to this page

Documentation menu