### Get Signature Request Example Source: https://developer.shootproof.com/reference/studio/contracts This is an example of how to make a GET request to retrieve a signature. Authentication is required. ```http GET /studio/signature/{signatureId} HTTP/1.1 Host: api.shootproof.io Accept: application/vnd.shootproof+json Authorization: Bearer YOUR_API_TOKEN ``` -------------------------------- ### List Email Templates Request Example Source: https://developer.shootproof.com/reference/studio/email Example of how to make a GET request to list email templates for a specific brand. This includes path, query, and header parameters. ```http GET /studio/brand/{brandId}/email/template?filterForEmailAutomation=true HTTP/1.1 Host: api.shootproof.io Authentication: Bearer YOUR_API_TOKEN ``` -------------------------------- ### List Order Items Request Example Source: https://developer.shootproof.com/reference/studio/orders This example demonstrates how to make a GET request to list all order items for a specific order. It requires brandId and orderId as path parameters and an Authentication header. ```http GET /studio/brand/{brandId}/order/{orderId}/item HTTP/1.1 Host: api.shootproof.io Authentication: Bearer YOUR_ACCESS_TOKEN ``` -------------------------------- ### List Invoice Templates Request Example Source: https://developer.shootproof.com/reference/studio/invoices This example demonstrates how to make a GET request to list all invoice templates for a specific brand. Query parameters can be used for pagination, sorting, and filtering. ```http GET /studio/brand/{brandId}/invoice/template HTTP/1.1 Host: api.shootproof.io Accept: application/vnd.shootproof+json Authorization: Bearer YOUR_API_TOKEN ``` -------------------------------- ### Get a Notification Example Request Source: https://developer.shootproof.com/reference/studio/authenticated-user Provides an example of how to make a request to retrieve a specific notification by its ID. ```http GET /studio/brand/{brandId}/notification/{notificationId} HTTP/1.1 Host: api.shootproof.io Authorization: Bearer YOUR_API_TOKEN ``` -------------------------------- ### Example Request to List Price Sheet Discounts Source: https://developer.shootproof.com/reference/studio/price-sheets This example demonstrates how to make a GET request to retrieve all discounts for a specific price sheet. Ensure you provide the required brandId and priceSheetId path parameters, along with an Authentication header. ```http GET /studio/brand/{brandId}/price-sheet/{priceSheetId}/discount HTTP/1.1 Host: api.shootproof.io Authorization: Bearer YOUR_ACCESS_TOKEN ``` -------------------------------- ### List Price Sheets Request Example Source: https://developer.shootproof.com/reference/studio/price-sheets This example demonstrates how to make a GET request to list all price sheets for a specific brand. It includes placeholder path and header parameters. ```http get /studio/brand/{brandId}/price-sheet ``` -------------------------------- ### Example Request to Get Email Template Types Source: https://developer.shootproof.com/reference/studio/email This is an example of a GET request to the /studio/email/template-type endpoint. It requires an 'Authentication' header. ```http GET /studio/email/template-type HTTP/1.1 Host: api.shootproof.io Accept: application/vnd.shootproof+json Authorization: Bearer YOUR_API_KEY ``` -------------------------------- ### Get a ShootProof-curated email template Request Example Source: https://developer.shootproof.com/reference/studio/email Example of how to make a GET request to retrieve a specific curated email template using its ID. Requires an authentication token. ```http GET /studio/email/curated-template/{emailTemplateId} HTTP/1.1 Host: api.shootproof.io Authentication: Bearer YOUR_ACCESS_TOKEN ``` -------------------------------- ### Get a Brand Request Example Source: https://developer.shootproof.com/reference/studio/brands This example demonstrates how to make a GET request to retrieve a specific brand using its unique identifier. Ensure you include the required 'brandId' in the path and 'Authentication' token in the header. ```http GET /studio/brand/{brandId} HTTP/1.1 Host: api.shootproof.io Authentication: Bearer YOUR_ACCESS_TOKEN ``` -------------------------------- ### List Curated Email Templates Request Example Source: https://developer.shootproof.com/reference/studio/email Example of how to make a GET request to list ShootProof-curated email templates. Requires an Authentication header. ```http GET /studio/email/curated-template HTTP/1.1 Host: api.shootproof.io Authorization: Bearer YOUR_API_TOKEN ``` -------------------------------- ### List Events for Price Sheet - Example Request Source: https://developer.shootproof.com/reference/studio/price-sheets This example demonstrates how to make a GET request to list all events linked to a specific price sheet. It requires `brandId` and `priceSheetId` as path parameters and an `Authentication` header. ```http GET /studio/brand/{brandId}/price-sheet/{priceSheetId}/event HTTP/1.1 Host: api.shootproof.com Authentication: Bearer ``` -------------------------------- ### Get an Email Template Request Example Source: https://developer.shootproof.com/reference/studio/email This example demonstrates how to make a request to retrieve a specific email template. It includes path parameters for brand and template IDs, and optional query parameters for populating template variables. ```http GET /studio/brand/{brandId}/email/template/{emailTemplateId}?resourceId={resourceId}&resourceType={resourceType} HTTP/1.1 Host: api.shootproof.io Authorization: Bearer ``` -------------------------------- ### Access Token Request Example Source: https://developer.shootproof.com/guide/authorization Example of a POST request to obtain an access token. Ensure all parameters are correctly formatted and signed. ```http POST /oauth2/authorization/token HTTP/1.1 Accept: */* Content-Length: 183 Content-Type: application/x-www-form-urlencoded; charset=utf-8 Host: auth.shootproof.com grant_type=authorization_code&client_id=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX&code=68a8bdc685c6d48fbd84870ebe4371cd7ffc6f58&redirect_uri=https%3A%2F%2Fexample.com%2Fredirect&scope=studio ``` -------------------------------- ### List Recent Activity for a Contact Request Example Source: https://developer.shootproof.com/reference/studio/contacts This example demonstrates how to make a GET request to retrieve recent activity for a specific contact. It requires brandId and contactId as path parameters and an Authentication header. ```http GET /studio/brand/{brandId}/contact/{contactId}/recent-activity HTTP/1.1 Host: api.shootproof.io Authentication: Bearer YOUR_API_TOKEN ``` -------------------------------- ### Get Lab Catalog Shipping Option Request Example Source: https://developer.shootproof.com/reference/studio/price-sheets This example demonstrates how to make a GET request to retrieve a specific lab catalog shipping option. It requires brandId, labCatalogId, and labCatalogShippingOptionId as path parameters, and an Authentication header. ```http GET /studio/brand/{brandId}/lab-catalog/{labCatalogId}/shipping-option/{labCatalogShippingOptionId} HTTP/1.1 Host: api.shootproof.com Authentication: Bearer YOUR_ACCESS_TOKEN ``` -------------------------------- ### Get Invoice Discount Template Request Example Source: https://developer.shootproof.com/reference/studio/invoices This is an example request for retrieving an invoice discount template. It requires brand ID and invoice discount template ID as path parameters. ```http GET /studio/brand/{brandId}/invoice/discount-template/{invoiceDiscountTemplateId} ``` -------------------------------- ### Example Request to List Price Sheet Items Source: https://developer.shootproof.com/reference/studio/price-sheets This example demonstrates how to make a request to list items on a price sheet. It includes required path parameters and optional query parameters. ```http GET /studio/brand/{brandId}/price-sheet/{priceSheetId}/item?filterPriceSheetGroupId={filterPriceSheetGroupId}&filterPriceSheetSubgroupId={filterPriceSheetSubgroupId} HTTP/1.1 Host: api.shootproof.io Authentication: Bearer YOUR_ACCESS_TOKEN ``` -------------------------------- ### Get Email Automation Group Request Example Source: https://developer.shootproof.com/reference/studio/email This example demonstrates how to make a GET request to retrieve a specific email automation group. It includes required path and header parameters. ```http GET /studio/brand/{brandId}/email/automation-group/{emailAutomationGroupId} HTTP/1.1 Host: api.shootproof.io Authorization: Bearer YOUR_API_TOKEN ``` -------------------------------- ### List Lab Catalog Products Request Example Source: https://developer.shootproof.com/reference/studio/price-sheets This example demonstrates how to list all lab catalog products for a specific lab catalog. It includes required path parameters and optional query and header parameters for filtering and authentication. ```http GET /studio/brand/{brandId}/lab-catalog/{labCatalogId}/product HTTP/1.1 Host: api.shootproof.io Authorization: Bearer YOUR_API_TOKEN ``` -------------------------------- ### List all songs POST Request Example Source: https://developer.shootproof.com/reference/studio/music This example demonstrates how to make a POST request to search for songs. It is used when filter parameters exceed URL length limits. ```http POST /studio/song-search HTTP/1.1 Host: api.shootproof.io Content-Type: application/json Authorization: Bearer YOUR_API_TOKEN { "title": "Example Song Title", "artist": "Example Artist", "moods": ["Happy", "Upbeat"], "styles": ["Pop", "Electronic"], "tempo": "fast", "page": 1, "rows": 25, "sortType": "asc" } ``` -------------------------------- ### Create Contract Request Example Source: https://developer.shootproof.com/reference/studio/contracts An example of a request to create a new contract. This includes path parameters, header parameters, and the request body schema. ```OpenAPI { "200": { "content": { "application/vnd.shootproof+json": { "schema": { "$ref": "#/components/schemas/ContractCollection" } } }, "description": "A collection of contracts." } } ``` -------------------------------- ### Example Request for Creating a Price Sheet Item Image Source: https://developer.shootproof.com/reference/studio/price-sheets This example demonstrates how to construct a multipart/mixed request to create a new price sheet item image, including JSON data and binary image content. ```http --SP_BOUNDARY Content-Type: application/vnd.shootproof+json { "type": "price-sheet-element-image", "displayOrder": 1 } --SP_BOUNDARY Content-Disposition: attachment; filename=image.jpg Content-Type: image/jpeg [binary data] --SP_BOUNDARY-- ``` -------------------------------- ### Countersign Contract Request Example Source: https://developer.shootproof.com/reference/studio/contracts This example demonstrates how to make a PUT request to countersign a contract. It requires brand, contract, and signature identifiers in the path, along with an Authentication header. ```http PUT /studio/brand/{brandId}/contract/{contractId}/signature/{signatureId} HTTP/1.1 Host: api.shootproof.io Authentication: Bearer YOUR_ACCESS_TOKEN ``` -------------------------------- ### Invoice Installment OpenAPI Schema Source: https://developer.shootproof.com/reference/studio/components/schemas/invoice-installment The OpenAPI 3.0 schema definition for an invoice installment. This schema details the structure, properties, and types for representing invoice installments. ```json { "description": "An invoice installment.", "properties": { "amount": { "description": "The amount due for this installment.", "type": "number" }, "dueDate": { "description": "The date on which this installment is due.", "format": "date-time", "type": "string" }, "id": { "description": "The identifier for this invoice installment.", "type": "integer" }, "invoiceInstallmentStatus": { "description": "The status slug for this invoice installment.", "enum": [ "unpaid", "partially-paid", "paid-in-full" ], "readOnly": true, "type": "string" }, "isFixed": { "description": "Whether this amount is fixed.\n\nIf the installment amount is flagged as `fixed`, then it may not\nchange automatically due to recalculations based on changes to the\ninvoice grand total or other installment amounts. It may only change\nif the user directly edits this amount.", "type": "boolean" }, "isRetainer": { "description": "Whether this installment represents a retainer for a job.", "type": "boolean" }, "type": { "description": "The type of object represented.", "enum": [ "invoice-installment" ], "type": "string" } }, "required": [ "type", "isRetainer", "isFixed", "amount", "dueDate" ], "title": "Invoice Installment", "type": "object" } ``` -------------------------------- ### Forbidden Error Example Source: https://developer.shootproof.com/reference/studio/invoices Example of a 403 Forbidden error response. ```APIDOC ## Forbidden Error Example ### Response Example ```json { "detail": "You do not have permission to access the requested resource.", "status": 403, "title": "Forbidden", "type": "https://developer.shootproof.com/errors#error-forbidden" } ``` ``` -------------------------------- ### Order Item OpenAPI Schema Example Source: https://developer.shootproof.com/reference/studio/orders This is an example of the OpenAPI schema for a successful order item response. ```json { "200": { "content": { "application/vnd.shootproof+json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } }, "description": "Order item response." } } ``` -------------------------------- ### Server Error Example Source: https://developer.shootproof.com/reference/studio/invoices Example of a `500 Internal Server Error` response, indicating a problem on the server side. ```APIDOC ## Server Error Example ```json { "detail": "An error occurred on the server. If this error continues to occur, please contact support.", "status": 500, "title": "Internal Server Error", "type": "https://developer.shootproof.com/errors#error-server-error" } ``` ```