API docs by Redocly

Factor (0.163.0)

Download OpenAPI specification:Download

Factor Api

factor

Public API Documentation for factor.io

organizations

Get one organization by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "name": "string",
  • "created": "string",
  • "updated": "string"
}

Update one organization by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
string
Request Body schema: application/json
name
string or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "sid": "string",
  • "name": "string",
  • "created": "string",
  • "updated": "string"
}

get organization by sid for non-org users

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "name": "string",
  • "logo100x100": "string"
}

users

List users (employee only)

Authorizations:
BearerAuth
query Parameters
organizationSid
string or null
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "page": {
    }
}

Get one user by sid or email

Authorizations:
BearerAuth
path Parameters
sidOrEmail
required
string
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "email": "string",
  • "organizationSid": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phoneNumber": "string",
  • "employee": true,
  • "password": true
}

Update one user by sid

Authorizations:
BearerAuth
path Parameters
sidOrEmail
required
string
header Parameters
authorization
string
Request Body schema: application/json
firstName
string or null

first name of the user

lastName
string or null

last name of the user

phoneNumber
string or null

optional phone number for the user

newPassword
string or null

the new password to be used for the account

currentPassword
string or null

the user's current password, must be provided if user is changing their password and has a current password

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "phoneNumber": "string",
  • "newPassword": "string",
  • "currentPassword": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "email": "string",
  • "organizationSid": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "phoneNumber": "string",
  • "employee": true,
  • "password": true
}

return user's public profile

Authorizations:
BearerAuth
path Parameters
sidOrEmail
required
string
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "email": "string"
}

orders

List orders

Authorizations:
BearerAuth
query Parameters
organizationSid
string or null
sid
Array of strings or null

a repeatable query param to fetch one or many orders by sid. this is a fast way to do a bulk fetch. max allowed is 100

vendorSid
string or null

filter the results to only items from orders that have this vendor sid

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ],
  • "page": {
    }
}

Create order

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: application/json
sid
string or null
vendorSid
string or null

selling factor organization sid. at least one of vendorSid or vendorName is required

vendorName
string or null

the name of the company the order is placed with. at least one of vendorSid or vendorName is required

uniqueName
string or null

an optional uniqueName that is unique per organization. this can act as the order's external unique id, or more friendly uniqueName than the sid

title
string or null

an optional title that can be used if uniqueName is not unique across your organization (e.g. if you want to have orders with the same title across multiple vendors)

eventRelations
Array of strings or null

an array of event relations, maximum number of sids allowed is 10

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "vendorSid": "string",
  • "vendorName": "string",
  • "uniqueName": "string",
  • "title": "string",
  • "eventRelations": [
    ]
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "vendorSid": "string",
  • "vendorName": "string",
  • "organizationSid": "string",
  • "uniqueName": "string",
  • "title": "string"
}

Get one order

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string

the order sid or order unique name

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "vendorSid": "string",
  • "vendorName": "string",
  • "organizationSid": "string",
  • "uniqueName": "string",
  • "title": "string"
}

Update one order

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string

the order sid or order unique name

header Parameters
authorization
string
Request Body schema: application/json
uniqueName
string or null
vendorSid
string or null

selling org sid

vendorName
string or null

selling org name

title
string or null

an optional title that can be used if uniqueName is not unique across your organization (e.g. if you want to have orders with the same title across multiple vendors)

eventRelations
Array of strings or null

an array of event relations, maximum number of sids allowed is 10

Responses

Request samples

Content type
application/json
{
  • "uniqueName": "string",
  • "vendorSid": "string",
  • "vendorName": "string",
  • "title": "string",
  • "eventRelations": [
    ]
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "vendorSid": "string",
  • "vendorName": "string",
  • "organizationSid": "string",
  • "uniqueName": "string",
  • "title": "string"
}

Delete an order. This is not recoverable

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string

the order sid or order unique name

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

orderEvents

List order events

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string

the order sid or order unique name

query Parameters
eventTimeOnOrAfter
string or null
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "orderEvents": [
    ],
  • "page": {
    }
}

orderMembers

List order members

Authorizations:
BearerAuth
query Parameters
orderSid
Array of strings or null

a repeatable query param to fetch one or many orders by sid. this is a fast way to do a bulk fetch. max allowed is 100

memberSid
string or null

optional sid of user

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an order member

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: application/json
sid
string
orderSid
string
memberSid
string

a UserSid

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "orderSid": "string",
  • "memberSid": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "orderSid": "string",
  • "memberSid": "string"
}

Delete one order member by sid - must be done by an Owner role

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Bulk delete order members

Authorizations:
BearerAuth
query Parameters
orderMemberSid
Array of strings or null

a repeatable query param to delete one or many order members by sid. this is a fast way to do a bulk delete. max allowed is 100

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

orderInvites

List order invites

Authorizations:
BearerAuth
query Parameters
orderSid
string or null
email
string or null
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "orderInvites": [
    ],
  • "page": {
    }
}

items

List order items

Authorizations:
BearerAuth
query Parameters
buyerSid
string or null

only show items from orders that have this buyer sid

vendorSid
string or null

only show items from orders that have this vendor sid

orderSid
string or null
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": {
    }
}

Create order items

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: application/json
uniqueName
string or null

an identifier that is unique within an order

title
string or null

an optional non-unique description if the unique is not descriptive enough

orderSid
string or null

the factor sid for the order. at least one of orderSid and orderUniqueName must be present. if both are provided they must refer to the same object

orderUniqueName
string or null

the unique name for the order. at least one of orderSid and orderUniqueName must be present. if both are provided they must refer to the same object

sid
string or null

optional item sid as idempotency token

status
string or null

optional item status which indicates if active or canceled

quantity
string
pricePerUnit
string or null
nonRecurringCost
string or null
leadTime
integer or null
shipTime
integer or null
lineNumber
integer or null

optional line number for this item

description
string or null

optional description

manufacturerPartNumber
string or null

optional manufacturer part number

revision
string or null

optional revision

eventRelations
Array of strings or null

an array of event relations, maximum number of sids allowed is 10

Responses

Request samples

Content type
application/json
{
  • "uniqueName": "string",
  • "title": "string",
  • "orderSid": "string",
  • "orderUniqueName": "string",
  • "sid": "string",
  • "status": "string",
  • "quantity": "string",
  • "pricePerUnit": "string",
  • "nonRecurringCost": "string",
  • "leadTime": 0,
  • "shipTime": 0,
  • "lineNumber": 0,
  • "description": "string",
  • "manufacturerPartNumber": "string",
  • "revision": "string",
  • "eventRelations": [
    ]
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "orderSid": "string",
  • "uniqueName": "string",
  • "title": "string",
  • "status": "string",
  • "quantity": "string",
  • "pricePerUnit": "string",
  • "nonRecurringCost": "string",
  • "leadTime": 0,
  • "shipTime": 0,
  • "organizationSid": "string",
  • "lineNumber": 0,
  • "description": "string",
  • "manufacturerPartNumber": "string",
  • "revision": "string"
}

Get one item

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
orderSid
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

