CreatorIQ CRM Publishers API
Read, create, update and delete creator (publisher) records in the customer's CreatorIQ CRM, plus their linked social accounts, scheduled posts, contacts and campaign relationships.
OpenAPI Specification
openapi: 3.1.0
info:
version: 1.0.0
title: CreatorIQ CRM Publishers API
description: CreatorIQ CRM APIs for Publishers (Influencer/Creator) 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/publisher/{publisherId}':
get:
tags:
- Publisher
summary: Find Publisher by ID
description: Return particular Publisher Information
operationId: getPublisherPublisherId
parameters:
- name: key
in: query
description: |
Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
required: false
schema:
type: string
enum:
- Id
- PublisherId
pattern: '^[a-zA-Z0-9]+$'
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
pattern: '^[a-zA-Z0-9]+$'
examples:
- '999999'
examples:
default:
value: '999999'
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: Type of Search
examples:
- Publisher
Publisher:
$ref: '#/components/schemas/PublisherByIdModel'
required:
- type
- Publisher
'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:
- Publisher
summary: Update Publisher Information
description: Update Publisher Social accounts with verified and linked flags
operationId: patchPublisherPublisherIdAccounts
parameters:
- name: key
in: query
description: |
Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
required: false
schema:
type: string
enum:
- Id
- PublisherId
- NetworkPublisherId
pattern: '^[a-zA-Z0-9]+$'
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
pattern: '^[a-zA-Z0-9]+$'
examples:
- '99999'
examples:
default:
value: '99999'
requestBody:
content:
application/json:
schema:
type: object
properties:
PublisherName:
type: string
description: Publisher Name
maxLength: 255
examples:
- test
PublisherId:
type: integer
description: Publisher Id
examples:
- 3293835
NetworkPublisherId:
type:
- string
- 'null'
description: Network Publisher Id
default: null
examples:
- '3293836'
Glasses:
type: integer
enum:
- 0
- 1
- null
description: Glasses
examples:
- 0
AccountManagerName:
type:
- string
- 'null'
description: Account Manager Name
default: null
examples:
- John Smith
OutsideManagerName:
type:
- string
- 'null'
description: Outside Manager Name
default: null
examples:
- John Smith
ManagementCompany:
type:
- string
- 'null'
description: Management Company
default: null
examples:
- John Smith
RecruiterName:
type:
- string
- 'null'
description: Recruiter Name
default: null
examples:
- John Smith
Subnetworks:
type:
- string
- 'null'
description: Subnetworks
default: null
examples:
- 'Subnetwork1, Subnetwork2, Subnetwork3'
Status:
type: string
enum:
- Open
- Active
- New Applicant
- Pending
- Not Accepted
- Applied to Network
- Candidate
- Incomplete
- null
description: Status
examples:
- Open
StatusCategory:
type: string
enum:
- In Network
- In Process
- Other
- null
description: Status Category
examples:
- In Network
CustomValue1:
type:
- string
- 'null'
description: Custom value number 1
maxLength: 1000
default: null
examples:
- test
CustomValue2:
type:
- string
- 'null'
description: Custom value number 2
maxLength: 1000
default: null
examples:
- test
CustomValue3:
type:
- string
- 'null'
description: Custom value number 3
maxLength: 1000
default: null
examples:
- test
CustomValue4:
type:
- string
- 'null'
description: Custom value number 4
maxLength: 1000
default: null
examples:
- test
CustomValue5:
type:
- string
- 'null'
description: Custom value number 5
maxLength: 1000
default: null
examples:
- test
CustomValue6:
type:
- string
- 'null'
description: Custom value number 6
maxLength: 1000
default: null
examples:
- test
CustomValue7:
type:
- string
- 'null'
description: Custom value number 7
maxLength: 1000
default: null
examples:
- test
CustomValue8:
type:
- string
- 'null'
description: Custom value number 8
maxLength: 1000
default: null
examples:
- test
CustomValue9:
type:
- string
- 'null'
description: Custom value number 9
maxLength: 1000
default: null
examples:
- test
CustomValue10:
type:
- string
- 'null'
description: Custom value number 10
maxLength: 1000
default: null
examples:
- test
CustomValue11:
type:
- string
- 'null'
description: Custom value number 11
maxLength: 1000
default: null
examples:
- test
CustomValue12:
type:
- string
- 'null'
description: Custom value number 12
maxLength: 1000
default: null
examples:
- test
CustomValue13:
type:
- string
- 'null'
description: Custom value number 13
maxLength: 1000
default: null
examples:
- test
CustomValue14:
type:
- string
- 'null'
description: Custom value number 14
maxLength: 1000
default: null
examples:
- test
CustomValue15:
type:
- string
- 'null'
description: Custom value number 15
maxLength: 1000
default: null
examples:
- test
CustomValue16:
type:
- string
- 'null'
description: Custom value number 16
maxLength: 1000
default: null
examples:
- test
CustomValue17:
type:
- string
- 'null'
description: Custom value number 17
maxLength: 1000
default: null
examples:
- test
Relationship:
type:
- string
- 'null'
description: Relationship
default: null
examples:
- In a Relationship
Children:
type:
- string
- 'null'
description: Children
default: null
examples:
- One
Pets:
type:
- string
- 'null'
description: Pets
default: null
examples:
- Fish
Tags:
type:
- string
- 'null'
description: Tags
default: null
examples:
- 'Tag1, Tag2, Tag3'
WillTravel:
type: integer
enum:
- 0
- 1
- null
examples:
- 0
BrandsWontWork:
type:
- string
- 'null'
description: Brands Wont Work
default: null
examples:
- Some Brand Name
BrandsWorked:
type:
- string
- 'null'
description: Brands Worked
default: null
examples:
- Some Brand Name
BrandsWishWork:
type:
- string
- 'null'
description: Brands Wish Work
default: null
examples:
- Some Brand Name
EyeColor:
type:
- string
- 'null'
description: Eye Color
default: null
examples:
- Blue
HairColor:
type:
- string
- 'null'
description: Hair Color
default: null
examples:
- Dark
HaveKids:
type: integer
enum:
- 0
- 1
- null
description: Have Kids
examples:
- 0
HavePets:
type: integer
enum:
- 0
- 1
- null
description: Have Pets
examples:
- 0
PhoneNumber:
type:
- string
- 'null'
description: Phone Number
default: null
examples:
- (123)456-7892
HasDriverLicense:
type: integer
enum:
- 0
- 1
- null
description: Has Driver License flag
examples:
- 1
HasPassport:
type: integer
enum:
- 0
- 1
- null
description: Has Passport flag
examples:
- 0
Size:
type:
- string
- 'null'
description: Size
maxLength: 50
default: null
examples:
- Test Size
LeadSource:
type:
- string
- 'null'
description: Lead Source
maxLength: 50
default: null
examples:
- Broad Search
Category:
type:
- string
- 'null'
description: Category
maxLength: 255
default: null
examples:
- 'Beauty-Hair, Lifestyle'
SubCategories:
type:
- string
- 'null'
description: Sub Categories
maxLength: 255
default: null
examples:
- 'Beauty-General, Beauty-SkinCare'
DateOfBirth:
type:
- string
- 'null'
description: Date of Birth
default: null
examples:
- 04/04/1985
PayPalEmail:
type:
- string
- 'null'
description: Email
format: email
default: null
examples:
- test@test.com
PayPalFirstName:
type:
- string
- 'null'
description: First name
default: null
examples:
- Christy
PayPalLastName:
type:
- string
- 'null'
description: First name
default: null
examples:
- Weimann
Address:
type: object
properties:
AddressLine1:
type:
- string
- 'null'
description: Address
examples:
- 'Robert Robertson, 1234 NW Bobcat Lane, St. Robert'
ZIPCode:
type:
- string
- 'null'
description: ZIPCode
examples:
- '02108'
City:
type:
- string
- 'null'
description: City
examples:
- Boston
State:
type:
- string
- 'null'
description: State
examples:
- Massachusetts
Country:
type:
- string
- 'null'
description: Country
examples:
- USA
Email:
type:
- string
- 'null'
description: Email
format: email
default: null
examples:
- Estevan.Conn54@yahoo.com
Email1:
type:
- string
- 'null'
description: Email
format: email
default: null
examples:
- test@test.com
Gender:
type: string
description: 'I.e. Male, Female, Transgender'
maxLength: 50
examples:
- Female
FirstName:
type: string
description: First name
examples:
- Christy
LastName:
type: string
description: First name
examples:
- Weimann
FullName:
type: string
description: First name
examples:
- Christy Weimann
EthnicBackground:
type:
- string
- 'null'
description: 'I.e. Asian, Caucasian, African American'
maxLength: 255
default: null
examples:
- Asian
Language:
type: string
description: Publisher's primary language. I.E. English. If this field is left blank and YouTube channel is specified SocialEdge will attempt to look this up via YouTube API
maxLength: 50
examples:
- English
Language2:
type: string
description: Publisher's language. I.E. English. If this field is left blank and YouTube channel is specified SocialEdge will attempt to look this up via YouTube API
maxLength: 50
examples:
- English
DatePublisherDeActivated:
type: string
description: Date published when activated
format: date-time
examples:
- '2021-01-30T08:30:00Z'
Description:
type:
- string
- 'null'
description: If this field is left blank and YouTube channel is specified SocialEdge will attempt to look up YouTube channel description via YouTube API and use it as default value
default: null
examples:
- My channel description
accountId:
type: string
description: SocialNetworkId for account
examples:
- '999999999999999999'
network:
type: string
enum:
- Youtube
- Twitter
- Facebook
- Instagram
- Google
- Vine
description: 'Social network (Twitter, Facebook, Instagram, Google, Vine etc.)'
examples:
- Youtube
CreatedBy:
type: string
description: Name of person who added Social Account
examples:
- Admin
CreatorRole:
type: string
description: Role of person who added Social Account
examples:
- Admin
VerifiedBy:
type: string
description: Name of person who verified Social Account
examples:
- Admin
VerifiedAt:
type: string
description: 'Date and Time when Social Account was verified (e.g. 2015-06-04 10:00:01.000)'
format: date-time
examples:
- '2015-06-04 10:00:01.000'
LinkedBy:
type: string
description: Name of person who linked Social Account
examples:
- Admin
LinkedAt:
type: string
description: 'Date and Time when Social Account was linked (e.g. 2015-06-04 10:00:01.000)'
format: date-time
examples:
- '2015-06-04 10:00:01.000'
minProperties: 1
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
delete:
tags:
- Publisher
summary: Delete Publisher from Network
description: Delete publisher form network
operationId: deletePublisher
parameters:
- name: key
in: query
description: |
Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
required: false
schema:
type: string
enum:
- Id
- PublisherId
pattern: '^[a-zA-Z0-9]+$'
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
pattern: '^[a-zA-Z0-9]+$'
examples:
- '9999'
examples:
default:
value: '9999'
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/publisher/{publisherId}/scheduledPosts':
get:
tags:
- Publisher
summary: Get Publisher ScheduledPosts info
description: Get Publisher ScheduledPosts
operationId: getPublisherIdScheduledPosts
parameters:
- name: key
in: query
description: |
Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
required: false
schema:
type: string
enum:
- Id
- PublisherId
pattern: '^[a-zA-Z0-9]+$'
examples:
- Id
examples:
default:
value: Id
- name: page
in: query
description: page number
schema:
type: string
examples:
- '2'
examples:
default:
value: '2'
- name: size
in: query
description: number of elements on page
schema:
type: string
examples:
- '20'
examples:
default:
value: '20'
- name: publisherId
in: path
description: Unique Publisher identifier
required: true
schema:
type: string
examples:
- '20'
examples:
default:
value: '20'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignScheduledPostsSuccessResponseModel'
'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/publishers/{publisherIds}/accounts':
get:
tags:
- Publisher
summary: GET social accounts for multiple publishers.
description: |
Fetch the social accounts information for bulk publishers. Max count of publishers 10.
> **Warning**: This API endpoint is deprecated and will be removed at 2026-04-16. You could use the [new version of endpoint](https://apidocs.creatoriq.com/docs/ciq-api-documentation/5d20075e89450-get-social-accounts-for-multiple-publishers) instead of this one.
operationId: getMultiplePublishersAccounts
parameters:
- name: publisherIds
in: path
description: Comma separated unique Publisher IDs.
required: true
schema:
type: string
pattern: '^[0-9]+(,[0-9]+)*$'
examples:
- '99990,99991'
examples:
default:
value: '99990,99991'
responses:
'200':
description: Response 200
content:
application/json:
schema:
$ref: '#/components/schemas/MultiplePublishersAccounts'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
deprecated: true
security:
- apiKey: []
servers:
- url: 'https://apis.creatoriq.com'
description: Live
'/crm/v1/api/publisher/{publisherId}/accounts':
get:
tags:
- Publisher
summary: GET publisher's social accounts
description: Fetch the social account information for publisher
operationId: getPublisherAccounts
parameters:
- name: key
in: query
description: |
Specifies which identifier is used in the request.
Set to `id` if you are using the internal `id` field as identifier.
If you are using `PublisherId` as identifier(default behavior), this parameter should be omitted.
required: true
schema:
type: string
enum:
- Id
- PublisherId
examples:
- Id
examples:
default:
value: Id
- name: publisherId
in: path
description: Unique Publisher's ID
required: true
schema:
type: string
pattern: '^[0-9]+$'
examples:
- '9999'
examples:
default:
value: '9999'
responses:
'200':
description: Response 200
content:
application/json:
schema:
type: object
description: Publisher Accounts Collection
properties:
type:
type: string
description: Type of Search
examples:
- AccountCollection
href:
type: string
description: href
examples:
- 'https://apis.creatoriq.com/crm/v1/api/publisher/99999999999'
AccountCollection:
type: array
items:
$ref: '#/components/schemas/SocialAccountModel'
required:
- type
- href
- AccountCollection
'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:
- Publisher
summary: Add Publisher Social accounts information
description: Add Publisher Social accounts information
operationId: addPublisherSocialAccount
parameters:
- name: source
in: query
description: Type of input data ('link' or 'user')
required: true
schema:
type: string
enum:
- link
- user
examples:
- link
examples:
default:
value: link
- name: accountSource
in: query
description: Account source
required: false
schema:
type: string
examples:
- crm
examples:
default:
value: crm
- name: key
in: query
descript
# --- truncated at 32 KB (295 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/creatoriq/refs/heads/main/openapi/creatoriq-publishers-openapi.yml