Get an AA sequence

GET

https://{tenant_name}.benchling.com/api/v2/aa-sequences/:aa_sequence_id

GET

/api/v2/aa-sequences/:aa_sequence_id

curl https://{tenant_name}.benchling.com/api/v2/aa-sequences/aa_sequence_id \
     -H "Authorization: Bearer <token>"

{
  "aliases": [
    "string"
  ],
  "aminoAcids": "IKTATARRELAETSWTGDRLWGFSDNWAPALRRPSPSALGK",
  "annotations": [
    {
      "color": "string",
      "end": 1,
      "id": "prtnann_o7zMPG0P",
      "name": "string",
      "notes": "Cong et al Science. 2013 Jan 3.",
      "start": 1,
      "type": "Site"
    }
  ],
  "apiURL": "https://benchling.com/api/v2/aa-sequences/prtn_7nMBOMm0",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "authors": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "customFields": {},
  "entityRegistryId": "string",
  "fields": {},
  "folderId": "string",
  "id": "prtn_ObbdtGhC",
  "length": 1,
  "modifiedAt": "2024-01-15T09:30:00Z",
  "name": "string",
  "registrationOrigin": {
    "originEntryId": "string",
    "registeredAt": "2024-01-15T09:30:00Z"
  },
  "registryId": "string",
  "schema": {
    "id": "string",
    "name": "string"
  },
  "url": "string",
  "webURL": "https://benchling.com/benchling/f/lib_55UxcIps-registry/prtn_7nMBOMm0-kedchain11/edit\""
}

Get an AA sequence

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

aa_sequence_idstringRequired

Query parameters

returningstringOptional

Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, ’*’. For more information, click here.

Note: Fields annotations, translations, and primers cannot be introspected with the returning parameter, and any sub fields will be ignored. E.g.: “annotations.id” will return the same as “annotations”.

Response

aliaseslist of stringsOptional

Array of aliases

aminoAcidsstringOptional

Amino acids of the AA sequence.

annotationslist of objectsOptional

Array of annotation objects on the AA sequence.

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the AA Sequence in the API.

archiveRecordobject or nullOptional

authorslist of objectsOptional

createdAtdatetimeOptionalRead-only

DateTime the AA sequence was created.

creatorobjectOptional

customFieldsmap from strings to objectsOptional

Custom fields set on the AA sequence.

entityRegistryIdstring or nullOptional

Registry ID of the AA sequence if registered.

fieldsmap from strings to objectsOptional

folderIdstring or nullOptional

ID of the folder that contains the AA sequence.

idstringOptional

ID of the AA sequence.

lengthintegerOptional

Number of amino acids in the AA sequence.

modifiedAtdatetimeOptionalRead-only

DateTime the AA sequence was last modified.

namestringOptional

Name of the AA sequence.

registrationOriginobject or nullOptional

registryIdstring or nullOptional

Registry the AA sequence is registered in.

schemaobject or nullOptional

urlstringOptional

The path of the web URL, omitting the tenant domain

webURLstringOptionalRead-onlyformat: "uri"

URL of the AA sequence.

Errors

400

Bad Request Error