orderUniqueName
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "orderSid": "string",
  • "uniqueName": "string",
  • "title": "string",
  • "status": "string",
  • "quantity": "string",
  • "pricePerUnit": "string",
  • "nonRecurringCost": "string",
  • "leadTime": 0,
  • "shipTime": 0,
  • "organizationSid": "string",
  • "lineNumber": 0,
  • "description": "string",
  • "manufacturerPartNumber": "string",
  • "revision": "string"
}

Update one item

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
orderSid
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

orderUniqueName
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

header Parameters
authorization
string
Request Body schema: application/json
uniqueName
string or null

the new unique name. supply null to remove the unique name

title
string or null

an optional non-unique description if the unique name is not descriptive enough. supply null to remove the title

status
string or null
quantity
string or null
pricePerUnit
string or null
nonRecurringCost
string or null
leadTime
integer or null
shipTime
integer or null
lineNumber
integer or null

optional line number for this item

description
string or null

optional description

manufacturerPartNumber
string or null

optional manufacturer part number

revision
string or null

optional revision

eventRelations
Array of strings or null

an array of event relations, maximum number of sids allowed is 10

Responses

Request samples

Content type
application/json
{
  • "uniqueName": "string",
  • "title": "string",
  • "status": "string",
  • "quantity": "string",
  • "pricePerUnit": "string",
  • "nonRecurringCost": "string",
  • "leadTime": 0,
  • "shipTime": 0,
  • "lineNumber": 0,
  • "description": "string",
  • "manufacturerPartNumber": "string",
  • "revision": "string",
  • "eventRelations": [
    ]
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "orderSid": "string",
  • "uniqueName": "string",
  • "title": "string",
  • "status": "string",
  • "quantity": "string",
  • "pricePerUnit": "string",
  • "nonRecurringCost": "string",
  • "leadTime": 0,
  • "shipTime": 0,
  • "organizationSid": "string",
  • "lineNumber": 0,
  • "description": "string",
  • "manufacturerPartNumber": "string",
  • "revision": "string"
}

Delete an item. This is not recoverable

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
orderSid
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

orderUniqueName
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

itemEvents

List events related to a specific item

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
eventTimeOnOrAfter
string or null
pageToken
string or null
pageSize
integer or null
orderSid
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

orderUniqueName
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "itemEvents": [
    ],
  • "page": {
    }
}

itemGroups

List item groups

Authorizations:
BearerAuth
query Parameters
itemSid
string or null
statusNot
string or null

If provided, return item groups whose status are not equal to this value

title
string or null

the item name that corresponds to the item group

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "itemGroups": [
    ],
  • "page": {
    }
}

Create item group

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: application/json
sid
string or null

optional order item sid as idempotency token

itemSid
string or null

the factor sid for the item this item group belongs to. when creating item groups a unique reference to an item must be supplied. unique item references include itemSid, orderSid + itemUniqueName, or orderUniqueName + itemUniqueName. if multiple item references are provided they all must be consistent

itemUniqueName
string or null

the unique name of the item this item group belongs to. when creating item groups a unique reference to an item must be supplied. unique item references include itemSid, orderSid + itemUniqueName, or orderUniqueName + itemUniqueName. if multiple item references are provided they all must be consistent

orderSid
string or null

the factor sid for the order. when creating item groups a unique reference to an item must be supplied. unique item references include itemSid, orderSid + itemUniqueName, or orderUniqueName + itemUniqueName. if multiple item references are provided they all must be consistent

orderUniqueName
string or null

the unique name for the order. when creating item groups a unique reference to an item must be supplied. unique item references include itemSid, orderSid + itemUniqueName, or orderUniqueName + itemUniqueName. if multiple item references are provided they all must be consistent

quantity
string

how many quantity from the line item are in this group

dueDate
string or null

the most recent agreed upon date of delivery between buyer and seller

shipDate
string or null

estimated or actual ship date

deliveryDate
string or null

estimated or actual delivery date

shipped
boolean

has this shipped?

delivered
boolean

has this been delivered?

trackingNumber
string or null
lastUpdateDate
string or null

last time item group was updated or confirmed

uniqueName
string or null

optional identifier that is unique within the item

status
string or null

optional identifier denoting item group status of either active or canceled

organizationSid
string or null

only used with Internal Robots to search for orders by order unique name. will throw an exception if it finds any other auth using this

eventRelations
Array of strings or null

an array of event relations, maximum number of sids allowed is 10

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "itemSid": "string",
  • "itemUniqueName": "string",
  • "orderSid": "string",
  • "orderUniqueName": "string",
  • "quantity": "string",
  • "dueDate": "string",
  • "shipDate": "string",
  • "deliveryDate": "string",
  • "shipped": true,
  • "delivered": true,
  • "trackingNumber": "string",
  • "lastUpdateDate": "string",
  • "uniqueName": "string",
  • "status": "string",
  • "organizationSid": "string",
  • "eventRelations": [
    ]
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "itemSid": "string",
  • "quantity": "string",
  • "dueDate": "string",
  • "shipDate": "string",
  • "deliveryDate": "string",
  • "shipped": true,
  • "delivered": true,
  • "trackingNumber": "string",
  • "version": 0,
  • "lastUpdateDate": "string",
  • "estimatedArrivalDate": "string",
  • "uniqueName": "string",
  • "orderSid": "string",
  • "organizationSid": "string",
  • "status": "string"
}

Get one item group

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
orderSid
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

orderUniqueName
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

itemSid
string or null

item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path

itemUniqueName
string or null

item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "itemSid": "string",
  • "quantity": "string",
  • "dueDate": "string",
  • "shipDate": "string",
  • "deliveryDate": "string",
  • "shipped": true,
  • "delivered": true,
  • "trackingNumber": "string",
  • "version": 0,
  • "lastUpdateDate": "string",
  • "estimatedArrivalDate": "string",
  • "uniqueName": "string",
  • "orderSid": "string",
  • "organizationSid": "string",
  • "status": "string"
}

Update one item group

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
orderSid
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

orderUniqueName
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

itemSid
string or null

item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path

itemUniqueName
string or null

item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path

header Parameters
authorization
string
Request Body schema: application/json
quantity
string or null

optional: new quantity value

trackingNumber
string or null

optional: new tracking number value. can be provided as null to remove tracking number

dueDate
string or null

optional: most recent agreed upon date of delivery between buyer and seller. can be provided as null to remove due date

shipDate
string or null

optional: estimated or actual ship date. can be provided as null to remove ship date

shipped
boolean or null

optional: controls whether the item has been shipped or not; should override ship date

deliveryDate
string or null

optional: estimated or actual delivery date. can be provided as null to remove delivery date

delivered
boolean or null

optional: controls whether the item has been delivered or not; takes precedence over delivery date if delivery date is null

lastUpdateDate
string or null

optional: last time item group was updated or confirmed. can be provided as null to remove last update date

uniqueName
string or null

optional: new unique name. can be provided as null to remove unique name

status
string or null

optional: identifier denoting item group status of either active or canceled

confirmed
boolean or null
Default: false

allows callers to confirm dates are accurate without providing new dates

eventRelations
Array of strings or null

an array of event relations, maximum number of sids allowed is 10

