v1

latestOpenAPI 3.0.02026-07-17224996.6 KB

Collections

Gets a Collection by ID

Get a collection by provided collection ID.

get/collections/{id}

Path parameters

idstring hexadecimal required

A 32-byte unique identifier for an entity.

The collection ID.

Query parameters

expandstring[]

A comma-separated list indicating which properties of the content to expand.

selectstring[]

A comma-separated list indicating which properties of the content to return.

Response

idstring hexadecimal required

A 32-byte unique identifier for an entity.

Example response

{
  "_links": {
    "_self": "_self"
  },
  "id": "id",
  "transactions": [
    {
      "_links": null,
      "reference_block_id": null,
      "payer": "payer",
      "script": "script",
      "result": {
        "collection_id": null,
        "error_message": "error_message",
        "execution": "Pending",
        "metadata": {
          "executor_metadata": {
            "execution_result_id": null,
            "executor_ids": [
              null,
              null
            ]
          }
        },
        "status_code": 0,
        "_links": {
          "_self": "_self"
        },
        "block_id": null,
        "computation_used": "computation_used",
        "events": [
          {
            "transaction_id": null,
            "payload": "",
            "transaction_index": "transaction_index",
            "type": "type",
            "event_index": "event_index"
          },
          {
            "transaction_id": null,
            "payload": "",
            "transaction_index": "transaction_index",
            "type": "type",
            "event_index": "event_index"
          }
        ],
        "status": "Pending"
      },
      "envelope_signatures": [
        null,
        null
      ],
      "gas_limit": "gas_limit",
      "payload_signatures": [
        {
          "address": null,
          "signature": "",
          "key_index": "key_index"
        },
        {
          "address": null,
          "signature": "",
          "key_index": "key_index"
        }
      ],
      "arguments": [
        "",
        ""
      ],
      "id": "id",
      "authorizers": [
        null,
        null
      ],
      "_expandable": {
        "result": "http://example.com/aeiou"
      },
      "proposal_key": {
        "sequence_number": "sequence_number",
        "address": null,
        "key_index": "key_index"
      }
    },
    {
      "_links": null,
      "reference_block_id": null,
      "payer": "payer",
      "script": "script",
      "result": {
        "collection_id": null,
        "error_message": "error_message",
        "execution": "Pending",
        "metadata": {
          "executor_metadata": {
            "execution_result_id": null,
            "executor_ids": [
              null,
              null
            ]
          }
        },
        "status_code": 0,
        "_links": {
          "_self": "_self"
        },
        "block_id": null,
        "computation_used": "computation_used",
        "events": [
          {
            "transaction_id": null,
            "payload": "",
            "transaction_index": "transaction_index",
            "type": "type",
            "event_index": "event_index"
          },
          {
            "transaction_id": null,
            "payload": "",
            "transaction_index": "transaction_index",
            "type": "type",
            "event_index": "event_index"
          }
        ],
        "status": "Pending"
      },
      "envelope_signatures": [
        null,
        null
      ],
      "gas_limit": "gas_limit",
      "payload_signatures": [
        {
          "address": null,
          "signature": "",
          "key_index": "key_index"
        },
        {
          "address": null,
          "signature": "",
          "key_index": "key_index"
        }
      ],
      "arguments": [
        "",
        ""
      ],
      "id": "id",
      "authorizers": [
        null,
        null
      ],
      "_expandable": {
        "result": "http://example.com/aeiou"
      },
      "proposal_key": {
        "sequence_number": "sequence_number",
        "address": null,
        "key_index": "key_index"
      }
    }
  ],
  "_expandable": {
    "transactions": [
      "http://example.com/aeiou",
      "http://example.com/aeiou"
    ]
  }
}