Substy Developers
Creators

List custom orders

List up to 100 custom orders for one creator, filtered by one or several statuses, a fan, a search on the request and fan name, or work to do (to_deliver, or overdue against the given calendar day), sorted newest, oldest or by closest deadline (orders without one last). Follow nextCursor with the same filters and sort for later pages; total counts every match on the first page and is null on later pages. Includes payment totals and the latest ten event receipts per order.

GET/v1/agencies/{agencyId}/creators/{creatorId}/customs/orders

List up to 100 custom orders for one creator, filtered by one or several statuses, a fan, a search on the request and fan name, or work to do (to_deliver, or overdue against the given calendar day), sorted newest, oldest or by closest deadline (orders without one last). Follow nextCursor with the same filters and sort for later pages; total counts every match on the first page and is null on later pages. Includes payment totals and the latest ten event receipts per order.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

agencyId*string
Length1 <= length
creatorId*string
Length1 <= length

Query Parameters

limit?integer

Page size, at most 100. Follow the returned cursor or offset to retrieve later pages.

Range1 <= value <= 100
Default25
cursor?string
status?string

Value in

  • "pitching"
  • "quoted"
  • "agreed"
  • "paid"
  • "scheduled"
  • "delivered"
  • "declined"
statuses?array<>
Itemsitems <= 7
fanId?string
search?string
Lengthlength <= 200
sort?string
Default"newest"

Value in

  • "newest"
  • "oldest"
  • "due"
work?string

Value in

  • "to_deliver"
  • "overdue"
today?string

The caller’s calendar day (YYYY-MM-DD) for the overdue filter. Defaults to the UTC day.

Match^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/agencies/string/creators/string/customs/orders" \  -H "Authorization: Bearer YOUR_API_KEY"
{  "data": {    "items": [      {        "id": "string",        "what": "string",        "notIncluded": null,        "kind": "photo",        "requestedMinutes": null,        "minutes": null,        "pitchStep": 0,        "hasMadeConcession": true,        "move": "accept_offer",        "dueDate": null,        "status": "agreed",        "isAgencyNotified": true,        "price": null,        "fanOffer": null,        "paidAmount": {          "minor": 0,          "currency": "EUR"        },        "remainingAmount": null,        "currency": "EUR",        "creatorId": "string",        "fanId": "string",        "fanName": null,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "events": [          {            "id": "string",            "type": "delivered",            "amount": null,            "days": null,            "mediaIds": [              "string"            ],            "retryNumber": 0,            "appliedAt": null,            "queuedAt": null,            "sentAt": null,            "skippedAt": null,            "failedAt": null,            "lastError": null,            "createdAt": "2019-08-24T14:15:22Z"          }        ]      }    ],    "nextCursor": null,    "total": null  },  "meta": {    "requestId": "string"  }}

Update creator customs settings PUT

Save a creator’s customs policy and prices. Enabling sales requires nonempty free-form instructions. Disabling new sales preserves existing orders.

Get custom order GET

Read one creator-scoped custom order, payment totals, deadline and the latest ten event receipts. Inspect sentAt, skippedAt, failedAt and lastError to distinguish confirmed sends, actions settled without a fan message (the AI may not write to the fan) and queued or failed actions.