Responses

Request samples

Content type
application/json
{
  • "quantity": "string",
  • "trackingNumber": "string",
  • "dueDate": "string",
  • "shipDate": "string",
  • "shipped": true,
  • "deliveryDate": "string",
  • "delivered": true,
  • "lastUpdateDate": "string",
  • "uniqueName": "string",
  • "status": "string",
  • "confirmed": false,
  • "eventRelations": [
    ]
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "itemSid": "string",
  • "quantity": "string",
  • "dueDate": "string",
  • "shipDate": "string",
  • "deliveryDate": "string",
  • "shipped": true,
  • "delivered": true,
  • "trackingNumber": "string",
  • "version": 0,
  • "lastUpdateDate": "string",
  • "estimatedArrivalDate": "string",
  • "uniqueName": "string",
  • "orderSid": "string",
  • "organizationSid": "string",
  • "status": "string"
}

Delete an item group. This is not recoverable

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
orderSid
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

orderUniqueName
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

itemSid
string or null

item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path

itemUniqueName
string or null

item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Bulk update items

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: application/json
Array
sid
string

item group sid

quantity
string or null

optional: new quantity value

trackingNumber
string or null

optional: new tracking number value. can be provided as null to remove tracking number

dueDate
string or null

the most recent agreed upon date of delivery between buyer and seller

shipDate
string or null

optional: estimated or actual ship date. can be provided as null to remove ship date

shipped
boolean or null

optional: controls whether the item has been shipped or not; should override ship date

deliveryDate
string or null

optional: estimated or actual delivery date. can be provided as null to remove delivery date

delivered
boolean or null

optional: controls whether the item has been delivered or not; takes precedence over delivery date if delivery date is null

lastUpdateDate
string or null

optional: last time item group was updated or confirmed. can be provided as null to remove last update date

uniqueName
string or null

optional: new unique name. can be provided as null to remove unique name

status
string or null

optional: identifier denoting item group status of either active or canceled

confirmed
boolean or null
Default: false

allows callers to confirm dates are accurate without providing new dates

eventRelations
Array of strings or null

an array of event relations, maximum number of sids allowed is 10

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

itemGroupEvents

List item group events

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
eventTimeOnOrAfter
string or null
pageToken
string or null
pageSize
integer or null
orderSid
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

orderUniqueName
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

itemSid
string or null

item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path

itemUniqueName
string or null

item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "itemGroupEvents": [
    ],
  • "page": {
    }
}

applications

List applications

Authorizations:
BearerAuth
query Parameters
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ],
  • "page": {
    }
}

Get one application

Authorizations:
BearerAuth
path Parameters
sid
required
string

apikey

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "name": "string",
  • "organization": "string"
}

Update an application

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
regenerateSecret
boolean or null

should the secret be regenerated? this will modify the secret when 'true'

name
string or null

a new name for the application

Responses

Request samples

Content type
application/json
{
  • "regenerateSecret": true,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "secret": "string",
  • "created": "string",
  • "updated": "string",
  • "name": "string",
  • "organization": "string"
}

Hard delete an application by sid. This is not recoverable

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

openOrderUploads

list open order uploads

Authorizations:
BearerAuth
query Parameters
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "openOrderUploads": [
    ],
  • "page": {
    }
}

Upload an open order file

Upload a file of orders, items, and item groups. The columns available for the input file are documented here: https://coda.io/@factor-support/upload-csvs-in-factor

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: multipart/form-data
sid
string or null

optionally include an open order upload sid as an idempotency token. open order upload sids have prefix UP and total length 30, example: UP8ghcjdwj7f4wf7w37crmbphrpyxp

file
string <binary>

file content

fieldMappingSid
string or null

optional field mapping sid to support custom csv columns

orderMemberEmails
string or null

list of emails that should be added as order members or order invites

orderMemberSids
string or null

list of user sids that should be added as order members

forceItemGroupsNotPresentDelivered
boolean or null

nullable value, default is false. if true, item groups not present in upload will be marked as delivered

membersToNotifyOnFailure
string or null

comma separated list of emails OR user sids to receive notifications on failure to intake properly

fileType
string or null

file type of order upload. may be csv, xlsx, or xls. csv by default

orderUniqueNameHash
string or null

list of column names to be hashed to create the order's unique name

dataChangeGroupSid
string or null

optional data change group sid to support custom pre processing on csv based on the change group parameters

openOrderUploadParametersSid
string or null

a unique identifier for this open order upload create parameter. open order upload create parameter sids have prefix OU and total length 30, example: OU44bxbtbqchcqwwyy8chd73mmpy3j

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "organization": "string",
  • "status": "processing",
  • "fileSid": "string",
  • "fieldMappingSid": "string",
  • "orderMemberUserSids": [
    ],
  • "orderMemberEmails": [
    ],
  • "forceItemGroupsNotPresentDelivered": true,
  • "rowCountSuccess": 0,
  • "rowCountFailure": 0,
  • "fileType": "string",
  • "dataChangeGroupSid": "string",
  • "openOrderUploadParametersSid": "string"
}

Get one open order upload by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string

open order upload sid

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "organization": "string",
  • "status": "processing",
  • "fileSid": "string",
  • "fieldMappingSid": "string",
  • "orderMemberUserSids": [
    ],
  • "orderMemberEmails": [
    ],
  • "forceItemGroupsNotPresentDelivered": true,
  • "rowCountSuccess": 0,
  • "rowCountFailure": 0,
  • "fileType": "string",
  • "dataChangeGroupSid": "string",
  • "openOrderUploadParametersSid": "string"
}

Hard delete an open order upload by sid. this removes the file too

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Retrieve a temporary url to download the original file behind an open order upload

Authorizations:
BearerAuth
path Parameters
sid
required
string

open order upload sid

header Parameters
authorization
string

Responses

Response samples

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

openOrderUploadLogs

list open order upload logs

Authorizations:
BearerAuth
query Parameters
openOrderUploadSid
required
string

open order upload sid, optional for internal. required for public api identities

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "openOrderUploadLogs": [
    ],
  • "page": {
    }
}

flags

List flags you have access to

Authorizations:
BearerAuth
query Parameters
itemGroupSid
Array of strings
status
string or null
flag
string or null
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "flags": [
    ],
  • "page": {
    }
}

get flag by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "dismissed": "string",
  • "status": "string",
  • "itemGroupSid": "string",
  • "itemSid": "string",
  • "orderSid": "string",
  • "message": "string",
  • "type": "string"
}

Update flag by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
string
Request Body schema: application/json
message
string or null
status
string or null
dismissed
string or null

dismissed date time in RFC3339 format

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "status": "string",
  • "dismissed": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "dismissed": "string",
  • "status": "string",
  • "itemGroupSid": "string",
  • "itemSid": "string",
  • "orderSid": "string",
  • "message": "string",
  • "type": "string"
}

updateRequests

List updateRequests

Authorizations:
BearerAuth
query Parameters
itemGroupSid
string or null

get the update requests for this itemGroupSid

organizationSid
string or null

only used with Robots. will throw an exception if it finds any other auth using this.

sortOrder
string or null

