CreatorIQ CRM Onesheets API
Create, publish and manage One-Sheets — shareable creator pitch sheets — including adding publishers, comments, approvals and rejections.
OpenAPI Specification
openapi: 3.0.1
info:
version: 1.0.0
title: CreatorIQ CRM Onesheets API
description: CreatorIQ CRM APIs for Onesheets resource
termsOfService: 'https://www.creatoriq.com/legal/terms-of-use'
contact:
name: CreatorIQ
url: 'https://www.creatoriq.com'
email: support@creatoriq.com
license:
url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
name: Apache 2.0
servers:
- url: 'https://apis.creatoriq.com'
description: Live
paths:
/crm/v1/api/onesheets:
get:
tags:
- Onesheet
summary: Get Onesheets collection
description: Return a paginated collection of Onesheets
operationId: getOnesheetsCollection
parameters:
- name: page
in: query
description: Collection's page to show
required: false
schema:
type: integer
default: 1
example: 3
examples:
default:
value: 3
- name: size
in: query
description: Amount of items on the page. Default is 20
required: false
schema:
type: integer
default: 20
example: 50
examples:
default:
value: 50
- name: order
in: query
description: 'Sort order. Default is ''Id,desc'''
required: false
schema:
type: string
default: 'Id,desc'
example: 'UpdatedAt,desc'
examples:
default:
value: 'UpdatedAt,desc'
responses:
'200':
$ref: '#/components/responses/OneSheetsCollection'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
post:
tags:
- Onesheet
summary: Create a new OneSheet
description: Creates a new OneSheet
operationId: createOnesheet
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOneSheetBody'
responses:
'201':
$ref: '#/components/responses/OneSheetCreated'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
'/crm/v1/api/onesheet/{oneSheetId}':
get:
tags:
- Onesheet
summary: Get Single Onesheet
description: Return a Onesheet
operationId: getOnesheet
parameters:
- name: oneSheetId
in: path
description: OneSheet Id
required: true
schema:
type: integer
example: 333333
examples:
default:
value: 333333
responses:
'200':
$ref: '#/components/responses/OneSheetSingle'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
patch:
tags:
- Onesheet
summary: Update Onesheet
description: Updates Onesheet
operationId: updateOnesheet
parameters:
- name: oneSheetId
in: path
description: OneSheet Id
required: true
schema:
type: integer
example: 333333
examples:
default:
value: 333333
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateOneSheetBody'
responses:
'206':
$ref: '#/components/responses/OneSheetUpdated'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
delete:
tags:
- Onesheet
summary: Delete Onesheet
description: Deletes Onesheet
operationId: deleteOnesheet
parameters:
- name: oneSheetId
in: path
description: OneSheet Id
required: true
schema:
type: integer
example: 333333
examples:
default:
value: 333333
responses:
'204':
description: Successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
'/crm/v1/api/onesheet/{oneSheetId}/publishers':
get:
tags:
- Onesheet
summary: Gets Onesheet's Creators
description: Gets Onesheet's Creators
operationId: getCreatorsOfOnesheet
parameters:
- name: oneSheetId
in: path
description: OneSheet Id
required: true
schema:
type: integer
example: 333333
examples:
default:
value: 333333
responses:
'200':
$ref: '#/components/responses/OneSheetCreators'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
post:
tags:
- Onesheet
summary: Add Creator to Onesheet
description: Adds Creator to Onesheet
operationId: addCreatorToOnesheet
parameters:
- name: oneSheetId
in: path
description: OneSheet Id
required: true
schema:
type: integer
example: 333333
examples:
default:
value: 333333
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddPublisherToOneSheetBody'
responses:
'201':
description: Creator successfully added
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
'/crm/v1/api/onesheet/{oneSheetId}/publisher/{publisherId}':
get:
tags:
- Onesheet
summary: Get a certain Onesheet's Creator
description: Gets a certain Onesheet's Creators
operationId: getOnesheetSingleCreator
parameters:
- name: fields
in: query
description: '\ Data fields to get info for. Default set (when parameter is not set or empty) is "summary,comments,isPostMigrationProcess,demographics,locations,audienceTotal,infoForAdvertisers"'
schema:
type: string
example: 'infoForAdvertisers,isPostMigrationProcess'
examples:
default:
value: 'infoForAdvertisers,isPostMigrationProcess'
- name: oneSheetId
in: path
description: OneSheet Id
required: true
schema:
type: integer
example: 333333
examples:
default:
value: 333333
- name: publisherId
in: path
description: Creator Id
required: true
schema:
type: integer
example: 642626
examples:
default:
value: 642626
responses:
'200':
$ref: '#/components/responses/OneSheetCreator'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
delete:
tags:
- Onesheet
summary: Remove creator from one-sheet
description: Remove creator from one-sheet
operationId: RemoveCreator
parameters:
- name: oneSheetId
in: path
description: OneSheet Id
required: true
schema:
type: integer
example: 333333
examples:
default:
value: 333333
- name: publisherId
in: path
description: Creator Id
required: true
schema:
type: integer
example: 642626
examples:
default:
value: 642626
responses:
'204':
description: Deleted Successful
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
patch:
tags:
- Onesheet
summary: Update one-sheet creator
description: Update one-sheet creator
operationId: UpdateOneSheetCreator
parameters:
- name: oneSheetId
in: path
description: OneSheet Id
required: true
schema:
type: integer
example: 333333
examples:
default:
value: 333333
- name: publisherId
in: path
description: Creator Id
required: true
schema:
type: integer
example: 642626
examples:
default:
value: 642626
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateOneSheetCreatorBody'
responses:
'204':
description: Successful
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
'/crm/v1/api/onesheet/{oneSheetId}/publisher/{publisherId}/approve':
patch:
tags:
- Onesheet
summary: Approve Creator to Onesheet
description: Approves Creator to Onesheet
operationId: approveCreatorToOnesheet
parameters:
- name: oneSheetId
in: path
description: OneSheet Id
required: true
schema:
type: integer
example: 333333
examples:
default:
value: 333333
- name: publisherId
in: path
description: Creator Id
required: true
schema:
type: integer
example: 642626
examples:
default:
value: 642626
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ApprovePublisherToOneSheetBody'
responses:
'204':
description: Creator successfully approved
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
'/crm/v1/api/onesheet/{oneSheetId}/publisher/{publisherId}/comments':
post:
tags:
- Onesheet
summary: Add publisher comment to one-sheet
description: Add publisher comment to one-sheet
operationId: AddPublisherComment
parameters:
- name: oneSheetId
in: path
description: OneSheet Id
required: true
schema:
type: integer
example: 333333
examples:
default:
value: 333333
- name: publisherId
in: path
description: Creator Id
required: true
schema:
type: integer
example: 642626
examples:
default:
value: 642626
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AddPublisherCommentToOneSheetBody'
responses:
'201':
description: Success
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
'/crm/v1/api/onesheet/{oneSheetId}/publish':
post:
tags:
- Onesheet
summary: Publish one-sheet
description: Publish one-sheet
operationId: PublishOneSheet
parameters:
- name: oneSheetId
in: path
description: OneSheet Id
required: true
schema:
type: integer
example: 333333
examples:
default:
value: 333333
responses:
'204':
$ref: '#/components/responses/PublishOneSheet'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
tags:
- name: Onesheet
description: Onesheets public API
components:
securitySchemes:
apiKey:
type: apiKey
name: x-api-key
in: header
responses:
'400':
description: 'Bad request, invalid OneSheetId format or something goes wrong'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Incorrect x-api-key
'403':
description: Access was denied due to the API has insufficient access permissions
'404':
description: OneSheet with supplied ID not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
PublishOneSheet:
description: Publish one-sheet response
content:
application/json:
schema:
$ref: '#/components/schemas/PublishOneSheetResponse'
OneSheetsCollection:
description: One-sheets collection
content:
application/json:
schema:
$ref: '#/components/schemas/OneSheetsCollectionModel'
OneSheetSingle:
description: OneSheet
content:
application/json:
schema:
$ref: '#/components/schemas/OneSheetModel'
OneSheetCreated:
description: OneSheet
content:
application/json:
schema:
$ref: '#/components/schemas/OneSheetCreatedModel'
OneSheetUpdated:
description: OneSheet updated
content:
application/json:
schema:
$ref: '#/components/schemas/OneSheetUpdatedModel'
OneSheetCreators:
description: Array of Creators of Onesheet
content:
application/json:
schema:
$ref: '#/components/schemas/OneSheetCreatorsModel'
OneSheetCreator:
description: Creator of Onesheet
content:
application/json:
schema:
$ref: '#/components/schemas/OneSheetCreatorModel'
schemas:
CreateOneSheetBody:
type: object
properties:
Name:
type: string
description: Name of OneSheet
example: Test OneSheet
TotalReachCalculation:
type: string
enum:
- Selected
- Full
templateId:
type: integer
nullable: true
example: 2351
required:
- Name
UpdateOneSheetBody:
type: object
properties:
Name:
type: string
description: Name of OneSheet
example: Test OneSheet
TotalReachCalculation:
type: string
enum:
- Selected
- Full
templateId:
type: integer
example: 2351
Expired:
type: boolean
example: true
Template:
type: string
enum:
- OneSheet
example: OneSheet
VanityURL:
type: string
example: Test_OneSheet_63dcba77c85
NotifyEmails:
type: string
nullable: true
example: 'test1@test.com,test2@example.com'
ACLSections:
type: object
properties:
AudienceEthnicity:
type: integer
enum:
- 0
- 1
example: 0
PersonalDataEthnicBackground:
type: integer
enum:
- 0
- 1
example: 0
AudienceIncomeRange:
type: integer
enum:
- 0
- 1
example: 0
required:
- AudienceEthnicity
- PersonalDataEthnicBackground
- AudienceIncomeRange
isEnableThemeImageGlobal:
type: boolean
example: true
isCreatorHighlights:
type: string
nullable: true
example: '1'
IsSupportFeaturedCreators:
type: boolean
example: true
BrandLogoImageURL:
type: string
nullable: true
format: URI
example: 'https://social-pictures-storage.s3.amazonaws.com/6df9256e14d5cba4fa663acb252cb33f_7800601.jpeg'
SalesSheetImageURL:
type: string
nullable: true
format: URI
example: 'https://social-pictures-storage.s3.amazonaws.com/6df9256e14d5cba4fa663acb252cb33f_7800601.jpeg'
BrandingOptions:
type: object
properties:
colorScheme:
type: object
properties:
name:
type: string
example: name
headerBgColor:
type: array
items:
type: string
example: '#223a99'
example:
- '#ffaa00'
- '#223a99'
headerTextColor:
type: string
example: '#223a99'
introBgColor:
type: array
items:
type: string
example: '#223a99'
example:
- '#ffaa00'
- '#223a99'
introTextColor:
type: string
example: '#223a99'
pageBgColor:
type: string
example: '#223a99'
featuredBgColor:
type: array
items:
type: string
example: '#223a99'
example:
- '#ffaa00'
- '#223a99'
featuredTextColor:
type: string
example: '#223a99'
required:
- name
- headerBgColor
- headerTextColor
- introBgColor
- introTextColor
- pageBgColor
- featuredBgColor
- featuredTextColor
leftAlignment:
type: integer
enum:
- 0
- 1
example: 1
squareFrame:
type: integer
nullable: true
enum:
- 0
- 1
- null
example: 0
imageSize:
type: string
enum:
- small
- medium
- large
example: small
minProperties: 1
Sections:
type: object
properties:
Audience:
type: integer
example: 0
AudienceAge:
type: integer
example: 0
AudienceBrands:
type: integer
example: 0
AudienceCity:
type: integer
example: 0
AudienceCountry:
type: integer
example: 0
AudienceEthnicity:
type: integer
example: 0
AudienceGender:
type: integer
example: 0
AudienceInfluencers:
type: integer
example: 0
AudienceInterests:
type: integer
example: 0
AudienceState:
type: integer
example: 0
minProperties: 1
minProperties: 1
AddPublisherToOneSheetBody:
type: object
properties:
PublisherIds:
type: array
items:
type: integer
example: 13201168
required:
- PublisherIds
UpdateOneSheetCreatorBody:
type: object
description: Update one-sheet creator request body
properties:
Description:
type: string
nullable: true
description: Description
example: Long description text
SalesSheetImageURL:
type: string
nullable: true
description: Sales one-sheet image URL
format: URI
maxLength: 1024
example: 'https://socialedge-sales-sheet-publishers.s3.amazonaws.com/485110.jpg'
SalesSheetLogoURL:
type: string
nullable: true
description: Sales one-sheet logo URL
format: URI
maxLength: 1024
example: 'https://social-pictures-storage.s3.amazonaws.com/talent_mayawashington_headshot1.jpg_1506633937.jpg'
ShortDescription:
type: string
nullable: true
description: Short description
example: Short Description Text Example
InternalNotes:
type: string
nullable: true
description: Internal notes
example: Internal notes text example
Sections:
type: string
nullable: true
description: Sections
format: json
maxLength: 2048
example: '{"Musical.ly":1,"SalesSheetImageURL":1,"StatusInCampaign":1,"SocialMetrics":0,"SampleVideosPostBlog":1}'
SortOrder:
type: number
nullable: true
description: Sort order
format: float
example: 1.1
UpdatedBy:
type: string
nullable: true
description: Updated by
maxLength: 128
example: Name Surname
CreatedBy:
type: string
nullable: true
description: Created by
maxLength: 128
example: Name Surname
Approved:
type: boolean
nullable: true
description: Approved
example: true
Category:
type: string
nullable: true
description: Category
maxLength: 1024
example: '"Entertainment","Fitness","Lifestyle"'
Tags:
type: string
nullable: true
description: Tags
example: '"vlogger","beauty","goddard","F|challenge","F|parody","F|rachel","F|Fullscreen Affiliate"'
AudienceSocialNetwork:
type: string
nullable: true
description: Audience social network
maxLength: 50
example: instagram
AudienceSocialNetworkId:
type: string
nullable: true
description: Audience social network id
maxLength: 128
example: '2279929'
AudienceType:
type: string
nullable: true
description: Audience type
maxLength: 7
example: Blended
TopMetrics:
type: string
nullable: true
description: Top metrics
maxLength: 1024
example: '[{"network":"Youtube","field":"Followers","label":"subscribers"},{"network":"Facebook","field":"Followers","label":"likes"},{"network":"Twitter","field":"Followers","label":"followers"},{"network":"Instagram","field":"Followers","label":"followers"},{"network":"Google","field":"Followers","label":"followers"},{"network":"Tumblr","field":"Followers","label":"followers"},{"network":"Pinterest","field":"Followers","label":"followers"},{"network":"Snapchat","field":"AvgViewsPerPost","label":"views per snap"},{"network":"Web","field":"Followers","label":"uniques"}]'
IsFeatured:
type: boolean
nullable: true
description: Is featured flag
default: false
example: true
DescriptionVisibleSymbolsNumber:
type: integer
nullable: true
description: Description visible symbols number
example: 123
isPostMigrationProcess:
type: boolean
nullable: true
description: Is post migration process flag
default: false
example: true
required:
- Sections
minProperties: 1
ApprovePublisherToOneSheetBody:
type: object
properties:
Approved:
type: boolean
example: true
ApprovedBy:
type: object
properties:
Email:
type: string
example: test1@example.com
Name:
type: string
example: First Last
required:
- Email
- Name
required:
- Approved
- ApprovedBy
AddPublisherCommentToOneSheetBody:
type: object
properties:
Email:
type: string
description: Publisher comment email
format: email
example: test@gmail.com
CreatedBy:
type: string
description: Publisher comment creator
example: Test Name
Comment:
type: string
nullable: true
description: Publisher comment
example: Test comment
SocialEdgeId:
type: string
nullable: true
description: Publisher comment SocialEdgeId
example: Test Comment SocialEdgeId
required:
- Email
- CreatedBy
ErrorResponse:
type: object
description: Exception
properties:
type:
type: string
description: Exception type
example: CoreException
CoreException:
type: object
description: Exception information
properties:
code:
type: integer
description: Exception status code
format: int32
example: 404
message:
type: string
description: Exception message
example: Supplied ID was not found
required:
- type
PublishOneSheetResponse:
type: object
description: Publish one-sheet response
properties:
url:
type: string
description: Publish one-sheet response URL
format: URI
example: 'http://onesheets.creatoriq.com/One_Sheet_15_02_63ecf14d1d3a7'
required:
- url
OneSheetsCollectionModel:
type: object
properties:
type:
type: string
enum:
- OneSheetsCollection
description: Type of Search
example: OneSheetsCollection
href:
type: string
description: CreatorIQ API URL to get a collection of onesheets
format: URI
example: 'https://apis.creatoriq.com/crm/v1/api/onesheets'
count:
type: integer
description: Number of records in current response
example: 20
total:
type: integer
description: Total number of found rows
example: 1704
page:
type: integer
description: Current page
example: 2
OneSheetsCollection:
type: array
items:
$ref: '#/components/schemas/OneSheetInCollection'
required:
- type
- href
- count
- total
- page
- OneSheetsCollection
OneSheetInCollection:
type: object
properties:
type:
type: string
enum:
- OneSheet
description: Type of Search
example: OneSheet
href:
type: string
description: CreatorIQ API URL to get onesheet-related information
format: URI
example: 'https://apis.creatoriq.com/crm/v1/api/onesheet/99999'
OneSheet:
type: object
properties:
Id:
type: integer
example: 395809
PartnerId:
type: integer
example: 21
Name:
type: string
example: LS - Test One-Sheet for 2305 - Stage
VanityURL:
type: string
nullable: true
example: LS___Test_One_Sheet_for_2305___Stage_63d93cac18e7a
Data:
type: string
nullable: true
description: JSON string containing OneSheet's data
example: '{"Sections":{"PersonalData":1}}'
CreatedBy:
type: string
example: New Manager User
CreatedAt:
type: string
example: '2023-01-31 16:07:08'
UpdatedBy:
type: string
nullable: true
example: New Manager User
UpdatedAt:
type: string
example: '2023-01-31 16:46:50'
Expired:
type: boolean
example: false
ExpireAt:
type: string
nullable: true
example: '2023-02-28 23:59:00'
DeleteAt:
type: string
nullable: true
example: null
ExternalUser:
type: string
nullable: true
example: null
IsPublished:
type: integer
example: 1
SendNotifications:
type: integer
example: 0
AllowComments:
type: integer
enum:
- 0
- 1
example: 1
NotifyEmails:
type: string
nullable: true
example: 'test1@test.com,test2@example.com'
SalesSheetImageURL:
type: string
format: URI
example: 'h
# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/creatoriq/refs/heads/main/openapi/creatoriq-onesheets-openapi.yml