# List endpoints

Endpoint: GET /v1/domains/{domainId}/endpoints
Security: httpAuth

## Security:

  - `httpAuth` (unknown)
    http bearer

## Path parameters:

  - `domainId` (string, required)
    Unique identifier for the domain.

## Query parameters:

  - `limit` (integer)
    The number of entities to return.

  - `startingAfter` (string)
    Entity id used to the determine beginning of query results.

  - `sortBy` (string)
    Property name used to sort the query results.

  - `sortOrder` (string)
    Sort order applied to the query results.

  - `ledgerId` (array)
    Return entities matching given ledger id.

  - `alias` (string)
    Return entities with aliases that contains or equals to provided alias.

  - `address` (array)
    Return entities matching given alias.

  - `metadata.createdBy` (string)
    Return entities that were created by matching user.

  - `metadata.lastModifiedBy` (string)
    Return entities that were last modified by matching user.

  - `metadata.description` (string)
    Return entities with descriptions that contains or equals to provided description.

  - `metadata.customProperties` (array)
    Return entities that contains provided custom properties.

  - `lock` (array)
    Return entities matching given lock status.

## Response 200 fields (application/json):

  - `items` (array, required)

  - `items.data` (object, required)

  - `items.data.id` (string, required)

  - `items.data.domainId` (string, required)

  - `items.data.address` (string, required)

  - `items.data.ledgerId` (string, required)

  - `items.data.parameters` (any)

  - `items.data.parameters.ABI` (string)
    This field can be used to provide an Application Binary Interface (ABI) for EVM-based smart contracts, Ripple Custody's front-end uses the field to provide an extended support when interacting with smart contracts, therefore it is not recommended to submit invalid ABIs in this field but Ripple Custody will not prevent the submission of invalid ABIs to tolerate use cases outside of Ripple Custody's front-end.

  - `items.data.parameters.type` (string, required)
    Enum: "Ethereum", "Hedera", "Stellar", "XRPL"

  - `items.data.parameters.memo` (string)
    String encoded using UTF-8, up to 100-bytes long

  - `items.data.parameters.memo` (any)

  - `items.data.parameters.memo.value` (string, required)
    Hex encoded stellar hash.

  - `items.data.parameters.memo.type` (string, required)
    Enum: "Hash", "Id", "Return", "Text"

  - `items.data.parameters.memo.value` (string, required)
    This field is a unsigned 64bit integer that can store values in range from 0 to 18446744073709551615.It is represented as a string because it may contain value that cannot be expressed with JSON number without a loss of precision.

  - `items.data.parameters.memo.value` (string, required)
    String encoded using either ASCII or UTF-8, up to 28-bytes long

  - `items.data.parameters.destinationTag` (integer)

  - `items.data.alias` (string, required)

  - `items.data.lock` (string, required)
    Enum: "Unlocked", "Locked", "Archived"

  - `items.data.metadata` (object, required)

  - `items.data.metadata.description` (string)

  - `items.data.metadata.revision` (integer, required)

  - `items.data.metadata.createdAt` (string, required)

  - `items.data.metadata.createdBy` (object)

  - `items.data.metadata.createdBy.id` (string, required)

  - `items.data.metadata.createdBy.domainId` (string, required)

  - `items.data.metadata.lastModifiedAt` (string, required)

  - `items.data.metadata.customProperties` (object, required)

  - `items.data.trustScore` (integer, required)

  - `items.signature` (string, required)

  - `items.signingKey` (string, required)

  - `count` (integer, required)

  - `currentStartingAfter` (string)

  - `nextStartingAfter` (string)

## Response 400:

  - `400` (unknown)
    Invalid value for: path parameter domainId, Invalid value for: query parameter limit, Invalid value for: query parameter startingAfter, Invalid value for: query parameter sortBy, Invalid value for: query parameter sortOrder, Invalid value for: query parameter ledgerId, Invalid value for: query parameter alias, Invalid value for: query parameter address, Invalid value for: query parameter metadata.createdBy, Invalid value for: query parameter metadata.lastModifiedBy, Invalid value for: query parameter metadata.description, Invalid value for: query parameter metadata.customProperties, Invalid value for: query parameter lock

## Response 401:

  - `401` (unknown)
    One of: Invalid JWT (InvalidJwtError); User not authorized (PermissionDeniedError)

## Response 401 fields (application/json):

  - `reason` (string, required)

  - `message` (string)

## Response 404:

  - `404` (unknown)
    Entity or Domain not found (EntityNotFoundError)

## Response 404 fields (application/json):

  - `reason` (string, required)

  - `message` (string)