maps to Factor enum type Sort

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "updateRequests": [
    ],
  • "page": {
    }
}

Create updateRequest

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: application/json
itemGroupSid
string

the item this update request maps to

note
string or null

the note corresponding to this update request

Responses

Request samples

Content type
application/json
{
  • "itemGroupSid": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "itemGroupSid": "string",
  • "organizationSid": "string",
  • "note": "string"
}

updateRequestConfigs

List updateRequestConfigs

Authorizations:
BearerAuth
query Parameters
nextUpdateOnOrBefore
string or null
cadenceSid
string or null
pageToken
string or null
pageSize
integer or null
vendorSid
string or null

a vendor sid, should grab the update requests for all buyers that have update request configs on correpsonding item groups

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "updateRequestConfigs": [
    ],
  • "page": {
    }
}

Create updateRequest

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: application/json
itemGroupSid
string

the item this update request configuration maps to

nextUpdate
string

the date for the next time we perform an update request

startDate
string or null

the date for when the automatic update request cycle begins

cadenceSid
string or null

the cadence sid corresponding to this update request

Responses

Request samples

Content type
application/json
{
  • "itemGroupSid": "string",
  • "nextUpdate": "string",
  • "startDate": "string",
  • "cadenceSid": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "itemGroupSid": "string",
  • "organizationSid": "string",
  • "startDate": "string",
  • "nextUpdate": "string",
  • "cadenceSid": "string",
  • "attempts": 0,
  • "lastAttempt": "string",
  • "version": "string"
}

Get updateRequestConfig

Authorizations:
BearerAuth
path Parameters
sid
required
string

can either be a UpdateRequestConfigSid or an ItemGroupSid

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "itemGroupSid": "string",
  • "organizationSid": "string",
  • "startDate": "string",
  • "nextUpdate": "string",
  • "cadenceSid": "string",
  • "attempts": 0,
  • "lastAttempt": "string",
  • "version": "string"
}

Update updateRequestConfig

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
string
Request Body schema: application/json
nextUpdate
string or null

the date for the next time we perform an update request

startDate
string or null

the date for when the automatic update request cycle begins

cadenceSid
string or null

the cadence sid corresponding to this update request, this will also reset attempts and lastAttempt if set

incrementAttempts
boolean
Default: false

increments the attempts of the update request config by 1 if true

currentVersion
string

the current version of this update request config, required

Responses

Request samples

Content type
application/json
{
  • "nextUpdate": "string",
  • "startDate": "string",
  • "cadenceSid": "string",
  • "incrementAttempts": false,
  • "currentVersion": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "itemGroupSid": "string",
  • "organizationSid": "string",
  • "startDate": "string",
  • "nextUpdate": "string",
  • "cadenceSid": "string",
  • "attempts": 0,
  • "lastAttempt": "string",
  • "version": "string"
}

itemCustomFields

list item custom fields

Authorizations:
BearerAuth
query Parameters
itemSid
required
string
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "itemCustomFields": [
    ],
  • "page": {
    }
}

Create a item custom field

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: application/json
sid
string or null

optional sid as idempotency token

itemSid
string
name
string

name must be unique for an item

value
string

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "itemSid": "string",
  • "name": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "itemSid": "string",
  • "name": "string",
  • "value": "string"
}

messages

Create message

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: application/json
sid
string or null

optional user sid as idempotency token

content
string
orderSids
Array of strings or null
itemSids
Array of strings or null
itemGroupSids
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "content": "string",
  • "orderSids": [
    ],
  • "itemSids": [
    ],
  • "itemGroupSids": [
    ]
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "organizationSid": "string",
  • "outboundEmailReplySid": "string",
  • "created": "string",
  • "updated": "string",
  • "author": "string",
  • "content": "string"
}

Get one message by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "organizationSid": "string",
  • "outboundEmailReplySid": "string",
  • "created": "string",
  • "updated": "string",
  • "author": "string",
  • "content": "string"
}

messagesForOrders

List messages you have access to filtered by order sid

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "page": {
    }
}

messagesForItems

List messages you have access to filtered by item

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
pageToken
string or null
pageSize
integer or null
orderSid
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

orderUniqueName
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "page": {
    }
}

messagesForItemGroups

List messages you have access to filtered by item group sid

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
pageToken
string or null
pageSize
integer or null
orderSid
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

orderUniqueName
string or null

order the item is from if supplying item unique name in the path. this is not needed if using item sid in the path

itemSid
string or null

item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path

itemUniqueName
string or null

item the item group is from if supplying item group unique name in the path. this is not needed if using item group sid in the path

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "page": {
    }
}

events

List events

Authorizations:
BearerAuth
query Parameters
eventTimeOnOrAfter
string or null
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "page": {
    }
}

get an event by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
query Parameters
fromWriter
boolean

should this query against the writer database?

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "eventTime": "string",
  • "organizationSid": "string",
  • "eventType": "string",
  • "event": { }
}

fileExports

list file exports

Authorizations:
BearerAuth
query Parameters
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "fileExports": [
    ],
  • "page": {
    }
}

create a file export

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: application/json
sid
string or null

optional sid to use as an idempotency token

object (FileExportQuery)

selections for the data

fieldMappingSid
string or null

optional field mapping sid to support custom csv columns

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "query": {
    },
  • "fieldMappingSid": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "deleteAfter": "string",
  • "status": "string",
  • "fileType": "string",
  • "fieldMappingSid": "string",
  • "query": {
    }
}

get file export

Authorizations:
BearerAuth
path Parameters
sid
required
string

file export sid

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "deleteAfter": "string",
  • "status": "string",
  • "fileType": "string",
  • "fieldMappingSid": "string",
  • "query": {
    }
}

delete a file export

Authorizations:
BearerAuth
path Parameters
sid
required
string

file export sid

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Retrieve a temporary url to download the file

Authorizations:
BearerAuth
path Parameters
sid
required
string

file export sid

header Parameters
authorization
string

Responses

Response samples

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

fieldMappings

list field mappings

Authorizations:
BearerAuth
query Parameters
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "fieldMappings": [
    ],
  • "page": {
    }
}

Create a new field mapping

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: application/json
sid
string or null

optional sid as idempotency token

name
string or null

optional name of the mapping group

importAllowed
boolean or null

when true this field map can be used to import data into factor

exportAllowed
boolean or null

when true this field map can be used to export data from factor

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "name": "string",
  • "importAllowed": true,
  • "exportAllowed": true
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "organizationSid": "string",
  • "name": "string",
  • "importAllowed": true,
  • "exportAllowed": true
}

Get one field mapping by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string

field mapping sid

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "organizationSid": "string",
  • "name": "string",
  • "importAllowed": true,
  • "exportAllowed": true
}

Hard delete a field mapping by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

mappedFields

list mapped fields

Authorizations:
BearerAuth
query Parameters
fieldMappingSid
string or null
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "mappedFields": [
    ],
  • "page": {
    }
}

Create a new mapped field

Authorizations:
BearerAuth
header Parameters
authorization
string
Request Body schema: application/json
sid
string or null

optional sid as idempotency token

fieldMappingSid
string
name
string

