Skip to main content

PaginatedResponse_ApiKeyDto

Generic paginated response wrapper with HATEOAS links

data object[]required

The data items for this page

  • Array [
  • createdAtstring<date-time>required

    When the key was created

    Example: 2024-01-01T00:00:00Z
    expiresAtstring,null<date-time>nullable

    When the key expires (if set)

    Example: 2025-12-31T23:59:59Z
    idstring<uuid>required

    Unique API key identifier

    Example: 550e8400-e29b-41d4-a716-446655440000
    isActivebooleanrequired

    Whether the key is currently active

    Example: true
    keyPrefixstringrequired

    Prefix of the key for identification

    Example: cdx_a1b2c3
    lastUsedAtstring,null<date-time>nullable

    When the key was last used

    Example: 2024-01-15T10:30:00Z
    namestringrequired

    Human-readable name for the key

    Example: Mobile App Key
    permissionsrequired

    Permissions granted to this key

    updatedAtstring<date-time>required

    When the key was last updated

    Example: 2024-01-15T10:30:00Z
    userIdstring<uuid>required

    Owner user ID

    Example: 550e8400-e29b-41d4-a716-446655440001
  • ]
  • links objectrequired

    HATEOAS navigation links

    firststringrequired

    Link to the first page

    laststringrequired

    Link to the last page

    nextstring | nullnullable

    Link to the next page (null if on last page)

    prevstring | nullnullable

    Link to the previous page (null if on first page)

    selfstringrequired

    Link to the current page

    pageinteger<int64>required

    Current page number (1-indexed)

    Possible values: >= 0

    Example: 1
    pageSizeinteger<int64>required

    Number of items per page

    Possible values: >= 0

    Example: 50
    totalinteger<int64>required

    Total number of items across all pages

    Possible values: >= 0

    Example: 150
    totalPagesinteger<int64>required

    Total number of pages

    Possible values: >= 0

    Example: 3
    PaginatedResponse_ApiKeyDto
    {
    "data": [
    {
    "createdAt": "2024-01-01T00:00:00Z",
    "expiresAt": "2025-12-31T23:59:59Z",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "isActive": true,
    "keyPrefix": "cdx_a1b2c3",
    "lastUsedAt": "2024-01-15T10:30:00Z",
    "name": "Mobile App Key",
    "updatedAt": "2024-01-15T10:30:00Z",
    "userId": "550e8400-e29b-41d4-a716-446655440001"
    }
    ],
    "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
    },
    "page": 1,
    "pageSize": 50,
    "total": 150,
    "totalPages": 3
    }