OpenAPI reference
Generated schemas, parameters, samples, and verified responses for every Daily v1 operation.
This reference is generated from the committed OpenAPI 3.1 contract. Use the secure playground for direct test requests; the generated renderer's built-in credential storage is intentionally disabled.
/businessAuthorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/business"{ "data": { "id": "0b703598-20d1-4eeb-9012-12db41ac8018", "object": "business", "name": "סטודיו נורת׳סטאר בע״מ", "english_name": "Northstar Studio Ltd.", "business_number": "515990281", "business_type": "company", "email": "finance@northstar.test", "phone": "+972-3-555-0142", "address": { "street": "HaArba’a 28", "city": "Tel Aviv-Yafo", "postal_code": "6473925", "country": "IL" }, "created_at": "2025-02-03T08:30:00.000Z", "updated_at": "2026-07-21T11:45:00.000Z" }, "request_id": "req_docsquickstart01"}/customersAuthorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Query Parameters
Maximum number of objects to return. Defaults to 50.
1 <= value <= 10050Opaque cursor returned in page.next_cursor. Do not construct or modify it.
length <= 512Return objects created strictly after this ISO 8601 timestamp.
date-timeReturn objects updated strictly after this ISO 8601 timestamp.
date-timeFilter by public status.
Value in
- "active"
- "inactive"
Case-insensitive resource search. Leading and trailing whitespace is removed.
length <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/customers?limit=50&created_after=2026-07-01T00%3A00%3A00.000Z&updated_after=2026-07-01T00%3A00%3A00.000Z&search=Northstar"{ "data": [ { "id": "44f34dad-a427-4c65-ae26-b0a43f8f65f7", "object": "customer", "type": "customer", "name": "Orion Retail", "business_number": "515880391", "contact_person": "Noa Levi", "email": "billing@orion-retail.test", "additional_emails": [ "ops@orion-retail.test" ], "phone": "+972-52-555-0128", "phones": [ { "value": "+972-52-555-0128", "primary": true } ], "address": { "street": "HaArba’a", "street_number": "28", "city": "Tel Aviv-Yafo", "postal_code": "6473925", "country_code": "IL" }, "status": "active", "currency": "ILS", "tags": [ "retail", "priority" ], "created_at": "2025-06-17T09:20:00.000Z", "updated_at": "2026-07-19T14:12:00.000Z" } ], "page": { "has_more": true, "next_cursor": "eyJyZXNvdXJjZSI6ImN1c3RvbWVycyIsInYiOjF9" }, "request_id": "req_docsquickstart01"}/customers/{id}Authorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Path Parameters
Resource UUID.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "44f34dad-a427-4c65-ae26-b0a43f8f65f7", "object": "customer", "type": "customer", "name": "Orion Retail", "business_number": "515880391", "contact_person": "Noa Levi", "email": "billing@orion-retail.test", "additional_emails": [ "ops@orion-retail.test" ], "phone": "+972-52-555-0128", "phones": [ { "value": "+972-52-555-0128", "primary": true } ], "address": { "street": "HaArba’a", "street_number": "28", "city": "Tel Aviv-Yafo", "postal_code": "6473925", "country_code": "IL" }, "status": "active", "currency": "ILS", "tags": [ "retail", "priority" ], "created_at": "2025-06-17T09:20:00.000Z", "updated_at": "2026-07-19T14:12:00.000Z" }, "request_id": "req_docsquickstart01"}/suppliersAuthorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Query Parameters
Maximum number of objects to return. Defaults to 50.
1 <= value <= 10050Opaque cursor returned in page.next_cursor. Do not construct or modify it.
length <= 512Return objects created strictly after this ISO 8601 timestamp.
date-timeReturn objects updated strictly after this ISO 8601 timestamp.
date-timeFilter by public status.
Value in
- "active"
- "inactive"
Case-insensitive resource search. Leading and trailing whitespace is removed.
length <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/suppliers?limit=50&created_after=2026-07-01T00%3A00%3A00.000Z&updated_after=2026-07-01T00%3A00%3A00.000Z&search=Northstar"{ "data": [ { "id": "37b06123-d1d7-4978-a1c7-17ffdbeb1c49", "object": "supplier", "type": "supplier", "name": "Atlas Office Supply", "business_number": "515880391", "contact_person": "Noa Levi", "email": "accounts@atlas-supply.test", "additional_emails": [ "ops@orion-retail.test" ], "phone": "+972-52-555-0128", "phones": [ { "value": "+972-52-555-0128", "primary": true } ], "address": { "street": "HaArba’a", "street_number": "28", "city": "Tel Aviv-Yafo", "postal_code": "6473925", "country_code": "IL" }, "status": "active", "currency": "ILS", "tags": [ "retail", "priority" ], "created_at": "2025-06-17T09:20:00.000Z", "updated_at": "2026-07-19T14:12:00.000Z" } ], "page": { "has_more": true, "next_cursor": "eyJyZXNvdXJjZSI6ImN1c3RvbWVycyIsInYiOjF9" }, "request_id": "req_docsquickstart01"}/suppliers/{id}Authorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Path Parameters
Resource UUID.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/suppliers/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "37b06123-d1d7-4978-a1c7-17ffdbeb1c49", "object": "supplier", "type": "supplier", "name": "Atlas Office Supply", "business_number": "515880391", "contact_person": "Noa Levi", "email": "accounts@atlas-supply.test", "additional_emails": [ "ops@orion-retail.test" ], "phone": "+972-52-555-0128", "phones": [ { "value": "+972-52-555-0128", "primary": true } ], "address": { "street": "HaArba’a", "street_number": "28", "city": "Tel Aviv-Yafo", "postal_code": "6473925", "country_code": "IL" }, "status": "active", "currency": "ILS", "tags": [ "retail", "priority" ], "created_at": "2025-06-17T09:20:00.000Z", "updated_at": "2026-07-19T14:12:00.000Z" }, "request_id": "req_docsquickstart01"}/leadsAuthorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Query Parameters
Maximum number of objects to return. Defaults to 50.
1 <= value <= 10050Opaque cursor returned in page.next_cursor. Do not construct or modify it.
length <= 512Return objects created strictly after this ISO 8601 timestamp.
date-timeReturn objects updated strictly after this ISO 8601 timestamp.
date-timeFilter by public status.
Value in
- "new"
- "contacted"
- "in_progress"
- "proposal"
- "negotiation"
- "won"
- "lost"
Case-insensitive resource search. Leading and trailing whitespace is removed.
length <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/leads?limit=50&created_after=2026-07-01T00%3A00%3A00.000Z&updated_after=2026-07-01T00%3A00%3A00.000Z&search=Northstar"{ "data": [ { "id": "20c85f5f-d823-411f-bbf7-f5b76ea77235", "object": "lead", "name": "Nova Hospitality", "contact_name": "Eitan Bar", "email": "eitan@nova-hospitality.test", "phone": "+972-54-555-0174", "address": "Herzliya", "source": "website", "status": "proposal", "owner": { "id": "913f5ab6-9525-483c-9aa1-73d561b8bfa8", "display_name": "Maya Cohen" }, "converted_customer_id": "0b703598-20d1-4eeb-9012-12db41ac8018", "created_at": "2026-07-08T07:45:00.000Z", "updated_at": "2026-07-20T10:05:00.000Z" } ], "page": { "has_more": true, "next_cursor": "eyJyZXNvdXJjZSI6ImN1c3RvbWVycyIsInYiOjF9" }, "request_id": "req_docsquickstart01"}/leads/{id}Authorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Path Parameters
Resource UUID.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/leads/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "20c85f5f-d823-411f-bbf7-f5b76ea77235", "object": "lead", "name": "Nova Hospitality", "contact_name": "Eitan Bar", "email": "eitan@nova-hospitality.test", "phone": "+972-54-555-0174", "address": "Herzliya", "source": "website", "status": "proposal", "owner": { "id": "913f5ab6-9525-483c-9aa1-73d561b8bfa8", "display_name": "Maya Cohen" }, "converted_customer_id": "0b703598-20d1-4eeb-9012-12db41ac8018", "created_at": "2026-07-08T07:45:00.000Z", "updated_at": "2026-07-20T10:05:00.000Z" }, "request_id": "req_docsquickstart01"}/productsAuthorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Query Parameters
Maximum number of objects to return. Defaults to 50.
1 <= value <= 10050Opaque cursor returned in page.next_cursor. Do not construct or modify it.
length <= 512Return objects created strictly after this ISO 8601 timestamp.
date-timeReturn objects updated strictly after this ISO 8601 timestamp.
date-timeFilter by public status.
Value in
- "active"
- "inactive"
Case-insensitive resource search. Leading and trailing whitespace is removed.
length <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/products?limit=50&created_after=2026-07-01T00%3A00%3A00.000Z&updated_after=2026-07-01T00%3A00%3A00.000Z&search=Northstar"{ "data": [ { "id": "44cfbbd5-185d-4c9d-8597-588c25e574e8", "object": "product", "type": "product", "name": "Brand workshop", "description": null, "sku": "WORKSHOP-01", "barcode": "7290012345678", "price_minor": 185000, "currency": "ILS", "vat_behavior": "excluding_vat", "unit": null, "status": "active", "inventory_tracked": false, "created_at": "2025-11-02T12:00:00.000Z", "updated_at": "2026-07-18T08:15:00.000Z" } ], "page": { "has_more": true, "next_cursor": "eyJyZXNvdXJjZSI6ImN1c3RvbWVycyIsInYiOjF9" }, "request_id": "req_docsquickstart01"}/products/{id}Authorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Path Parameters
Resource UUID.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/products/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "44cfbbd5-185d-4c9d-8597-588c25e574e8", "object": "product", "type": "product", "name": "Brand workshop", "description": null, "sku": "WORKSHOP-01", "barcode": "7290012345678", "price_minor": 185000, "currency": "ILS", "vat_behavior": "excluding_vat", "unit": null, "status": "active", "inventory_tracked": false, "created_at": "2025-11-02T12:00:00.000Z", "updated_at": "2026-07-18T08:15:00.000Z" }, "request_id": "req_docsquickstart01"}/documentsAuthorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Query Parameters
Maximum number of objects to return. Defaults to 50.
1 <= value <= 10050Opaque cursor returned in page.next_cursor. Do not construct or modify it.
length <= 512Return objects created strictly after this ISO 8601 timestamp.
date-timeReturn objects updated strictly after this ISO 8601 timestamp.
date-timeFilter by public status.
Value in
- "open"
- "converted"
- "pending_payment"
- "closed"
- "credited"
- "returned"
- "partially_paid"
- "partially_credited"
- "partially_returned"
Case-insensitive resource search. Leading and trailing whitespace is removed.
length <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/documents?limit=50&created_after=2026-07-01T00%3A00%3A00.000Z&updated_after=2026-07-01T00%3A00%3A00.000Z&search=Northstar"{ "data": [ { "id": "813d0b3f-ab6c-43d4-9173-8f224566ba2f", "object": "document", "document_type": "invoice", "document_number": 1042, "title": "Invoice 1042", "status": "pending_payment", "language": "en", "customer": { "id": "44f34dad-a427-4c65-ae26-b0a43f8f65f7", "name": "Orion Retail" }, "issue_date": "2026-07-15", "due_date": "2026-08-14", "currency": "ILS", "subtotal_minor": 185000, "discount_minor": null, "vat_minor": 33300, "total_minor": 218300, "payment_status": "unpaid", "pdf_available": true, "line_items": [ { "id": "ccf43b06-f708-41b7-8408-a96f31b637f2", "line_number": 1, "product_id": "44cfbbd5-185d-4c9d-8597-588c25e574e8", "name": "Brand workshop", "sku": "WORKSHOP-01", "quantity": "1.000", "unit_price_minor": 185000, "total_minor": 185000, "currency": "ILS", "vat_included": false } ], "related_document_ids": [], "created_at": "2026-07-15T08:05:00.000Z", "updated_at": "2026-07-15T08:06:00.000Z" } ], "page": { "has_more": true, "next_cursor": "eyJyZXNvdXJjZSI6ImN1c3RvbWVycyIsInYiOjF9" }, "request_id": "req_docsquickstart01"}/documents/{id}Authorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Path Parameters
Resource UUID.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "813d0b3f-ab6c-43d4-9173-8f224566ba2f", "object": "document", "document_type": "invoice", "document_number": 1042, "title": "Invoice 1042", "status": "pending_payment", "language": "en", "customer": { "id": "44f34dad-a427-4c65-ae26-b0a43f8f65f7", "name": "Orion Retail" }, "issue_date": "2026-07-15", "due_date": "2026-08-14", "currency": "ILS", "subtotal_minor": 185000, "discount_minor": null, "vat_minor": 33300, "total_minor": 218300, "payment_status": "unpaid", "pdf_available": true, "line_items": [ { "id": "ccf43b06-f708-41b7-8408-a96f31b637f2", "line_number": 1, "product_id": "44cfbbd5-185d-4c9d-8597-588c25e574e8", "name": "Brand workshop", "sku": "WORKSHOP-01", "quantity": "1.000", "unit_price_minor": 185000, "total_minor": 185000, "currency": "ILS", "vat_included": false } ], "related_document_ids": [], "created_at": "2026-07-15T08:05:00.000Z", "updated_at": "2026-07-15T08:06:00.000Z" }, "request_id": "req_docsquickstart01"}/documents/{id}/pdfAuthorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Path Parameters
Resource UUID.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08/pdf"{ "data": { "id": "813d0b3f-ab6c-43d4-9173-8f224566ba2f", "object": "document_pdf", "url": "https://files.daily.test/documents/invoice-1042.pdf?expires=300", "expires_at": "2026-07-21T12:05:00.000Z", "file_name": "invoice-1042.pdf" }, "request_id": "req_docsquickstart01"}/paymentsAuthorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Query Parameters
Maximum number of objects to return. Defaults to 50.
1 <= value <= 10050Opaque cursor returned in page.next_cursor. Do not construct or modify it.
length <= 512Return objects created strictly after this ISO 8601 timestamp.
date-timeReturn objects updated strictly after this ISO 8601 timestamp.
date-timeFilter by public status.
Value in
- "recorded"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/payments?limit=50&created_after=2026-07-01T00%3A00%3A00.000Z&updated_after=2026-07-01T00%3A00%3A00.000Z"{ "data": [ { "id": "9eaf89fa-dc55-4130-ac85-598f8a5430c5", "object": "payment", "document_id": "813d0b3f-ab6c-43d4-9173-8f224566ba2f", "customer_id": "44f34dad-a427-4c65-ae26-b0a43f8f65f7", "amount_minor": 218300, "currency": "ILS", "payment_method": "bank_transfer", "payment_date": "2026-07-20", "status": "recorded", "created_at": "2026-07-20T09:15:00.000Z", "updated_at": "2026-07-20T09:15:00.000Z" } ], "page": { "has_more": true, "next_cursor": "eyJyZXNvdXJjZSI6ImN1c3RvbWVycyIsInYiOjF9" }, "request_id": "req_docsquickstart01"}/payments/{id}Authorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Path Parameters
Resource UUID.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/payments/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "9eaf89fa-dc55-4130-ac85-598f8a5430c5", "object": "payment", "document_id": "813d0b3f-ab6c-43d4-9173-8f224566ba2f", "customer_id": "44f34dad-a427-4c65-ae26-b0a43f8f65f7", "amount_minor": 218300, "currency": "ILS", "payment_method": "bank_transfer", "payment_date": "2026-07-20", "status": "recorded", "created_at": "2026-07-20T09:15:00.000Z", "updated_at": "2026-07-20T09:15:00.000Z" }, "request_id": "req_docsquickstart01"}/inventoryAuthorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Query Parameters
Maximum number of objects to return. Defaults to 50.
1 <= value <= 10050Opaque cursor returned in page.next_cursor. Do not construct or modify it.
length <= 512Return objects created strictly after this ISO 8601 timestamp.
date-timeReturn objects updated strictly after this ISO 8601 timestamp.
date-timeFilter by public status.
Value in
- "active"
- "inactive"
Case-insensitive resource search. Leading and trailing whitespace is removed.
length <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/inventory?limit=50&created_after=2026-07-01T00%3A00%3A00.000Z&updated_after=2026-07-01T00%3A00%3A00.000Z&search=Northstar"{ "data": [ { "id": "44cfbbd5-185d-4c9d-8597-588c25e574e8", "object": "inventory_level", "product_id": "44cfbbd5-185d-4c9d-8597-588c25e574e8", "product_name": "Workshop workbook", "sku": "BOOK-01", "quantity": "42.000", "low_stock_threshold": "10.000", "status": "active", "created_at": "2025-12-01T09:00:00.000Z", "updated_at": "2026-07-20T09:16:00.000Z" } ], "page": { "has_more": true, "next_cursor": "eyJyZXNvdXJjZSI6ImN1c3RvbWVycyIsInYiOjF9" }, "request_id": "req_docsquickstart01"}/inventory/movementsAuthorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Query Parameters
Maximum number of objects to return. Defaults to 50.
1 <= value <= 10050Opaque cursor returned in page.next_cursor. Do not construct or modify it.
length <= 512Return objects created strictly after this ISO 8601 timestamp.
date-timeFilter by movement direction.
Value in
- "increase"
- "decrease"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/inventory/movements?limit=50&created_after=2026-07-01T00%3A00%3A00.000Z"{ "data": [ { "id": "2d545552-8dfa-4f5c-86d7-293390f6ec3e", "object": "inventory_movement", "product_id": "44cfbbd5-185d-4c9d-8597-588c25e574e8", "product_name": "Workshop workbook", "sku": "BOOK-01", "document_id": "813d0b3f-ab6c-43d4-9173-8f224566ba2f", "direction": "decrease", "quantity": "2.000", "created_at": "2026-07-20T09:16:00.000Z" } ], "page": { "has_more": true, "next_cursor": "eyJyZXNvdXJjZSI6ImN1c3RvbWVycyIsInYiOjF9" }, "request_id": "req_docsquickstart01"}/tasksAuthorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Query Parameters
Maximum number of objects to return. Defaults to 50.
1 <= value <= 10050Opaque cursor returned in page.next_cursor. Do not construct or modify it.
length <= 512Return objects created strictly after this ISO 8601 timestamp.
date-timeReturn objects updated strictly after this ISO 8601 timestamp.
date-timeFilter by public status.
Value in
- "open"
- "completed"
- "canceled"
Case-insensitive resource search. Leading and trailing whitespace is removed.
length <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/tasks?limit=50&created_after=2026-07-01T00%3A00%3A00.000Z&updated_after=2026-07-01T00%3A00%3A00.000Z&search=Northstar"{ "data": [ { "id": "9139e779-dd20-4418-b67a-20975607ce40", "object": "task", "title": "Confirm workshop schedule", "description": null, "status": "open", "priority": "high", "due_date": "2026-07-25", "due_at": "2026-07-25T07:00:00.000Z", "customer_id": "44f34dad-a427-4c65-ae26-b0a43f8f65f7", "document_id": "813d0b3f-ab6c-43d4-9173-8f224566ba2f", "lead_id": "20c85f5f-d823-411f-bbf7-f5b76ea77235", "assigned_user": { "id": "913f5ab6-9525-483c-9aa1-73d561b8bfa8", "display_name": "Maya Cohen" }, "created_at": "2026-07-20T10:10:00.000Z", "updated_at": "2026-07-21T08:30:00.000Z" } ], "page": { "has_more": true, "next_cursor": "eyJyZXNvdXJjZSI6ImN1c3RvbWVycyIsInYiOjF9" }, "request_id": "req_docsquickstart01"}/tasks/{id}Authorization
bearerAuth Use Authorization: Bearer $DAILY_API_KEY.
In: header
Path Parameters
Resource UUID.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "9139e779-dd20-4418-b67a-20975607ce40", "object": "task", "title": "Confirm workshop schedule", "description": null, "status": "open", "priority": "high", "due_date": "2026-07-25", "due_at": "2026-07-25T07:00:00.000Z", "customer_id": "44f34dad-a427-4c65-ae26-b0a43f8f65f7", "document_id": "813d0b3f-ab6c-43d4-9173-8f224566ba2f", "lead_id": "20c85f5f-d823-411f-bbf7-f5b76ea77235", "assigned_user": { "id": "913f5ab6-9525-483c-9aa1-73d561b8bfa8", "display_name": "Maya Cohen" }, "created_at": "2026-07-20T10:10:00.000Z", "updated_at": "2026-07-21T08:30:00.000Z" }, "request_id": "req_docsquickstart01"}