the column name as it exists in the customer's csv

mappedFieldType
string

the column's meaning when it is imported into factor

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "fieldMappingSid": "string",
  • "name": "string",
  • "mappedFieldType": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "fieldMappingSid": "string",
  • "name": "string",
  • "mappedFieldType": "string"
}

Get one mapped field by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string

mapped field sid

header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "fieldMappingSid": "string",
  • "name": "string",
  • "mappedFieldType": "string"
}

Hard delete a mapped field by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

boms

list bom

Authorizations:
BearerAuth
query Parameters
sid
Array of strings or null

a repeatable query param to fetch one or many boms by sid. this is a fast way to do a bulk fetch. max allowed is 100

uniqueName
Array of strings or null

a repeatable query param to fetch one or many boms by unique name. this is a fast way to do a bulk fetch. max allowed is 100

ctbLessThanEqualTo
string or null

optional parameter that will return boms that have associated clear to builds with today's date with a build quantity less than or equal to the given integer

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "boms": [
    ],
  • "page": {
    }
}

create a bom

Authorizations:
BearerAuth
header Parameters
authorization
required
string
Request Body schema: application/json
sid
string or null

optional sid to use as an idempotency token

uniqueName
string

a unique name for this bom

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "uniqueName": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "uniqueName": "string",
  • "version": "string"
}

get a bom

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string

bom sid or unique name

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "uniqueName": "string",
  • "version": "string"
}

delete a bom

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string

bom sid or unique name

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

bomLines

List bom lines

Authorizations:
BearerAuth
query Parameters
bomSid
string or null
includeTotalCount
boolean or null
orderBy
string or null

order the list by any one of the following values: ctb, requiredQuantity, orderedQuantity, inventoryQuantity

sortOrder
string or null

order of the result set: 'Asc' or 'Desc'. default 'Asc'

uniqueName
string or null

the unique name of the bom line

inventoryCountLessThanEqualTo
string or null

inventory count equals or less than

orderedQuantityLessThanEqualTo
string or null

ordered quantity equals or less than

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "bomLines": [
    ],
  • "page": {
    }
}

Create bom line

Authorizations:
BearerAuth
header Parameters
authorization
required
string
Request Body schema: application/json
sid
string

bom line sid

bomSid
string or null

the factor sid for the bom. at least one of bomSid and bomUniqueName must be present. if both are provided they must refer to the same object

uniqueName
string

unique name of bom line

requiredQuantity
string

the required quantity of this bom line to make the bom

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "bomSid": "string",
  • "uniqueName": "string",
  • "requiredQuantity": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "bomSid": "string",
  • "organizationSid": "string",
  • "uniqueName": "string",
  • "requiredQuantity": "string",
  • "version": "string"
}

Get bom line by sid or unique name

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
bomSid
string or null

bom the bom line is from if supplying bom line unique name in the path. this is not needed if using bom line sid in the path

bomUniqueName
string or null

unique name of the bom the bom line is from if supplying bom line unique name in the path. this is not needed if using bom line sid in the path

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "bomSid": "string",
  • "organizationSid": "string",
  • "uniqueName": "string",
  • "requiredQuantity": "string",
  • "version": "string"
}

Update one bom line by sid

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
bomSid
string or null

Bom the bom line is from if supplying bom unique name in the path. This is not needed if using bom sid in the path

bomUniqueName
string or null

unique name of the bom the bom line is from if supplying bom line unique name in the path. this is not needed if using bom line sid in the path

header Parameters
authorization
required
string
Request Body schema: application/json
requiredQuantity
string

the required quantity of this bom line to make the bom

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "bomSid": "string",
  • "organizationSid": "string",
  • "uniqueName": "string",
  • "requiredQuantity": "string",
  • "version": "string"
}

Hard delete a bom line

Authorizations:
BearerAuth
path Parameters
sidOrUniqueName
required
string
query Parameters
bomSid
string or null

Bom the bom line is from if supplying bom unique name in the path. This is not needed if using bom sid in the path

bomUniqueName
string or null

unique name of the bom the bom line is from if supplying bom line unique name in the path. this is not needed if using bom line sid in the path

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

inventoryCounts

list inventory counts

Authorizations:
BearerAuth
query Parameters
organizationSid
string or null

grabs inventory counts for all parts within an org

dateBefore
string or null

grabs inventory counts for all parts with recording dates on or before this date

dateAfter
string or null

grabs inventory counts for all parts with recording dates after this date

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "inventoryCounts": [
    ],
  • "page": {
    }
}

create a new inventory count

Authorizations:
BearerAuth
header Parameters
authorization
required
string
Request Body schema: application/json
sid
string or null

optional inventory count sid as idempotency token

recordingDate
string or null

date of the recording of this part in RFC3339 format. if nullable, current time will be assumed

count
integer

the number of this particular part that's in inventory

uniqueName
string

a unique name for this part that's in inventory

title
string or null

a non-unique name referring to the inventory count

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "recordingDate": "string",
  • "count": 0,
  • "uniqueName": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "recordingDate": "string",
  • "count": 0,
  • "uniqueName": "string",
  • "title": "string"
}

get an inventory count

Authorizations:
BearerAuth
path Parameters
sidOrName
required
string

inventory count sid or unique name

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "recordingDate": "string",
  • "count": 0,
  • "uniqueName": "string",
  • "title": "string"
}

clearToBuilds

list clear to builds

Authorizations:
BearerAuth
query Parameters
organizationSid
string or null

the organization that owns the clear to build

startDate
string or null

grabs clear to builds on or after this date

endDate
string or null

grabs clear to builds on or before this date

sid
Array of strings or null

a repeatable query param to fetch one or many clear to builds by bom or bom line sid. this is a fast way to do a bulk fetch. max allowed is 100

buildQuantityLessThanEqualTo
string or null

optional parameter that will return clear to builds with a build quantity less than or equal to the given integer

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "clearToBuilds": [
    ],
  • "page": {
    }
}

create a clear to build

Authorizations:
BearerAuth
header Parameters
authorization
required
string
Request Body schema: application/json
sid
string or null

optional clear to build sid as idempotency token

organizationSid
string

organization that owns the clear to build

referenceSid
string

bom or bom line the clear to build reflects

buildDate
string

the date the boms or bom lines can be built in RFC3339 format

buildQuantity
string

the number of boms or bom lines that can be built

type
string

denotes the type of clear to build, expected or actual

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "organizationSid": "string",
  • "referenceSid": "string",
  • "buildDate": "string",
  • "buildQuantity": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "organizationSid": "string",
  • "referenceSid": "string",
  • "buildDate": "string",
  • "buildQuantity": "string",
  • "type": "string"
}

update a clear to build

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
buildQuantity
string

the number of boms or bom lines that can be built

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "organizationSid": "string",
  • "referenceSid": "string",
  • "buildDate": "string",
  • "buildQuantity": "string",
  • "type": "string"
}

deletes a clear to build

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

bomUploads

list bom uploads

Authorizations:
BearerAuth
query Parameters
organizationSid
string or null
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "bomUploads": [
    ],
  • "page": {
    }
}

Get one bom upload by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string

