> ## 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 the service provider's API keys using cursor pagination, newest first.

> Requires the `Organization:read` scope; keys issued with the older
`ServiceProvider:read` keep working.
            
Every key is listed, revoked ones included, so the list is the record of what has been
issued: a revoked key carries the time it was revoked in `RevokedAt`. A key created by
another key through `POST /v1/api-keys` names that key in `ParentApiKeyId`. The key
value itself is never returned - it is shown once, when the key is created.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/api-keys
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/api-keys:
    get:
      tags:
        - Organization
      summary: >-
        Lists the service provider's API keys using cursor pagination, newest
        first.
      description: "Requires the `Organization:read` scope; keys issued with the older\r\n`ServiceProvider:read` keep working.\r\n            \r\nEvery key is listed, revoked ones included, so the list is the record of what has been\r\nissued: a revoked key carries the time it was revoked in `RevokedAt`. A key created by\r\nanother key through `POST /v1/api-keys` names that key in `ParentApiKeyId`. The key\r\nvalue itself is never returned - it is shown once, when the key is created."
      operationId: get_v1_api-keys
      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, from 1 to 200 (default 50). A value
            outside that range is rejected.
          schema:
            type: integer
            format: int32
            default: 50
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ApiKeyModelListBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyModelListBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ApiKeyModelListBaseResponse'
        '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:
    ApiKeyModelListBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          type: array
          items:
            $ref: '#/components/schemas/ApiKeyModel'
          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
    ApiKeyModel:
      type: object
      properties:
        Id:
          type: string
          description: API key identifier.
          format: uuid
        Name:
          type: string
          description: The name the key is identified by.
        Description:
          type: string
          description: What the key is for.
          nullable: true
        Scopes:
          type: array
          items:
            type: string
          description: "The scopes the key carries, as granted. Keys issued before per-verb scopes may carry a bare\r\nmodule name, such as `Tickets`, which grants every verb on that module."
        CreatedAt:
          type: string
          description: When the key was created (UTC).
          format: date-time
        LastUsedAt:
          type: string
          description: >-
            When the key was last used to make a call (UTC), or null if it never
            has been.
          format: date-time
          nullable: true
        RevokedAt:
          type: string
          description: >-
            When the key was revoked (UTC), or null while it is still active. A
            revoked key is rejected on every call.
          format: date-time
          nullable: true
        ParentApiKeyId:
          type: string
          description: "The key that created this one through `POST /v1/api-keys`, or null for a key created\r\nin Gorelo or by a signed-in user. The parent may since have been revoked; that does not\r\nrevoke this key."
          format: uuid
          nullable: true
      additionalProperties: false
      description: "An API key belonging to the service provider. The key value itself is never returned - it is\r\nshown once, when the key is created. 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."
    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.