Skip to main content
Documentation Powered by ReDoc

Quartzy Public API

Download OpenAPI specification:Download

Quartzy Support: support@quartzy.com URL: https://support.quartzy.com Terms of Service

  • Quartzy's Public APIs listed here are generally available to all users. If you have an active user account in Quartzy, then you can start using this API right away.
  • If you have any questions about using this API, please reach out to Quartzy support at support@quartzy.com.

ℹ For code samples, please view the Samples page.

Authentication

AccessToken

Quartzy's API supports AccessTokens generated for specific users in an Organization. These AccessTokens may be generated from User settings inside the Quartzy Application.

  1. Load AccessToken Settings
  2. Click "Add AccessToken"
  3. Copy the generated AccessToken
  4. Provide this AccessToken to your API calls under the Access-Token header

AccessToken

Security Scheme Type API Key
Header parameter name: Access-Token

OAuth2

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://auth0.quartzy.com/authorize
Token URL: https://auth0.quartzy.com/oauth/token
Scopes:

    Health

    Check service health

    Responses

    Response samples

    Content type
    application/json
    { }

    Inventory Item

    List and filter inventory items

    Authorizations:
    AccessTokenOAuth2
    query Parameters
    page
    integer

    The page of results to retrieve

    lab_id
    string

    The Lab ID to filter on

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Get an Inventory Item

    Authorizations:
    AccessTokenOAuth2
    path Parameters
    id
    required
    string <uuid>

    The id of the Inventory Item to retrieve

    Responses

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "string",
    • "vendor": "string",
    • "catalog_number": "string",
    • "price": "string",
    • "unit_size": "string",
    • "quantity": "string",
    • "url": "string",
    • "technical_details": "string",
    • "expiration_date": "2019-08-24",
    • "auto_reminder": "string",
    • "lot_number": "string",
    • "cas_number": "string",
    • "vendor_product_id": "afd775e3-efaf-419a-bc05-aa8f21d6286a",
    • "lab": {
      },
    • "type": {
      },
    • "location": {
      },
    • "sublocation": {
      },
    • "added_by": {
      },
    • "updated_by": {
      },
    • "app_url": "http://example.com",
    • "serial_number": "string"
    }

    Update inventory item quantity

    Authorizations:
    AccessTokenOAuth2
    path Parameters
    id
    required
    string

    The id of the inventory item to update

    Request Body schema: application/json
    quantity
    string

    Responses

    Request samples

    Content type
    application/json
    {
    • "quantity": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "string",
    • "vendor": "string",
    • "catalog_number": "string",
    • "price": "string",
    • "unit_size": "string",
    • "quantity": "string",
    • "url": "string",
    • "technical_details": "string",
    • "expiration_date": "2019-08-24",
    • "auto_reminder": "string",
    • "lot_number": "string",
    • "cas_number": "string",
    • "vendor_product_id": "afd775e3-efaf-419a-bc05-aa8f21d6286a",
    • "lab": {
      },
    • "type": {
      },
    • "location": {
      },
    • "sublocation": {
      },
    • "added_by": {
      },
    • "updated_by": {
      },
    • "app_url": "http://example.com",
    • "serial_number": "string"
    }

    Lab

    Get a list of labs

    Authorizations:
    AccessTokenOAuth2
    query Parameters
    organization_id
    string <uuid>

    The Organization ID to filter on

    page
    integer

    The page of results to retrieve

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Get a Lab

    Authorizations:
    AccessTokenOAuth2
    path Parameters
    id
    required
    string <uuid>

    The id of the Lab to retrieve

    Responses

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "string",
    • "organization": {
      }
    }

    Order Request

    List and filter order requests

    Authorizations:
    AccessTokenOAuth2
    query Parameters
    page
    integer

    The page of results to retrieve

    lab_id
    string

    The Lab ID to filter on

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create an Order Request

    Authorizations:
    AccessTokenOAuth2
    Request Body schema: application/json
    lab_id
    required
    string <uuid>
    type_id
    required
    string <uuid>
    name
    required
    string
    vendor_product_id
    string <uuid>
    vendor_name
    required
    string
    catalog_number
    required
    string
    required
    object (Money)
    quantity
    required
    integer
    required_before
    string <date>
    notes
    string

    Responses

    Request samples

    Content type
    application/json
    {
    • "lab_id": "7b07a3a2-bd61-4451-ac34-b64b15e667bd",
    • "type_id": "d9779ea4-ba95-4824-86d7-4f1ac083a564",
    • "name": "string",
    • "vendor_product_id": "afd775e3-efaf-419a-bc05-aa8f21d6286a",
    • "vendor_name": "string",
    • "catalog_number": "string",
    • "price": {
      },
    • "quantity": 0,
    • "required_before": "2019-08-24",
    • "notes": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "app_url": "http://example.com",
    • "status": "CREATED",
    • "vendor_name": "string",
    • "catalog_number": "string",
    • "quantity": "string",
    • "unit_size": "string",
    • "unit_price": "string",
    • "total_price": {
      },
    • "requested_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "requested_by": {
      },
    • "notes": "string",
    • "item_name": "string",
    • "invoice_number": "string",
    • "requisition_number": "string",
    • "confirmation_number": "string",
    • "tracking_number": "string",
    • "purchase_order_number": "string",
    • "shipping_and_handling": "string",
    • "details": "string",
    • "lab": {
      },
    • "type": {
      },
    • "spend_tracking_code": {
      },
    • "backordered_expected_at": "2019-08-24",
    • "is_urgent": true
    }

    Get an Order Request

    Authorizations:
    AccessTokenOAuth2
    path Parameters
    id
    required
    string <uuid>

    The id of the Order Request to retrieve

    Responses

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "app_url": "http://example.com",
    • "status": "CREATED",
    • "vendor_name": "string",
    • "catalog_number": "string",
    • "quantity": "string",
    • "unit_size": "string",
    • "unit_price": "string",
    • "total_price": {
      },
    • "requested_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "requested_by": {
      },
    • "notes": "string",
    • "item_name": "string",
    • "invoice_number": "string",
    • "requisition_number": "string",
    • "confirmation_number": "string",
    • "tracking_number": "string",
    • "purchase_order_number": "string",
    • "shipping_and_handling": "string",
    • "details": "string",
    • "lab": {
      },
    • "type": {
      },
    • "spend_tracking_code": {
      },
    • "backordered_expected_at": "2019-08-24",
    • "is_urgent": true
    }

    Update an Order Request

    Authorizations:
    AccessTokenOAuth2
    path Parameters
    id
    required
    string <uuid>

    The id of the Order Request to update

    Request Body schema: application/json
    status
    string
    Enum: "CREATED" "CANCELLED" "APPROVED" "ORDERED" "BACKORDERED" "RECEIVED"

    Responses

    Request samples

    Content type
    application/json
    {
    • "status": "CREATED"
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "app_url": "http://example.com",
    • "status": "CREATED",
    • "vendor_name": "string",
    • "catalog_number": "string",
    • "quantity": "string",
    • "unit_size": "string",
    • "unit_price": "string",
    • "total_price": {
      },
    • "requested_at": "2019-08-24T14:15:22Z",
    • "updated_at": "2019-08-24T14:15:22Z",
    • "requested_by": {
      },
    • "notes": "string",
    • "item_name": "string",
    • "invoice_number": "string",
    • "requisition_number": "string",
    • "confirmation_number": "string",
    • "tracking_number": "string",
    • "purchase_order_number": "string",
    • "shipping_and_handling": "string",
    • "details": "string",
    • "lab": {
      },
    • "type": {
      },
    • "spend_tracking_code": {
      },
    • "backordered_expected_at": "2019-08-24",
    • "is_urgent": true
    }

    Type

    List and filter types

    Authorizations:
    AccessTokenOAuth2
    query Parameters
    lab_id
    string <uuid>

    The Lab ID to filter on

    name
    string

    The Type Name to filter on

    page
    integer

    The page of results to retrieve

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    User

    Current user

    Authorizations:
    AccessTokenOAuth2

    Responses

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "first_name": "string",
    • "last_name": "string",
    • "email": "user@example.com"
    }

    Webhook

    List and filter webhooks

    Authorizations:
    AccessTokenOAuth2
    query Parameters
    organization_id
    string <uuid>

    The Organization ID to filter on

    page
    integer

    The page of results to retrieve

    Responses

    Response samples

    Content type
    application/json
    [
    • {
      }
    ]

    Create a Webhook

    Authorizations:
    AccessTokenOAuth2
    Request Body schema: application/json
    One of
    lab_id
    required
    string <uuid>
    name
    string
    url
    required
    string
    event_types
    Array of strings
    is_enabled
    boolean
    is_verified
    boolean
    is_signed
    boolean

    Responses

    Request samples

    Content type
    application/json
    {
    • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    • "name": "string",
    • "url": "string",
    • "event_types": [
      ],
    • "is_enabled": true,
    • "is_verified": true,
    • "is_signed": true
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "string",
    • "url": "string",
    • "event_types": [
      ],
    • "is_enabled": true,
    • "is_verified": true,
    • "is_signed": true,
    • "signing_key": "string"
    }

    Get a Webhook

    Authorizations:
    AccessTokenOAuth2
    path Parameters
    id
    required
    string <uuid>

    The id of the Webhook to retrieve

    Responses

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "string",
    • "url": "string",
    • "event_types": [
      ],
    • "is_enabled": true,
    • "is_verified": true,
    • "is_signed": true,
    • "signing_key": "string"
    }

    Update a Webhook

    Authorizations:
    AccessTokenOAuth2
    path Parameters
    id
    required
    string <uuid>

    The id of the Webhook to update

    Request Body schema: application/json
    is_enabled
    boolean

    Responses

    Request samples

    Content type
    application/json
    {
    • "is_enabled": true
    }

    Response samples

    Content type
    application/json
    {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "string",
    • "url": "string",
    • "event_types": [
      ],
    • "is_enabled": true,
    • "is_verified": true,
    • "is_signed": true,
    • "signing_key": "string"
    }