bom upload sid

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": "string",
  • "organizationSid": "string",
  • "originatingIdentity": "string",
  • "fieldMappingSid": "string",
  • "status": "string",
  • "fileType": "string",
  • "rowCountSuccess": 0,
  • "rowCountFailure": 0,
  • "rowCountTotal": 0,
  • "dataChangeGroupSid": "string",
  • "bomUploadParametersSid": "string"
}

Hard delete a bom upload by sid. this removes the file too

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Retrieve a temporary url to download the original file behind a bom upload

Authorizations:
BearerAuth
path Parameters
sid
required
string

bom upload sid

header Parameters
authorization
required
string

Responses

Response samples

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

bomUploadsCreate

Upload a bom file

Upload a file of Boms and Bom Lines. The columns available for the input file are documented here: https://coda.io/@factor-support/upload-csvs-in-factor

Authorizations:
BearerAuth
header Parameters
authorization
required
string
Request Body schema: multipart/form-data
sid
string or null

optionally include a sid as an idempotency token

file
string <binary>

file content

organizationSid
string or null

optional org sid, only used for internal applications / phoenix users. all other user types take the org from the auth header

fieldMappingSid
string or null

optional field mapping map sid to support custom csv columns

fileType
string or null

file type of bom upload. may be csv, xlsx, or xls. default csv if not provided

dataChangeGroupSid
string or null

optional data change group sid to support custom pre processing on csv based on the change group parameters

bomUploadParametersSid
string or null

optionally supply parameters to this upload using a sid reference. if provided, parameters supplied in the request body will override parameters supplied via this sid. bom upload parameter sids have prefix BU and total length 30, example: BU19jxbkdpweojdwie8ejr92mmpy2u

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": "string",
  • "organizationSid": "string",
  • "originatingIdentity": "string",
  • "fieldMappingSid": "string",
  • "status": "string",
  • "fileType": "string",
  • "rowCountSuccess": 0,
  • "rowCountFailure": 0,
  • "rowCountTotal": 0,
  • "dataChangeGroupSid": "string",
  • "bomUploadParametersSid": "string"
}

inventoryUploads

list inventory uploads

Authorizations:
BearerAuth
query Parameters
organizationSid
string or null
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "inventoryUploads": [
    ],
  • "page": {
    }
}

Get one inventory upload by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string

inventory upload sid

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": "string",
  • "organization": "string",
  • "status": "string",
  • "fieldMappingSid": "string",
  • "originatingIdentity": "string",
  • "rowCountSuccess": 0,
  • "rowCountFailure": 0,
  • "rowCountTotal": 0,
  • "fileType": "string",
  • "inventoryUniqueNameHash": [
    ],
  • "dataChangeGroupSid": "string"
}

Hard delete an inventory upload by sid. this removes the file too

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Retrieve a temporary url to download the original file behind an inventory upload

Authorizations:
BearerAuth
path Parameters
sid
required
string

inventory upload sid

header Parameters
authorization
required
string

Responses

Response samples

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

inventoryUploadsCreate

Upload an inventory file

Upload a file of inventory counts. The columns available for the input file are documented here: https://coda.io/@factor-support/upload-csvs-in-factor

Authorizations:
BearerAuth
header Parameters
authorization
required
string
Request Body schema: multipart/form-data
sid
string or null

optionally include an inventory upload sid as an idempotency token. prefix is IP and total length is 30 ex: 'IPgw3vjhj99448v6jfgvk4xvctghm9'

file
string <binary>

file content

fieldMappingSid
string or null

optional field mapping map sid to support alternate column headers

fileType
string or null

file type of inventory upload. may be csv, xlsx, or xls. default csv if not provided

inventoryUniqueNameHash
Array of strings or null

list of column names to be hashed to create the inventory count's unique name. inventory count unique name must be unique across your organization. use this if there is no column in the inventory upload file that can uniquely identify each row

dataChangeGroupSid
string or null

optional data change group sid to support custom pre processing on csv based on the change group parameters

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": "string",
  • "organization": "string",
  • "status": "string",
  • "fieldMappingSid": "string",
  • "originatingIdentity": "string",
  • "rowCountSuccess": 0,
  • "rowCountFailure": 0,
  • "rowCountTotal": 0,
  • "fileType": "string",
  • "inventoryUniqueNameHash": [
    ],
  • "dataChangeGroupSid": "string"
}

clearToBuildTargets

Get one clear to build target by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string

clear to build target sid

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "organizationSid": "string",
  • "bomSid": "string",
  • "quantity": "string",
  • "durationLength": 0,
  • "durationType": "string",
  • "startDate": "string"
}

deletes a clear to build target

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

update a clear to build target

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
quantity
string or null

the number of boms to build

durationLength
integer or null

the number of days/weeks/months/years to target

durationType
string or null

denotes the type of duration: day, week, month, quarter, halfyear, year

startDate
string

the date the target should start calculating on

Responses

Request samples

Content type
application/json
{
  • "quantity": "string",
  • "durationLength": 0,
  • "durationType": "string",
  • "startDate": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "organizationSid": "string",
  • "bomSid": "string",
  • "quantity": "string",
  • "durationLength": 0,
  • "durationType": "string",
  • "startDate": "string"
}

list clear to build targets

Authorizations:
BearerAuth
query Parameters
organizationSid
string or null
bomSid
Array of strings or null

A repeatable query param to fetch one or many clear to build targets by bom sid. This is a fast way to do a bulk fetch. Max allowed is 100.

orderBy
string or null

optional sorting param which allows sort by startDate, will sort by insert order if null

sortOrder
string or null

order of the result set: 'Asc' or 'Desc'. default 'Asc'

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "clearToBuildTargets": [
    ],
  • "page": {
    }
}

create a clear to build target

Authorizations:
BearerAuth
header Parameters
authorization
required
string
Request Body schema: application/json
sid
string

optionally include a sid as an idempotency token

organizationSid
string or null

optional org sid, only used for internal applications / phoenix users. all other user types take the org from the auth header

bomSid
string

the bom being built

quantity
string

the number of boms to build

durationLength
integer

the number of days/weeks/months/years to target

durationType
string

denotes the type of duration: day, week, month, quarter, halfyear, year

startDate
string

the date the target should start calculating on

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "organizationSid": "string",
  • "bomSid": "string",
  • "quantity": "string",
  • "durationLength": 0,
  • "durationType": "string",
  • "startDate": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "organizationSid": "string",
  • "bomSid": "string",
  • "quantity": "string",
  • "durationLength": 0,
  • "durationType": "string",
  • "startDate": "string"
}

emailOptOut

Get one email opt out by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string

email opt out sid

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "email": "string",
  • "optOut": "string"
}

deletes an email opt out

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

list email opt outs

Authorizations:
BearerAuth
query Parameters
email
string or null
optOut
string or null
pageToken
string or null
pageSize
integer or null
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "emailOptOuts": [
    ],
  • "page": {
    }
}

cadences

list cadences

Authorizations:
BearerAuth
query Parameters
organizationSid
string or null
fromWriter
boolean

should this query against the writer database?

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "cadences": [
    ],
  • "page": {
    }
}

