Skip to main content
GET
/
physical_samples
from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
samples = client.list_physical_samples()
[
  {
    "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "name": "GaAs-001",
    "created_datetime": "2024-01-12T09:00:00Z",
    "last_updated": "2024-01-15T10:00:00Z",
    "owner_id": "user_abc123",
    "owner_name": "Jane Smith",
    "num_data_items": 8,
    "growth_instrument": null,
    "target_material": null,
    "projects": [
      {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "name": "GaAs MBE Development"
      }
    ],
    "detail_notes": null
  }
]
Returns physical samples for your organization with optional filtering.
physical_sample_id
string
Filter by a specific physical sample UUID
has_data_item
boolean
Filter to samples that have (or don’t have) associated data items

Response

Returns an array of physical sample objects.
id
string
Physical sample UUID
name
string
Sample name or label
created_datetime
string
ISO 8601 timestamp of creation
last_updated
string
ISO 8601 timestamp of last update
owner_id
string
User ID of the sample owner
owner_name
string
Display name of the sample owner
num_data_items
integer
Number of data entries associated with this sample
growth_instrument
object
Growth instrument details
target_material
object
Target material information
projects
array
Projects this sample belongs to
detail_notes
object
Sample notes content
from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
samples = client.list_physical_samples()
[
  {
    "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
    "name": "GaAs-001",
    "created_datetime": "2024-01-12T09:00:00Z",
    "last_updated": "2024-01-15T10:00:00Z",
    "owner_id": "user_abc123",
    "owner_name": "Jane Smith",
    "num_data_items": 8,
    "growth_instrument": null,
    "target_material": null,
    "projects": [
      {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "name": "GaAs MBE Development"
      }
    ],
    "detail_notes": null
  }
]