> ## Documentation Index > Fetch the complete documentation index at: https://help.gorelo.io/llms.txt > Use this file to discover all available pages before exploring further. # Lists clients > Lists clients for the service provider using cursor pagination. Results are sorted by client id ascending (oldest first). ## OpenAPI ````yaml /api-reference/openapi.json get /v1/clients openapi: 3.0.4 info: title: Public API description: Gorelo Public API documentation. version: 1.0.0 servers: - url: https://api.usw.gorelo.io description: US - url: https://api.aue.gorelo.io description: Australia security: - ApiKeyAuth: [] tags: - name: Attachments description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs." - name: Alerts description: Alerts management operations - name: Assets description: Assets management operations - name: Billing description: Billing management operations - name: Tickets description: Tickets management operations - name: Clients description: Clients management operations - name: Contacts description: Contacts management operations - name: Deletions description: Deletions management operations - name: Documents description: Documents management operations - name: Forms description: Forms management operations - name: Organization description: Organization management operations - name: Projects description: Projects management operations paths: /v1/clients: get: tags: - Clients summary: Lists clients description: >- Lists clients for the service provider using cursor pagination. Results are sorted by client id ascending (oldest first). operationId: get_v1_clients parameters: - name: Cursor in: query description: >- Opaque pagination cursor from a previous page; omit for the first page. schema: type: string - name: PageSize in: query description: >- Number of items per page, 1-200 (default 50). Out of range is rejected, not clamped. schema: type: integer format: int32 default: 50 - name: StatusIds in: query description: >- Comma-separated client status ids to include: 1 Active, 3 Credit hold, 4 Archived. Default excludes Archived; when supplied, only the listed statuses are returned. Any other value is a 400. Up to 100 values. Deleted clients are never listed. schema: type: string - name: Query in: query description: >- Keyword matched against the client name, alternate name, billing name and web domains. Up to 200 characters. schema: type: string - name: GroupIds in: query description: >- Comma-separated group ids (from GET /v1/organization/groups); keeps clients subscribed to any of them. Up to 100 values. schema: type: string - name: UpdatedSince in: query description: ISO-8601 timestamp; keeps only clients updated at or after it. schema: type: string format: date-time - name: UpdatedBefore in: query description: ISO-8601 timestamp; keeps only clients updated strictly before it. schema: type: string format: date-time - name: CreatedSince in: query description: ISO-8601 timestamp; keeps only clients created at or after it. schema: type: string format: date-time - name: CreatedBefore in: query description: ISO-8601 timestamp; keeps only clients created strictly before it. schema: type: string format: date-time responses: '200': description: OK content: text/plain: schema: $ref: '#/components/schemas/ClientListItemResponseListBaseResponse' application/json: schema: $ref: '#/components/schemas/ClientListItemResponseListBaseResponse' text/json: schema: $ref: '#/components/schemas/ClientListItemResponseListBaseResponse' '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/ObjectBaseResponse' application/json: schema: $ref: '#/components/schemas/ObjectBaseResponse' text/json: schema: $ref: '#/components/schemas/ObjectBaseResponse' '401': description: Unauthorized content: text/plain: schema: $ref: '#/components/schemas/ObjectBaseResponse' application/json: schema: $ref: '#/components/schemas/ObjectBaseResponse' text/json: schema: $ref: '#/components/schemas/ObjectBaseResponse' '500': description: Internal Server Error content: text/plain: schema: $ref: '#/components/schemas/ObjectBaseResponse' application/json: schema: $ref: '#/components/schemas/ObjectBaseResponse' text/json: schema: $ref: '#/components/schemas/ObjectBaseResponse' components: schemas: ClientListItemResponseListBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' IsSuccess: type: boolean Data: type: array items: $ref: '#/components/schemas/ClientListItemResponse' nullable: true DataContext: $ref: '#/components/schemas/PaginationDataContext' Notifications: type: array items: $ref: '#/components/schemas/Error' additionalProperties: false ObjectBaseResponse: type: object properties: StatusCode: $ref: '#/components/schemas/HttpStatusCode' IsSuccess: type: boolean Data: nullable: true DataContext: $ref: '#/components/schemas/ErrorDataContext' Notifications: type: array items: $ref: '#/components/schemas/Error' additionalProperties: false HttpStatusCode: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 ClientListItemResponse: type: object properties: Id: type: integer description: Client identifier. format: int64 Name: type: string description: Client display name. Status: $ref: '#/components/schemas/CodeModel' CreatedOn: type: string description: Creation timestamp (UTC). format: date-time nullable: true UpdatedOn: type: string description: Last-updated timestamp (UTC). format: date-time nullable: true BillingName: type: string description: Name used on invoices. AlternateName: type: string description: Alternate / trading name. IsDefault: type: boolean description: Whether this is the default client. nullable: true Domains: type: array items: $ref: '#/components/schemas/ClientWebDomainResponse' description: Web domains associated with the client. GroupIds: type: array items: type: integer format: int64 description: "Ids of the groups the client is subscribed to (Client > Quick Links > Groups in Gorelo web),\r\nascending. Names are on `GET /v1/organization/groups`. Empty when the client has none." additionalProperties: false description: >- A client (customer organization) as listed by `GET /v1/clients`. Timestamps are UTC. PaginationDataContext: type: object properties: Pagination: $ref: '#/components/schemas/PaginatedResponse' additionalProperties: false description: "The `DataContext` of a cursor-paginated success response: carries the paging metadata\r\nfor the returned page." Error: type: object properties: Code: pattern: ^[0-9]{6}$ type: string description: 6-digit MMTTNN error code. See the Public API error-code registry. example: '070101' Message: type: string PropertyName: type: string nullable: true ActionHint: type: string nullable: true DocUrl: type: string nullable: true additionalProperties: false ErrorDataContext: type: object properties: TraceId: type: string description: Request correlation id. Quote this when reporting a problem. nullable: true additionalProperties: false description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest." CodeModel: type: object properties: Id: type: integer description: >- Numeric identifier of the coded value (e.g. status, priority, type, or source id). format: int64 example: 1 Name: type: string description: Display name of the coded value. additionalProperties: false description: >- A coded value, such as a status, priority, type or source, as an id and a display name. ClientWebDomainResponse: type: object properties: Id: type: integer description: Web domain identifier. format: int64 Name: type: string description: Domain name (e.g. contoso.com). CreatedOn: type: string description: Creation timestamp (UTC). format: date-time nullable: true UpdatedOn: type: string description: Last-updated timestamp (UTC). format: date-time nullable: true ExpirationDate: type: string description: >- Domain registration expiration date, as a calendar date ("yyyy-MM-dd"). format: date nullable: true IsDateSetManually: type: boolean description: >- Whether the expiration date was set manually rather than resolved automatically. Status: $ref: '#/components/schemas/CodeModel' additionalProperties: false description: A web domain associated with a client. Timestamps are UTC. PaginatedResponse: type: object properties: NextCursor: type: string nullable: true PreviousCursor: type: string nullable: true HasMore: type: boolean HasPrevious: type: boolean TotalCount: type: integer format: int32 additionalProperties: false securitySchemes: ApiKeyAuth: type: apiKey description: >- Your Gorelo API key. See [Generate API key](/generate-api-key). If your data is hosted in Australia, click the base URL at the top of this page and select `https://api.aue.gorelo.io`. name: X-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.