create a cadence

Authorizations:
BearerAuth
header Parameters
authorization
required
string
Request Body schema: application/json
sid
string or null

the sid corresponding to the cadence. For example, a cadenceSid is CAv9ppbmtkk3q4gk7hx8wf3dty7tvf

organizationSid
string or null

organization sid

delaySeconds
string

how often the cadence executes in seconds

unresponsiveAfterBusinessDays
string or null

number of business days to wait until this cadence is unresponsive

maxAttempts
string or null

max number of attempts

messageType
string

represents the outbound message type, please check CadenceMessageType for options

title
string or null

optional title for this cadence

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "organizationSid": "string",
  • "delaySeconds": "string",
  • "unresponsiveAfterBusinessDays": "string",
  • "maxAttempts": "string",
  • "messageType": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "organizationSid": "string",
  • "delaySeconds": "string",
  • "unresponsiveAfterBusinessDays": "string",
  • "maxAttempts": "string",
  • "messageType": "string",
  • "title": "string"
}

Update one cadence by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string

cadence sid

header Parameters
authorization
required
string
Request Body schema: application/json
delaySeconds
string or null

how often the cadence executes in seconds

maxAttempts
string or null

max number of attempts

messageType
string or null

represents the outbound message type, please check CadenceMessageType for options

title
string or null

optional title for this cadence

Responses

Request samples

Content type
application/json
{
  • "delaySeconds": "string",
  • "maxAttempts": "string",
  • "messageType": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "organizationSid": "string",
  • "delaySeconds": "string",
  • "unresponsiveAfterBusinessDays": "string",
  • "maxAttempts": "string",
  • "messageType": "string",
  • "title": "string"
}

get a cadence by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string

cadence sid

query Parameters
fromWriter
boolean

should this query against the writer database?

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "organizationSid": "string",
  • "delaySeconds": "string",
  • "unresponsiveAfterBusinessDays": "string",
  • "maxAttempts": "string",
  • "messageType": "string",
  • "title": "string"
}

delete a cadence

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

organizationSettings

Get organization settings by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string

Organization SID

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": 0,
  • "defaultTimeZone": "string",
  • "defaultUnresponsiveAfterBusinessDays": 0,
  • "defaultItemGroupCadence": "string",
  • "sendAutomatedUpdateRequests": true,
  • "pastDueBusinessDays": 0,
  • "defaultPastDueCadenceSid": "string"
}

Update organization settings

Authorizations:
BearerAuth
path Parameters
sid
required
string

Organization SID

header Parameters
authorization
required
string
Request Body schema: application/json
defaultTimeZone
string

The default time zone for the organization. It determines the time zone context for operations and schedules. Example default is 'America/New_York'.

defaultUnresponsiveAfterBusinessDays
integer

The number of business days before an vendor/organization is considered unresponsive. This is used to trigger alerts or actions for inactivity or delayed responses.

defaultItemGroupCadence
string

The default cadence for item grouping within the organization. This might define intervals for reviews, updates, or other recurring organizational tasks.

sendAutomatedUpdateRequests
boolean or null

Whether update requests will be automatically sent or not.

pastDueBusinessDays
integer or null

The number of past due business days.

defaultPastDueCadenceSid
string or null

The default cadence for past due.

Responses

Request samples

Content type
application/json
{
  • "defaultTimeZone": "string",
  • "defaultUnresponsiveAfterBusinessDays": 0,
  • "defaultItemGroupCadence": "string",
  • "sendAutomatedUpdateRequests": true,
  • "pastDueBusinessDays": 0,
  • "defaultPastDueCadenceSid": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": 0,
  • "defaultTimeZone": "string",
  • "defaultUnresponsiveAfterBusinessDays": 0,
  • "defaultItemGroupCadence": "string",
  • "sendAutomatedUpdateRequests": true,
  • "pastDueBusinessDays": 0,
  • "defaultPastDueCadenceSid": "string"
}

cadenceTransition

Get Cadence Transition by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string

cadence transition sid

query Parameters
fromWriter
boolean

should this query against the writer database?

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": 0,
  • "organizationSid": "string",
  • "cadenceSid": "string",
  • "condition": "string",
  • "conditionParameters": { },
  • "action": "string",
  • "actionParameters": { },
  • "title": "string"
}

deletes cadence transition

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

update an cadence transition

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
currentVersion
string
condition
string or null

The type of condition for the cadence transition

conditionParameters
object or null

Detailed parameters for the condition. Possible structures include ItemGroupBusinessDaysParams (e.g., {'businessDays': 5}), MaxAttemptsParams (e.g., {'maxAttempts': 3}), FlagCreatedParams (e.g., {'flagTypeRegexes': ['^urgent$', '^highPriority$']}), or BusinessDaysInStateParams (e.g., {'businessDaysAfterFinalAttempt': 7, 'totalBusinessDaysInState': 10}).

action
string or null

The type of action to be taken for the cadence transition

actionParameters
object or null

Detailed parameters for the action. Possible structures include CadenceActionParams (e.g., {'cadenceSid': 'C1234567890'}), or WebhookActionParams (e.g., {'url': 'https://example.com/webhook'}).

title
string or null

cadence transition Title

Responses

Request samples

Content type
application/json
{
  • "currentVersion": "string",
  • "condition": "string",
  • "conditionParameters": { },
  • "action": "string",
  • "actionParameters": { },
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": 0,
  • "organizationSid": "string",
  • "cadenceSid": "string",
  • "condition": "string",
  • "conditionParameters": { },
  • "action": "string",
  • "actionParameters": { },
  • "title": "string"
}

list cadence transition

Authorizations:
BearerAuth
query Parameters
cadenceSid
string or null
organizationSid
string or null
condition
string or null
fromWriter
boolean

should this query against the writer database?

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "cadenceTransitions": [
    ],
  • "page": {
    }
}

create an cadence transition

Authorizations:
BearerAuth
header Parameters
authorization
required
string
Request Body schema: application/json
sid
string or null

optionally include a sid as an idempotency token

organizationSid
string

Organization SID

cadenceSid
string

Cadence SID, must be owned by this org or no org

condition
string

The type of condition for the cadence transition

conditionParameters
object or null

Detailed parameters for the condition. Possible structures include ItemGroupBusinessDaysParams (e.g., {'businessDays': 5}), MaxAttemptsParams (e.g., {'maxAttempts': 3}), FlagCreatedParams (e.g., {'flagTypeRegexes': ['^urgent$', '^highPriority$']}), or BusinessDaysInStateParams (e.g., {'businessDaysAfterFinalAttempt': 7, 'totalBusinessDaysInState': 10}).

action
string

The type of action to be taken for the cadence transition

actionParameters
object or null

Detailed parameters for the action. Possible structures include CadenceActionParams (e.g., {'cadenceSid': 'CA6pv8rfb3jtf6wktpq9rd69hvmfcd'}), or WebhookActionParams (e.g., {'url': 'https://example.com/webhook'}).

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "organizationSid": "string",
  • "cadenceSid": "string",
  • "condition": "string",
  • "conditionParameters": { },
  • "action": "string",
  • "actionParameters": { }
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": 0,
  • "organizationSid": "string",
  • "cadenceSid": "string",
  • "condition": "string",
  • "conditionParameters": { },
  • "action": "string",
  • "actionParameters": { },
  • "title": "string"
}

