marketix
LoginSign Up
  • Welcome!
  • Getting Started
  • Best Practices
  • Pricing
  • FAQ
  • Documents API
    • Documents: List
    • Documents: Show
    • Document: Store
    • Document: Update
Powered by GitBook
On this page
  1. Documents API

Documents: List

API endpoint:

GET

https://app.marketix.io/api/v1/documents

Request example:

curl --location --request GET 'https://app.marketix.io/api/v1/documents' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description

search

optional string

The search query.

search_by

optional string

Search by. Possible values are: name for Name, result for Result. Defaults to: name.

template_id

optional integer

Filter by template ID. Possible values are: 1 for Freestyle, 2 for About us, 3 for Advertisement, 4 for Article, 5 for Blog intro, 6 for Blog outline, 7 for Blog outro, 8 for Blog paragraph, 9 for Blog post, 10 for Blog section, 11 for Blog talking points, 12 for Blog title, 13 for Call to action, 14 for Content rewrite, 15 for Content summary, 16 for FAQ, 17 for Hashtags, 18 for Headline, 19 for How it works, 20 for Meta description, 21 for Meta keywords, 22 for Mission statement, 23 for Newsletter, 24 for Pain-Agitate-Solution, 25 for Paragraph, 26 for Press release, 27 for Social post, 28 for Social post caption, 29 for Startup ideas, 30 for Startup names, 31 for Subheadline, 32 for Testimonial, 33 for Tweet, 34 for Twitter thread, 35 for Value proposition, 36 for Video description, 37 for Video script, 38 for Video tags, 39 for Video title, 40 for Vision statement, 41 for Product sheet, 42 for Welcome email, 43 for Push notification, 44 for Blog listicle, 45 for Content grammar, 46 for Blog tags, 47 for Pros and cons, 48 for Google advertisement, 49 for Facebook advertisement, 50 for Job description, 51 for Review, 52 for Feature section. Defaults to: freestyle.

favorite

optional boolean

Filter by favorite.

sort_by

optional string

Sort by. Possible values are: id for Date created, name for Name. Defaults to: id.

sort

optional string

Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.

per_page

optional int

Results per page. Possible values are: 10, 25, 50, 100. Defaults to: 10.

PreviousDocuments APINextDocuments: Show

Last updated 2 years ago