> ## Documentation Index > Fetch the complete documentation index at: https://redbark.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # List clients > The firm’s clients, most recent activity first: name, kind, status, people, checklist progress and when something last happened. Archived clients are left out. ## OpenAPI ````yaml /openapi/advisor.json get /clients openapi: 3.1.0 info: title: Redbark Advisor API version: 2.0.0 description: >- Read and write access to one advice firm in Redbark Advisor: clients, checklists, documents, money, messages, reports, team and webhooks. Send an API key or a connected app’s access token as a bearer token. A credential carries scopes, one read and one write per area, and each call says the scope it needs. A write scope brings its read scope. Each key may make 120 requests a minute. servers: - url: https://advisor.redbark.com/api/v1 security: - bearerAuth: [] tags: - name: Firm description: The firm, its name and its branding. - name: Team description: Team members and their roles. - name: Clients description: Clients, their people and portal invites. - name: Checklists description: Checklist templates, the checklists sent to clients and their answers. - name: Documents description: Documents clients upload and the details read from them. - name: Money description: Bank connections, accounts, balances and transactions. - name: Document types description: Document types, their fields and the client facts they fill. - name: Messages description: Messages between the firm and clients. - name: Reports description: Reports exported for clients. - name: Webhooks description: Webhook endpoints and their deliveries. - name: Webhook events description: Events sent to your webhook endpoints. paths: /clients: get: tags: - Clients summary: List clients description: >- The firm’s clients, most recent activity first: name, kind, status, people, checklist progress and when something last happened. Archived clients are left out. operationId: list_clients parameters: - name: limit in: query required: false schema: anyOf: - type: integer minimum: 1 maximum: 100 description: 1 to 100. Default 25. - type: 'null' - name: cursor in: query required: false schema: anyOf: - type: string maxLength: 400 description: The next_cursor of the previous page. - type: 'null' responses: '200': description: Success. content: application/json: schema: $ref: '#/components/schemas/ClientList' '400': description: The request is not valid. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: The API key or access token is missing, wrong, expired or revoked. content: application/json: schema: $ref: '#/components/schemas/Error' '402': description: >- subscription_required: the firm has no active subscription, so it cannot add or invite clients or send checklists. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- The credential lacks the scope this call needs, the call is for admins only, or the member it acts as has left the firm. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: No such resource in this firm. content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: >- The resource is in a state that does not allow this, such as an archived client, or client_limit_reached: the plan’s 20 active clients are in use. content: application/json: schema: $ref: '#/components/schemas/Error' '413': description: The request body is too large. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests. See the Retry-After header. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Something went wrong on our side. Try again. content: application/json: schema: $ref: '#/components/schemas/Error' security: - bearerAuth: - clients:read components: schemas: ClientList: type: object properties: object: type: string enum: - list data: type: array items: $ref: '#/components/schemas/ClientSummary' has_more: type: boolean next_cursor: anyOf: - type: string - type: 'null' next_page_url: anyOf: - type: string - type: 'null' required: - object - data - has_more - next_cursor - next_page_url additionalProperties: true Error: type: object properties: error: type: object properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - rate_limit_error - api_error code: type: string message: type: string param: anyOf: - type: string - type: 'null' request_id: type: string required: - type - code - message - param - request_id additionalProperties: true required: - error additionalProperties: true ClientSummary: type: object properties: object: type: string enum: - client id: type: string name: type: string kind: type: string enum: - individual - couple - company - trust - smsf status: type: string enum: - not_invited - invited - active - archived list_status: type: string enum: - needs_you - waiting - invited - not_invited - up_to_date description: >- Where the client stands: needs_you (something submitted to review), waiting (on the client), invited, not_invited or up_to_date. advisor_name: anyOf: - type: string - type: 'null' people: type: array items: type: object properties: id: type: string name: type: string email: anyOf: - type: string - type: 'null' required: - id - name - email additionalProperties: true checklist: type: object properties: done: type: number total: type: number submitted: type: number required: - done - total - submitted additionalProperties: true last_activity_at: type: string description: An ISO 8601 time in UTC. required: - object - id - name - kind - status - list_status - advisor_name - people - checklist - last_activity_at additionalProperties: true securitySchemes: bearerAuth: type: http scheme: bearer description: >- A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.