cadenceTracker

Get Cadence Tracker by sid or referenceSid

Authorizations:
BearerAuth
path Parameters
sidOrReferenceSid
required
string
query Parameters
fromWriter
boolean

should this query against the writer database?

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": 0,
  • "organizationSid": "string",
  • "referenceSid": "string",
  • "cadenceSid": "string",
  • "lastUpdateDate": "string",
  • "nextUpdateDate": "string",
  • "attempts": 0
}

deletes cadence tracker by sid

Authorizations:
BearerAuth
path Parameters
sidOrReferenceSid
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

update an cadence tracker by sid

Authorizations:
BearerAuth
path Parameters
sidOrReferenceSid
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
cadenceSid
string

Cadence SID, must be owned by this org or no org

nextUpdateDate
string or null

optional: next update date. can be provided as null to remove next update date, this is a pause action

currentVersion
string

the current version of this cadence tracker update, required

Responses

Request samples

Content type
application/json
{
  • "cadenceSid": "string",
  • "nextUpdateDate": "string",
  • "currentVersion": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": 0,
  • "organizationSid": "string",
  • "referenceSid": "string",
  • "cadenceSid": "string",
  • "lastUpdateDate": "string",
  • "nextUpdateDate": "string",
  • "attempts": 0
}

list cadence tracker

Authorizations:
BearerAuth
query Parameters
organizationSid
string or null
nextUpdateDateBefore
string or null
fromWriter
boolean

should this query against the writer database?

pageToken
string or null
pageSize
integer or null
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "cadenceTrackers": [
    ],
  • "page": {
    }
}

create an cadence tracker

Authorizations:
BearerAuth
header Parameters
authorization
required
string
Request Body schema: application/json
sid
string or null

optionally include a sid as an idempotency token

organizationSid
string or null

Optional Organization SID, only needed if an internal app is making trackers

referenceSid
string

Any reference sid

cadenceSid
string

Cadence SID, must be owned by this org or no org

lastUpdateDate
string or null

last update date time in RFC3339 format

nextUpdateDate
string or null

next update date time in RFC3339 format

attempts
integer

attempts

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "organizationSid": "string",
  • "referenceSid": "string",
  • "cadenceSid": "string",
  • "lastUpdateDate": "string",
  • "nextUpdateDate": "string",
  • "attempts": 0
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": 0,
  • "organizationSid": "string",
  • "referenceSid": "string",
  • "cadenceSid": "string",
  • "lastUpdateDate": "string",
  • "nextUpdateDate": "string",
  • "attempts": 0
}

inboundEmails

Get Inbound Email by Sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
query Parameters
fromWriter
boolean

should this query against the writer database?

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": 0,
  • "organizationSid": "string",
  • "fromEmail": "string",
  • "toEmails": [
    ],
  • "ccEmails": [
    ],
  • "content": "string",
  • "s3Bucket": "string",
  • "s3Key": "string"
}

Retrieve a temporary url to download the content of an InboundEmail

Authorizations:
BearerAuth
path Parameters
sid
required
string

InboundEmail sid

header Parameters
authorization
required
string

Responses

Response samples

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

match with an inbound email

Authorizations:
BearerAuth
header Parameters
authorization
required
string
Request Body schema: application/json
sid
string or null

A unique identifier for this inbound email. InboundEmailSids have a prefix of IE and a total length of 30, example: IExqhpy3m78c7vq94p86q4cfrpkyhg

organizationSid
string or null

A unique identifier for the organization associated to this inbound email. Organization sids have a prefix OG and a total length of 30, example: OGrqf4e1vecgf5x9vmwb9pvp6r9ab1.

fromEmail
string

sender of the email

toEmails
Array of strings

recipients of the email

ccEmails
Array of strings or null

recipients copied in the email

subject
string

email's subject

content
string or null

email's first lines of content

date
string

email date time in RFC3339 format

attachmentNames
Array of strings or null

attachment names in the email

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "organizationSid": "string",
  • "fromEmail": "string",
  • "toEmails": [
    ],
  • "ccEmails": [
    ],
  • "subject": "string",
  • "content": "string",
  • "date": "string",
  • "attachmentNames": [
    ]
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": 0,
  • "organizationSid": "string",
  • "fromEmail": "string",
  • "toEmails": [
    ],
  • "ccEmails": [
    ],
  • "content": "string",
  • "s3Bucket": "string",
  • "s3Key": "string",
  • "frontUrl": "string"
}

inboundEmailAttachments

list inbound email attachments

Authorizations:
BearerAuth
query Parameters
inboundEmailSid
string
fromWriter
boolean

should this query against the writer database?

pageToken
string
pageSize
integer
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "inboundEmailAttachments": [
    ],
  • "page": {
    }
}

get inbound email attachment by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
query Parameters
fromWriter
boolean

should this query against the writer database?

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": "string",
  • "status": "string",
  • "organizationSid": "string",
  • "s3Bucket": "string",
  • "s3Key": "string",
  • "inboundEmailSid": "string",
  • "mimeType": "string",
  • "size": 0,
  • "name": "string"
}

delete inbound email attachment by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}

Retrieve a temporary url to download the inbound email attachment as a file

Authorizations:
BearerAuth
path Parameters
sid
required
string

inbound email attachment sid

header Parameters
authorization
required
string

Responses

Response samples

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

eventRelations

list event relations

Authorizations:
BearerAuth
query Parameters
organizationSid
string or null

Filters event relations based on orgnization sid.

eventSid
string or null

Filters event relations based on event sid.

eventType
string or null

Filters event relations based on event type.

relation
string or null

Filters event relations based on relation.

pageToken
string or null
pageSize
integer or null
sortOrder
string or null
fromWriter
boolean

should this query against the writer database?

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "eventRelationList": [
    ],
  • "page": {
    }
}

Create an event relation

Authorizations:
BearerAuth
header Parameters
authorization
required
string
Request Body schema: application/json
sid
string or null

A unique identifier for the event relation. EventRelation sids have a prefix of VR and a total length of 30, example: VRw3rqw7h9dcxjmvwbb6mg7httqr4r

eventSid
string

Event Sid

eventType
string

the event type of the referenced event

relation
string

relates to the referenced event, for example: factor:createdByAiParse:AiParseSid

Responses

Request samples

Content type
application/json
{
  • "sid": "string",
  • "eventSid": "string",
  • "eventType": "string",
  • "relation": "string"
}

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": "string",
  • "organizationSid": "string",
  • "eventSid": "string",
  • "eventType": "string",
  • "relation": "string"
}

get an event relation by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
query Parameters
fromWriter
boolean

should this query against the writer database?

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "sid": "string",
  • "created": "string",
  • "updated": "string",
  • "version": "string",
  • "organizationSid": "string",
  • "eventSid": "string",
  • "eventType": "string",
  • "relation": "string"
}

delete event relation by sid

Authorizations:
BearerAuth
path Parameters
sid
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}