openapi: 3.0.3 info: title: 'Followr API Documentation' description: '' version: 1.0.0 servers: - url: 'https://app.followr.ai' tags: - name: Company description: "\nActions related to *Company* model.\n\n## Company Resource\n### Attributes\n- `id`: integer Local identifier in Company model\n- `type`: string Company type (company, individual)\n- `name`: string Company name\n- `description`: string Company description\n- `country_iso_code`: string Company country iso code\n- `language_iso_code`: string Company language iso code\n- `language`: string Company language\n- `language_types`: array Company language types\n- `interests`: array Company interests\n- `audience_types`: array Company audience types\n- `audience_ages`: array Company audience ages\n- `audience_genders`: array Company audience genders\n- `website`: string Company website\n- `palettes`: array Company palettes\n- `tones`: array Company tones\n- `emotions`: array Company emotions\n- `syntaxes`: array Company syntaxes\n- `characters`: array Company characters\n- `fonts`: array Company fonts\n- `social_network_prompts`: array Company social network prompts\n- `ai_image_styles`: array Company ai image styles\n- `ai_preferences`: array Company ai preferences\n- `ai_keys`: array Company ai keys\n- `webhook_posts_url`: string Company webhook posts url\n\n### Relations\n- `image`: [Image](#image)\n- `role`: [Role](#role)\n- `users`: array of [User](#user)\n." - name: Post description: "\nActions related to *Post* model.\n\n## Post Resource\n### Attributes\n- `id`: integer Local identifier in Post model\n- `social_network_type`: string Post social network type (facebook twitter, instagram, threads, linkedin, tiktok, discord, medium, pinterest, youtube, canva)\n- `title`: string Post title\n- `description`: string Post description\n- `status`: string Post status\n- `status_message`: json Post status message\n- `external_id`: string Post external id\n- `link`: string Post link\n- `published_at`: datetime Post published at\n- `preferences`: json Post preferences\n- `comments_to_create`: json Post comments to create\n\n### Relations\n- `user`: [User](#user)\n- `group`: [PostGroup](#postgroup)\n- `cover`: [File](#file)\n- `assets`: array of [Asset](#asset)\n- `comments`: array of [Comment](#comment)\n- `internalComments`: array of [InternalComment](#internalcomment)\n." - name: PostGroup description: "\nActions related to *PostGroup* model.\n\n## PostGroup Resource\n### Attributes\n- `id`: integer Local identifier in PostGroup model\n- `title`: string PostGroup title\n- `topic`: string PostGroup topic\n- `draft`: boolean PostGroup draft\n- `auto_publish`: boolean PostGroup auto publish\n- `publish_at`: datetime PostGroup publish at\n\n### Relations\n- `user`: [User](#user)\n- `company`: [Company](#company)\n- `ruleGroup`: [RuleGroup](#rulegroup)\n- `posts`: array of [Post](#post)\n- `tags`: [Tag](#tag)\n- `internalComments`: array of [InternalComment](#internalcomment)\n." - name: 'Subscription Limit' description: "\nActions related to *Subscription Limit* model.\n\n## Subscription Limit Resource\n### Attributes\n- `id`: integer Local identifier in Subscription Limit model\n- `company_id`: integer Company identifier\n- `user_id`: integer User identifier ~nullable, when set, the subscription limit is for a specific user if not set, the subscription limit is for all users of the company~\n- `users_amount`: integer Users amount\n- `words_amount`: integer Words amount\n- `images_amount`: integer Images amount\n- `premium_images_amount`: integer Premium images amount\n- `bytes_amount`: integer Bytes amount\n\n### Relations\n- `company`: [Company](#company)\n- `user`: [User](#user) ~nullable, when set, the subscription limit is for a specific user~\n." - name: User description: "\nActions related to *User* model.\n\n## User Resource\n### Attributes\n- `id`: integer Local identifier in User model\n- `name`: string User name\n- `email`: string User email\n- `language`: string User language\n- `timezone`: string User timezone\n\n### Relations\n- `image`: [File](#file)\n." components: securitySchemes: default: type: http scheme: bearer description: 'You can retrieve your token by visiting your dashboard and clicking Generate API token.' security: - default: [] paths: /api/companies: get: summary: 'GET api/companies' operationId: gETApicompanies description: 'Return the list of companies' parameters: - in: query name: include description: 'additional relations to include in response, separated by semi-colon.' example: image.thumbnail required: false schema: type: string description: 'additional relations to include in response, separated by semi-colon.' example: image.thumbnail nullable: false - in: query name: 'filter[id]' description: 'filter by id' example: consequatur required: false schema: type: string description: 'filter by id' example: consequatur nullable: false - in: query name: 'filter[type]' description: 'filter by type (company, individual)' example: consequatur required: false schema: type: string description: 'filter by type (company, individual)' example: consequatur nullable: false - in: query name: 'filter[name]' description: 'filter by name' example: consequatur required: false schema: type: string description: 'filter by name' example: consequatur nullable: false - in: query name: 'filter[user_id]' description: 'filter by user id' example: consequatur required: false schema: type: string description: 'filter by user id' example: consequatur nullable: false - in: query name: 'filter[country_iso_code]' description: 'filter by country iso code' example: 17 required: false schema: type: integer description: 'filter by country iso code' example: 17 nullable: false - in: query name: 'filter[language_iso_code]' description: 'filter by language iso code' example: consequatur required: false schema: type: string description: 'filter by language iso code' example: consequatur nullable: false - in: query name: sort description: 'sort by field.' example: 'id, -id, name, -name, created_at, -created_at' required: false schema: type: string description: 'sort by field.' example: 'id, -id, name, -name, created_at, -created_at' nullable: false - in: query name: 'page[number]' description: 'page number.' example: 1 required: false schema: type: integer description: 'page number.' example: 1 nullable: false - in: query name: 'page[size]' description: 'items per page (default 30).' example: 10 required: false schema: type: integer description: 'items per page (default 30).' example: 10 nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 120 user_id: 271 type: company name: Mueller-Dibbert description: 'Dolores minus voluptatem quisquam quibusdam sed vel a.' country_iso_code: MU language_iso_code: es language: sg language_types: null interests: null tones: null emotions: null syntaxes: null characters: null fonts: null audience_types: null audience_ages: null audience_genders: null website: null palettes: null social_network_prompts: null ai_image_styles: null ai_preferences: null ai_keys: null webhook_secret: null webhook_posts_url: null created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' disabled_at: null user: id: 271 name: 'Mrs. Audra Nolan' email: kunde.eloisa@example.com referral_code: XHLUPT language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' - id: 121 user_id: 272 type: company name: 'Douglas Group' description: 'Perferendis voluptatibus incidunt nostrum quia possimus.' country_iso_code: MF language_iso_code: ve language: lb language_types: null interests: null tones: null emotions: null syntaxes: null characters: null fonts: null audience_types: null audience_ages: null audience_genders: null website: null palettes: null social_network_prompts: null ai_image_styles: null ai_preferences: null ai_keys: null webhook_secret: null webhook_posts_url: null created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' disabled_at: null user: id: 272 name: 'Mona Morissette' email: ablanda@example.org referral_code: EKHH8J language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' properties: data: type: array example: - id: 120 user_id: 271 type: company name: Mueller-Dibbert description: 'Dolores minus voluptatem quisquam quibusdam sed vel a.' country_iso_code: MU language_iso_code: es language: sg language_types: null interests: null tones: null emotions: null syntaxes: null characters: null fonts: null audience_types: null audience_ages: null audience_genders: null website: null palettes: null social_network_prompts: null ai_image_styles: null ai_preferences: null ai_keys: null webhook_secret: null webhook_posts_url: null created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' disabled_at: null user: id: 271 name: 'Mrs. Audra Nolan' email: kunde.eloisa@example.com referral_code: XHLUPT language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' - id: 121 user_id: 272 type: company name: 'Douglas Group' description: 'Perferendis voluptatibus incidunt nostrum quia possimus.' country_iso_code: MF language_iso_code: ve language: lb language_types: null interests: null tones: null emotions: null syntaxes: null characters: null fonts: null audience_types: null audience_ages: null audience_genders: null website: null palettes: null social_network_prompts: null ai_image_styles: null ai_preferences: null ai_keys: null webhook_secret: null webhook_posts_url: null created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' disabled_at: null user: id: 272 name: 'Mona Morissette' email: ablanda@example.org referral_code: EKHH8J language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' items: type: object properties: id: type: integer example: 120 user_id: type: integer example: 271 type: type: string example: company name: type: string example: Mueller-Dibbert description: type: string example: 'Dolores minus voluptatem quisquam quibusdam sed vel a.' country_iso_code: type: string example: MU language_iso_code: type: string example: es language: type: string example: sg language_types: type: string example: null interests: type: string example: null tones: type: string example: null emotions: type: string example: null syntaxes: type: string example: null characters: type: string example: null fonts: type: string example: null audience_types: type: string example: null audience_ages: type: string example: null audience_genders: type: string example: null website: type: string example: null palettes: type: string example: null social_network_prompts: type: string example: null ai_image_styles: type: string example: null ai_preferences: type: string example: null ai_keys: type: string example: null webhook_secret: type: string example: null webhook_posts_url: type: string example: null created_at: type: string example: '2025-09-18T23:53:42.000000Z' updated_at: type: string example: '2025-09-18T23:53:42.000000Z' disabled_at: type: string example: null user: type: object properties: id: type: integer example: 271 name: type: string example: 'Mrs. Audra Nolan' email: type: string example: kunde.eloisa@example.com referral_code: type: string example: XHLUPT language: type: string example: null timezone: type: string example: null notification_settings: type: string example: null credits: type: integer example: 0 pm_type: type: string example: null pm_last_four: type: string example: null cancel_reason: type: string example: null referrer_url: type: string example: null land_url: type: string example: null has_password: type: boolean example: true created_at: type: string example: '2025-09-18T23:53:42.000000Z' updated_at: type: string example: '2025-09-18T23:53:42.000000Z' banned_at: type: string example: null password_changed_at: type: string example: '2025-09-18T23:53:42.000000Z' tags: - Company post: summary: 'POST api/companies' operationId: pOSTApicompanies description: 'Create a new company' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 123 user_id: 274 type: individual name: 'Reynolds Inc' description: 'Quo sed fugit facilis perferendis dolores molestias ipsam sit.' country_iso_code: SI language_iso_code: en language: sr language_types: null interests: null tones: null emotions: null syntaxes: null characters: null fonts: null audience_types: null audience_ages: null audience_genders: null website: null palettes: null social_network_prompts: null ai_image_styles: null ai_preferences: null ai_keys: null webhook_secret: null webhook_posts_url: null created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' disabled_at: null user: id: 274 name: 'Damien Murazik' email: macejkovic.kacie@example.org referral_code: CYMJR2 language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' properties: data: type: object properties: id: type: integer example: 123 user_id: type: integer example: 274 type: type: string example: individual name: type: string example: 'Reynolds Inc' description: type: string example: 'Quo sed fugit facilis perferendis dolores molestias ipsam sit.' country_iso_code: type: string example: SI language_iso_code: type: string example: en language: type: string example: sr language_types: type: string example: null interests: type: string example: null tones: type: string example: null emotions: type: string example: null syntaxes: type: string example: null characters: type: string example: null fonts: type: string example: null audience_types: type: string example: null audience_ages: type: string example: null audience_genders: type: string example: null website: type: string example: null palettes: type: string example: null social_network_prompts: type: string example: null ai_image_styles: type: string example: null ai_preferences: type: string example: null ai_keys: type: string example: null webhook_secret: type: string example: null webhook_posts_url: type: string example: null created_at: type: string example: '2025-09-18T23:53:42.000000Z' updated_at: type: string example: '2025-09-18T23:53:42.000000Z' disabled_at: type: string example: null user: type: object properties: id: type: integer example: 274 name: type: string example: 'Damien Murazik' email: type: string example: macejkovic.kacie@example.org referral_code: type: string example: CYMJR2 language: type: string example: null timezone: type: string example: null notification_settings: type: string example: null credits: type: integer example: 0 pm_type: type: string example: null pm_last_four: type: string example: null cancel_reason: type: string example: null referrer_url: type: string example: null land_url: type: string example: null has_password: type: boolean example: true created_at: type: string example: '2025-09-18T23:53:42.000000Z' updated_at: type: string example: '2025-09-18T23:53:42.000000Z' banned_at: type: string example: null password_changed_at: type: string example: '2025-09-18T23:53:42.000000Z' tags: - Company requestBody: required: false content: application/json: schema: type: object properties: type: type: The description: 'type of the company (company, individual)' example: consequatur nullable: false name: type: The description: 'name of the company' example: consequatur nullable: false description: type: The description: 'description of the company' example: 'Dolores dolorum amet iste laborum eius est dolor.' nullable: false country_iso_code: type: The description: 'country iso code of the company' example: consequatur nullable: false language_iso_code: type: The description: 'language iso code of the company' example: consequatur nullable: false language: type: The description: 'language of the company' example: consequatur nullable: false language_types: type: The description: 'language types of the company' example: consequatur nullable: false interests: type: The description: 'interests of the company' example: consequatur nullable: false audience_types: type: The description: 'audience types of the company' example: consequatur nullable: false audience_ages: type: The description: 'audience ages of the company' example: consequatur nullable: false audience_genders: type: The description: 'audience genders of the company' example: consequatur nullable: false website: type: The description: 'website of the company' example: consequatur nullable: false palettes: type: The description: 'palettes of the company' example: consequatur nullable: false tones: type: The description: 'tones of the company' example: consequatur nullable: false emotions: type: The description: 'emotions of the company' example: consequatur nullable: false syntaxes: type: The description: 'syntaxes of the company' example: consequatur nullable: false characters: type: The description: 'characters of the company' example: consequatur nullable: false fonts: type: The description: 'fonts of the company' example: consequatur nullable: false vista_template_ids: type: The description: 'vista template ids of the company' example: consequatur nullable: false ai_image_styles: type: The description: 'ai image styles of the company' example: consequatur nullable: false ai_preferences: type: The description: 'ai preferences of the company' example: consequatur nullable: false ai_keys: type: The description: 'ai keys of the company' example: consequatur nullable: false webhook_posts_url: type: The description: 'webhook posts url of the company' example: 'http://kunze.biz/iste-laborum-eius-est-dolor.html' nullable: true social_network_prompts: type: The description: 'social network prompts of the company' example: consequatur nullable: false '/api/companies/{id}': get: summary: 'GET api/companies/{id}' operationId: gETApicompaniesid description: 'Return the company' parameters: - in: query name: include description: 'additional relations to include in response, separated by semi-colon.' example: image.thumbnail required: false schema: type: string description: 'additional relations to include in response, separated by semi-colon.' example: image.thumbnail nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: id: 122 user_id: 273 type: company name: Lakin-Hahn description: 'Natus earum quas dignissimos perferendis.' country_iso_code: FK language_iso_code: en language: nl language_types: null interests: null tones: null emotions: null syntaxes: null characters: null fonts: null audience_types: null audience_ages: null audience_genders: null website: null palettes: null social_network_prompts: null ai_image_styles: null ai_preferences: null ai_keys: null webhook_secret: null webhook_posts_url: null created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' disabled_at: null user: id: 273 name: 'Ms. Edyth Cartwright DDS' email: lola88@example.com referral_code: SXIYGD language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' properties: data: type: object properties: id: type: integer example: 122 user_id: type: integer example: 273 type: type: string example: company name: type: string example: Lakin-Hahn description: type: string example: 'Natus earum quas dignissimos perferendis.' country_iso_code: type: string example: FK language_iso_code: type: string example: en language: type: string example: nl language_types: type: string example: null interests: type: string example: null tones: type: string example: null emotions: type: string example: null syntaxes: type: string example: null characters: type: string example: null fonts: type: string example: null audience_types: type: string example: null audience_ages: type: string example: null audience_genders: type: string example: null website: type: string example: null palettes: type: string example: null social_network_prompts: type: string example: null ai_image_styles: type: string example: null ai_preferences: type: string example: null ai_keys: type: string example: null webhook_secret: type: string example: null webhook_posts_url: type: string example: null created_at: type: string example: '2025-09-18T23:53:42.000000Z' updated_at: type: string example: '2025-09-18T23:53:42.000000Z' disabled_at: type: string example: null user: type: object properties: id: type: integer example: 273 name: type: string example: 'Ms. Edyth Cartwright DDS' email: type: string example: lola88@example.com referral_code: type: string example: SXIYGD language: type: string example: null timezone: type: string example: null notification_settings: type: string example: null credits: type: integer example: 0 pm_type: type: string example: null pm_last_four: type: string example: null cancel_reason: type: string example: null referrer_url: type: string example: null land_url: type: string example: null has_password: type: boolean example: true created_at: type: string example: '2025-09-18T23:53:42.000000Z' updated_at: type: string example: '2025-09-18T23:53:42.000000Z' banned_at: type: string example: null password_changed_at: type: string example: '2025-09-18T23:53:42.000000Z' tags: - Company put: summary: 'PUT api/companies/{id}' operationId: pUTApicompaniesid description: 'Update the company' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 124 user_id: 275 type: company name: Mueller-Dibbert description: 'Dolores minus voluptatem quisquam quibusdam sed vel a.' country_iso_code: MU language_iso_code: es language: sg language_types: null interests: null tones: null emotions: null syntaxes: null characters: null fonts: null audience_types: null audience_ages: null audience_genders: null website: null palettes: null social_network_prompts: null ai_image_styles: null ai_preferences: null ai_keys: null webhook_secret: null webhook_posts_url: null created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' disabled_at: null user: id: 275 name: 'Mrs. Audra Nolan' email: lennie.boyle@example.org referral_code: 6BYPFV language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' properties: data: type: object properties: id: type: integer example: 124 user_id: type: integer example: 275 type: type: string example: company name: type: string example: Mueller-Dibbert description: type: string example: 'Dolores minus voluptatem quisquam quibusdam sed vel a.' country_iso_code: type: string example: MU language_iso_code: type: string example: es language: type: string example: sg language_types: type: string example: null interests: type: string example: null tones: type: string example: null emotions: type: string example: null syntaxes: type: string example: null characters: type: string example: null fonts: type: string example: null audience_types: type: string example: null audience_ages: type: string example: null audience_genders: type: string example: null website: type: string example: null palettes: type: string example: null social_network_prompts: type: string example: null ai_image_styles: type: string example: null ai_preferences: type: string example: null ai_keys: type: string example: null webhook_secret: type: string example: null webhook_posts_url: type: string example: null created_at: type: string example: '2025-09-18T23:53:42.000000Z' updated_at: type: string example: '2025-09-18T23:53:42.000000Z' disabled_at: type: string example: null user: type: object properties: id: type: integer example: 275 name: type: string example: 'Mrs. Audra Nolan' email: type: string example: lennie.boyle@example.org referral_code: type: string example: 6BYPFV language: type: string example: null timezone: type: string example: null notification_settings: type: string example: null credits: type: integer example: 0 pm_type: type: string example: null pm_last_four: type: string example: null cancel_reason: type: string example: null referrer_url: type: string example: null land_url: type: string example: null has_password: type: boolean example: true created_at: type: string example: '2025-09-18T23:53:42.000000Z' updated_at: type: string example: '2025-09-18T23:53:42.000000Z' banned_at: type: string example: null password_changed_at: type: string example: '2025-09-18T23:53:42.000000Z' tags: - Company requestBody: required: false content: application/json: schema: type: object properties: type: type: The description: 'type of the company (company, individual)' example: consequatur nullable: false name: type: The description: 'name of the company' example: consequatur nullable: false description: type: The description: 'description of the company' example: 'Dolores dolorum amet iste laborum eius est dolor.' nullable: false country_iso_code: type: The description: 'country iso code of the company' example: consequatur nullable: false language_iso_code: type: The description: 'language iso code of the company' example: consequatur nullable: false language: type: The description: 'language of the company' example: consequatur nullable: false language_types: type: The description: 'language types of the company' example: consequatur nullable: false interests: type: The description: 'interests of the company' example: consequatur nullable: false audience_types: type: The description: 'audience types of the company' example: consequatur nullable: false audience_ages: type: The description: 'audience ages of the company' example: consequatur nullable: false audience_genders: type: The description: 'audience genders of the company' example: consequatur nullable: false website: type: The description: 'website of the company' example: consequatur nullable: false palettes: type: The description: 'palettes of the company' example: consequatur nullable: false tones: type: The description: 'tones of the company' example: consequatur nullable: false emotions: type: The description: 'emotions of the company' example: consequatur nullable: false syntaxes: type: The description: 'syntaxes of the company' example: consequatur nullable: false characters: type: The description: 'characters of the company' example: consequatur nullable: false fonts: type: The description: 'fonts of the company' example: consequatur nullable: false vista_template_ids: type: The description: 'vista template ids of the company' example: consequatur nullable: false social_network_prompts: type: The description: 'social network prompts of the company' example: consequatur nullable: false ai_image_styles: type: The description: 'ai image styles of the company' example: consequatur nullable: false ai_preferences: type: The description: 'ai preferences of the company' example: consequatur nullable: false ai_keys: type: The description: 'ai keys of the company' example: consequatur nullable: false webhook_posts_url: type: The description: 'webhook posts url of the company' example: 'http://kunze.biz/iste-laborum-eius-est-dolor.html' nullable: true disable: type: If description: 'the company is disabled' example: consequatur nullable: false delete: summary: 'DELETE api/companies/{id}' operationId: dELETEApicompaniesid description: 'Delete the company' parameters: [] responses: 204: description: '' tags: - Company parameters: - in: path name: id description: 'Optional parameter. The ID of the user' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: consequatur /api/posts: get: summary: 'GET api/posts' operationId: gETApiposts description: 'Return the list of posts' parameters: - in: query name: 'filter[title]' description: 'filter by title' example: consequatur required: false schema: type: string description: 'filter by title' example: consequatur nullable: false - in: query name: 'filter[description]' description: 'filter by description' example: consequatur required: false schema: type: string description: 'filter by description' example: consequatur nullable: false - in: query name: 'filter[group.company_id]' description: 'filter by company id' example: consequatur required: false schema: type: string description: 'filter by company id' example: consequatur nullable: false - in: query name: 'filter[user_id]' description: 'filter by user id' example: consequatur required: false schema: type: string description: 'filter by user id' example: consequatur nullable: false - in: query name: 'filter[social_network_type]' description: 'filter by social network type' example: consequatur required: false schema: type: string description: 'filter by social network type' example: consequatur nullable: false - in: query name: 'filter[external_id]' description: 'filter by external id' example: consequatur required: false schema: type: string description: 'filter by external id' example: consequatur nullable: false - in: query name: 'filter[link]' description: 'filter by link' example: consequatur required: false schema: type: string description: 'filter by link' example: consequatur nullable: false - in: query name: 'filter[status]' description: 'filter by status' example: consequatur required: false schema: type: string description: 'filter by status' example: consequatur nullable: false - in: query name: include description: 'additional relations to include in response, separated by semi-colon.' example: user.image.thumbnail required: false schema: type: string description: 'additional relations to include in response, separated by semi-colon.' example: user.image.thumbnail nullable: false - in: query name: sort description: 'sort by field.' example: 'id, -id, title, -title, status, -status, created_at, -created_at, published_at, -published_at' required: false schema: type: string description: 'sort by field.' example: 'id, -id, title, -title, status, -status, created_at, -created_at, published_at, -published_at' nullable: false - in: query name: 'page[number]' description: 'page number.' example: 1 required: false schema: type: integer description: 'page number.' example: 1 nullable: false - in: query name: 'page[size]' description: 'items per page (default 30).' example: 10 required: false schema: type: integer description: 'items per page (default 30).' example: 10 nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 4 social_network_type: linkedin title: 'Amet iste laborum eius est dolor dolores.' description: 'Voluptatem quisquam quibusdam sed vel a quo sed.' status: pending status_message: null external_id: e1062c55-7a55-3291-9268-21343a4e4d6a link: 'https://www.lakin.com/veniam-sed-fuga-aspernatur-natus-earum' preferences: null comments_to_create: null created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' published_at: '1998-01-11T17:45:56.000000Z' group: id: 44 title: 'Id totam temporibus quia ipsam ut.' topic: null draft: true auto_publish: true created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' publish_at: '2018-06-04T17:43:31.000000Z' - id: 5 social_network_type: instagram title: 'Quos ea rerum repudiandae est.' description: 'Et voluptas consequatur delectus autem.' status: published status_message: null external_id: 873e5f5f-9cbf-3925-b8f6-bd692f274a17 link: 'http://www.bernhard.com/a-debitis-autem-eveniet-quis-labore-vel' preferences: null comments_to_create: null created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' published_at: '1990-12-01T11:43:53.000000Z' group: id: 45 title: 'Voluptatibus nihil aut nisi officiis rerum id tempore.' topic: null draft: true auto_publish: true created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' publish_at: '1996-04-11T17:16:58.000000Z' properties: data: type: array example: - id: 4 social_network_type: linkedin title: 'Amet iste laborum eius est dolor dolores.' description: 'Voluptatem quisquam quibusdam sed vel a quo sed.' status: pending status_message: null external_id: e1062c55-7a55-3291-9268-21343a4e4d6a link: 'https://www.lakin.com/veniam-sed-fuga-aspernatur-natus-earum' preferences: null comments_to_create: null created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' published_at: '1998-01-11T17:45:56.000000Z' group: id: 44 title: 'Id totam temporibus quia ipsam ut.' topic: null draft: true auto_publish: true created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' publish_at: '2018-06-04T17:43:31.000000Z' - id: 5 social_network_type: instagram title: 'Quos ea rerum repudiandae est.' description: 'Et voluptas consequatur delectus autem.' status: published status_message: null external_id: 873e5f5f-9cbf-3925-b8f6-bd692f274a17 link: 'http://www.bernhard.com/a-debitis-autem-eveniet-quis-labore-vel' preferences: null comments_to_create: null created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' published_at: '1990-12-01T11:43:53.000000Z' group: id: 45 title: 'Voluptatibus nihil aut nisi officiis rerum id tempore.' topic: null draft: true auto_publish: true created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' publish_at: '1996-04-11T17:16:58.000000Z' items: type: object properties: id: type: integer example: 4 social_network_type: type: string example: linkedin title: type: string example: 'Amet iste laborum eius est dolor dolores.' description: type: string example: 'Voluptatem quisquam quibusdam sed vel a quo sed.' status: type: string example: pending status_message: type: string example: null external_id: type: string example: e1062c55-7a55-3291-9268-21343a4e4d6a link: type: string example: 'https://www.lakin.com/veniam-sed-fuga-aspernatur-natus-earum' preferences: type: string example: null comments_to_create: type: string example: null created_at: type: string example: '2025-09-18T23:53:44.000000Z' updated_at: type: string example: '2025-09-18T23:53:44.000000Z' published_at: type: string example: '1998-01-11T17:45:56.000000Z' group: type: object properties: id: type: integer example: 44 title: type: string example: 'Id totam temporibus quia ipsam ut.' topic: type: string example: null draft: type: boolean example: true auto_publish: type: boolean example: true created_at: type: string example: '2025-09-18T23:53:44.000000Z' updated_at: type: string example: '2025-09-18T23:53:44.000000Z' publish_at: type: string example: '2018-06-04T17:43:31.000000Z' tags: - Post '/api/postGroups/{post_group_id}/posts': get: summary: 'GET api/postGroups/{postGroupId}/posts' operationId: gETApipostGroupspostGroupIdposts description: 'Return the list of posts by post group' parameters: - in: query name: 'filter[title]' description: 'filter by title' example: consequatur required: false schema: type: string description: 'filter by title' example: consequatur nullable: false - in: query name: 'filter[description]' description: 'filter by description' example: consequatur required: false schema: type: string description: 'filter by description' example: consequatur nullable: false - in: query name: 'filter[group.company_id]' description: 'filter by company id' example: consequatur required: false schema: type: string description: 'filter by company id' example: consequatur nullable: false - in: query name: 'filter[user_id]' description: 'filter by user id' example: consequatur required: false schema: type: string description: 'filter by user id' example: consequatur nullable: false - in: query name: 'filter[social_network_type]' description: 'filter by social network type' example: consequatur required: false schema: type: string description: 'filter by social network type' example: consequatur nullable: false - in: query name: 'filter[external_id]' description: 'filter by external id' example: consequatur required: false schema: type: string description: 'filter by external id' example: consequatur nullable: false - in: query name: 'filter[link]' description: 'filter by link' example: consequatur required: false schema: type: string description: 'filter by link' example: consequatur nullable: false - in: query name: 'filter[status]' description: 'filter by status' example: consequatur required: false schema: type: string description: 'filter by status' example: consequatur nullable: false - in: query name: include description: 'additional relations to include in response, separated by semi-colon.' example: user.image.thumbnail required: false schema: type: string description: 'additional relations to include in response, separated by semi-colon.' example: user.image.thumbnail nullable: false - in: query name: sort description: 'sort by field.' example: 'id, -id, title, -title, status, -status, created_at, -created_at, published_at, -published_at' required: false schema: type: string description: 'sort by field.' example: 'id, -id, title, -title, status, -status, created_at, -created_at, published_at, -published_at' nullable: false - in: query name: 'page[number]' description: 'page number.' example: 1 required: false schema: type: integer description: 'page number.' example: 1 nullable: false - in: query name: 'page[size]' description: 'items per page (default 30).' example: 10 required: false schema: type: integer description: 'items per page (default 30).' example: 10 nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 6 social_network_type: linkedin title: 'Amet iste laborum eius est dolor dolores.' description: 'Voluptatem quisquam quibusdam sed vel a quo sed.' status: pending status_message: null external_id: e1062c55-7a55-3291-9268-21343a4e4d6a link: 'https://www.lakin.com/veniam-sed-fuga-aspernatur-natus-earum' preferences: null comments_to_create: null created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' published_at: '1998-01-11T17:45:56.000000Z' group: id: 46 title: 'Ut iusto iusto accusamus iusto similique.' topic: null draft: true auto_publish: false created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' publish_at: '2023-04-25T11:43:19.000000Z' - id: 7 social_network_type: youtube title: 'Est nostrum et voluptas consequatur delectus autem nam sunt.' description: 'Quia et perferendis fuga a debitis autem.' status: error status_message: null external_id: 3ae81d83-3bd0-388d-915d-80f03de156d5 link: 'http://www.hintz.com/quibusdam-et-eum-repellendus-illo-dolorum-omnis-repellendus-voluptatibus' preferences: null comments_to_create: null created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' published_at: '2009-03-26T13:22:36.000000Z' group: id: 47 title: 'Odit aut voluptas quasi ut.' topic: null draft: false auto_publish: false created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' publish_at: '2024-08-04T17:33:24.000000Z' properties: data: type: array example: - id: 6 social_network_type: linkedin title: 'Amet iste laborum eius est dolor dolores.' description: 'Voluptatem quisquam quibusdam sed vel a quo sed.' status: pending status_message: null external_id: e1062c55-7a55-3291-9268-21343a4e4d6a link: 'https://www.lakin.com/veniam-sed-fuga-aspernatur-natus-earum' preferences: null comments_to_create: null created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' published_at: '1998-01-11T17:45:56.000000Z' group: id: 46 title: 'Ut iusto iusto accusamus iusto similique.' topic: null draft: true auto_publish: false created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' publish_at: '2023-04-25T11:43:19.000000Z' - id: 7 social_network_type: youtube title: 'Est nostrum et voluptas consequatur delectus autem nam sunt.' description: 'Quia et perferendis fuga a debitis autem.' status: error status_message: null external_id: 3ae81d83-3bd0-388d-915d-80f03de156d5 link: 'http://www.hintz.com/quibusdam-et-eum-repellendus-illo-dolorum-omnis-repellendus-voluptatibus' preferences: null comments_to_create: null created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' published_at: '2009-03-26T13:22:36.000000Z' group: id: 47 title: 'Odit aut voluptas quasi ut.' topic: null draft: false auto_publish: false created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' publish_at: '2024-08-04T17:33:24.000000Z' items: type: object properties: id: type: integer example: 6 social_network_type: type: string example: linkedin title: type: string example: 'Amet iste laborum eius est dolor dolores.' description: type: string example: 'Voluptatem quisquam quibusdam sed vel a quo sed.' status: type: string example: pending status_message: type: string example: null external_id: type: string example: e1062c55-7a55-3291-9268-21343a4e4d6a link: type: string example: 'https://www.lakin.com/veniam-sed-fuga-aspernatur-natus-earum' preferences: type: string example: null comments_to_create: type: string example: null created_at: type: string example: '2025-09-18T23:53:44.000000Z' updated_at: type: string example: '2025-09-18T23:53:44.000000Z' published_at: type: string example: '1998-01-11T17:45:56.000000Z' group: type: object properties: id: type: integer example: 46 title: type: string example: 'Ut iusto iusto accusamus iusto similique.' topic: type: string example: null draft: type: boolean example: true auto_publish: type: boolean example: false created_at: type: string example: '2025-09-18T23:53:44.000000Z' updated_at: type: string example: '2025-09-18T23:53:44.000000Z' publish_at: type: string example: '2023-04-25T11:43:19.000000Z' tags: - Post post: summary: 'POST api/postGroups/{postGroupId}/posts' operationId: pOSTApipostGroupspostGroupIdposts description: 'Create a new post' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 9 social_network_type: linkedin title: 'Amet iste laborum eius est dolor dolores.' description: 'Voluptatem quisquam quibusdam sed vel a quo sed.' status: pending status_message: null external_id: e1062c55-7a55-3291-9268-21343a4e4d6a link: 'https://www.lakin.com/veniam-sed-fuga-aspernatur-natus-earum' preferences: null comments_to_create: null created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' published_at: '1998-01-11T17:45:56.000000Z' group: id: 49 title: 'Ex dicta hic inventore asperiores illum est.' topic: null draft: true auto_publish: false created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' publish_at: '1987-12-02T03:46:14.000000Z' properties: data: type: object properties: id: type: integer example: 9 social_network_type: type: string example: linkedin title: type: string example: 'Amet iste laborum eius est dolor dolores.' description: type: string example: 'Voluptatem quisquam quibusdam sed vel a quo sed.' status: type: string example: pending status_message: type: string example: null external_id: type: string example: e1062c55-7a55-3291-9268-21343a4e4d6a link: type: string example: 'https://www.lakin.com/veniam-sed-fuga-aspernatur-natus-earum' preferences: type: string example: null comments_to_create: type: string example: null created_at: type: string example: '2025-09-18T23:53:44.000000Z' updated_at: type: string example: '2025-09-18T23:53:44.000000Z' published_at: type: string example: '1998-01-11T17:45:56.000000Z' group: type: object properties: id: type: integer example: 49 title: type: string example: 'Ex dicta hic inventore asperiores illum est.' topic: type: string example: null draft: type: boolean example: true auto_publish: type: boolean example: false created_at: type: string example: '2025-09-18T23:53:44.000000Z' updated_at: type: string example: '2025-09-18T23:53:44.000000Z' publish_at: type: string example: '1987-12-02T03:46:14.000000Z' tags: - Post requestBody: required: false content: application/json: schema: type: object properties: social_network_type: type: required description: 'The social network type of the post (facebook twitter, instagram, threads, linkedin, tiktok, discord, medium, pinterest, youtube, canva)' example: consequatur nullable: false title: type: required description: 'The title of the post' example: consequatur nullable: true description: type: The description: 'description of the post' example: 'Dolores dolorum amet iste laborum eius est dolor.' nullable: false link: type: The description: 'link of the post' example: consequatur nullable: true assets_ids: type: The description: 'assets ids of the post' example: consequatur nullable: false preferences: type: object description: '' example: [] nullable: false properties: board_id: type: The description: 'board id of the post' example: consequatur nullable: true notify_followers: type: The description: 'notify followers of the post' example: consequatur nullable: false media_product_type: type: The description: 'media product type of the post' example: consequatur nullable: false disable_duet: type: The description: 'disable duet of the post' example: consequatur nullable: false disable_comment: type: The description: 'disable comment of the post' example: consequatur nullable: false disable_stitch: type: The description: 'disable stitch of the post' example: consequatur nullable: false brand_content_toggle: type: The description: 'brand content toggle of the post' example: consequatur nullable: false brand_organic_toggle: type: The description: 'brand organic toggle of the post' example: consequatur nullable: false privacy_level: type: The description: 'privacy level of the post' example: consequatur nullable: false video_cover_timestamp_ms: type: The description: 'video cover timestamp ms of the post' example: consequatur nullable: false category_id: type: The description: 'category id of the post' example: consequatur nullable: false playlist_id: type: The description: 'playlist id of the post' example: consequatur nullable: false tags: type: The description: 'tags of the post' example: consequatur nullable: false comments_to_create: type: The description: 'comments to create of the post' example: consequatur nullable: false parameters: - in: path name: post_group_id description: 'The ID of the post group.' example: 1 required: true schema: type: integer - in: path name: postGroupId description: 'Optional parameter. The ID of the post group' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: consequatur '/api/posts/{id}': get: summary: 'GET api/posts/{id}' operationId: gETApipostsid description: 'Return the post' parameters: - in: query name: include description: 'additional relations to include in response, separated by semi-colon.' example: user.image.thumbnail required: false schema: type: string description: 'additional relations to include in response, separated by semi-colon.' example: user.image.thumbnail nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: id: 8 social_network_type: linkedin title: 'Ipsam sit veniam sed fuga aspernatur natus.' description: 'Quas dignissimos perferendis voluptatibus incidunt nostrum quia possimus rerum.' status: published status_message: null external_id: 82bcef28-e633-3da0-8d78-f8d6e14eee9e link: 'http://www.adams.com/' preferences: null comments_to_create: null created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' published_at: '2018-11-13T05:22:36.000000Z' group: id: 48 title: 'Ducimus nihil laudantium nihil autem.' topic: null draft: false auto_publish: false created_at: '2025-09-18T23:53:44.000000Z' updated_at: '2025-09-18T23:53:44.000000Z' publish_at: '2021-07-13T01:15:03.000000Z' properties: data: type: object properties: id: type: integer example: 8 social_network_type: type: string example: linkedin title: type: string example: 'Ipsam sit veniam sed fuga aspernatur natus.' description: type: string example: 'Quas dignissimos perferendis voluptatibus incidunt nostrum quia possimus rerum.' status: type: string example: published status_message: type: string example: null external_id: type: string example: 82bcef28-e633-3da0-8d78-f8d6e14eee9e link: type: string example: 'http://www.adams.com/' preferences: type: string example: null comments_to_create: type: string example: null created_at: type: string example: '2025-09-18T23:53:44.000000Z' updated_at: type: string example: '2025-09-18T23:53:44.000000Z' published_at: type: string example: '2018-11-13T05:22:36.000000Z' group: type: object properties: id: type: integer example: 48 title: type: string example: 'Ducimus nihil laudantium nihil autem.' topic: type: string example: null draft: type: boolean example: false auto_publish: type: boolean example: false created_at: type: string example: '2025-09-18T23:53:44.000000Z' updated_at: type: string example: '2025-09-18T23:53:44.000000Z' publish_at: type: string example: '2021-07-13T01:15:03.000000Z' tags: - Post put: summary: 'POST api/posts/{id}' operationId: pOSTApipostsid description: 'Update the post' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 10 social_network_type: linkedin title: 'Amet iste laborum eius est dolor dolores.' description: 'Voluptatem quisquam quibusdam sed vel a quo sed.' status: pending status_message: null external_id: e1062c55-7a55-3291-9268-21343a4e4d6a link: 'https://www.lakin.com/veniam-sed-fuga-aspernatur-natus-earum' preferences: null comments_to_create: null created_at: '2025-09-18T23:53:45.000000Z' updated_at: '2025-09-18T23:53:45.000000Z' published_at: '1998-01-11T17:45:56.000000Z' group: id: 50 title: 'Illum est quae non quia dicta in aut provident.' topic: null draft: true auto_publish: false created_at: '2025-09-18T23:53:45.000000Z' updated_at: '2025-09-18T23:53:45.000000Z' publish_at: '1984-08-19T10:33:23.000000Z' properties: data: type: object properties: id: type: integer example: 10 social_network_type: type: string example: linkedin title: type: string example: 'Amet iste laborum eius est dolor dolores.' description: type: string example: 'Voluptatem quisquam quibusdam sed vel a quo sed.' status: type: string example: pending status_message: type: string example: null external_id: type: string example: e1062c55-7a55-3291-9268-21343a4e4d6a link: type: string example: 'https://www.lakin.com/veniam-sed-fuga-aspernatur-natus-earum' preferences: type: string example: null comments_to_create: type: string example: null created_at: type: string example: '2025-09-18T23:53:45.000000Z' updated_at: type: string example: '2025-09-18T23:53:45.000000Z' published_at: type: string example: '1998-01-11T17:45:56.000000Z' group: type: object properties: id: type: integer example: 50 title: type: string example: 'Illum est quae non quia dicta in aut provident.' topic: type: string example: null draft: type: boolean example: true auto_publish: type: boolean example: false created_at: type: string example: '2025-09-18T23:53:45.000000Z' updated_at: type: string example: '2025-09-18T23:53:45.000000Z' publish_at: type: string example: '1984-08-19T10:33:23.000000Z' tags: - Post requestBody: required: false content: application/json: schema: type: object properties: title: type: required description: 'The title of the post' example: consequatur nullable: true status: type: string description: '' example: null nullable: false description: type: The description: 'description of the post' example: 'Dolores dolorum amet iste laborum eius est dolor.' nullable: false link: type: The description: 'link of the post' example: consequatur nullable: true assets_ids: type: The description: 'assets ids of the post' example: consequatur nullable: false preferences: type: object description: '' example: [] nullable: false properties: board_id: type: The description: 'board id of the post' example: consequatur nullable: true notify_followers: type: The description: 'notify followers of the post' example: consequatur nullable: false media_product_type: type: The description: 'media product type of the post' example: consequatur nullable: false disable_duet: type: The description: 'disable duet of the post' example: consequatur nullable: false disable_comment: type: The description: 'disable comment of the post' example: consequatur nullable: false disable_stitch: type: The description: 'disable stitch of the post' example: consequatur nullable: false brand_content_toggle: type: The description: 'brand content toggle of the post' example: consequatur nullable: false brand_organic_toggle: type: The description: 'brand organic toggle of the post' example: consequatur nullable: false privacy_level: type: The description: 'privacy level of the post' example: consequatur nullable: false video_cover_timestamp_ms: type: The description: 'video cover timestamp ms of the post' example: consequatur nullable: false category_id: type: The description: 'category id of the post' example: consequatur nullable: false playlist_id: type: The description: 'playlist id of the post' example: consequatur nullable: false tags: type: The description: 'tags of the post' example: consequatur nullable: false comments_to_create: type: The description: 'comments to create of the post' example: consequatur nullable: false delete: summary: 'DELETE api/posts/{id}' operationId: dELETEApipostsid description: 'Delete the post' parameters: [] responses: 204: description: '' tags: - Post parameters: - in: path name: id description: 'Optional parameter. The ID of the post' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: consequatur /api/postGroups: get: summary: 'GET api/postGroups' operationId: gETApipostGroups description: 'Return the list of post groups' parameters: - in: query name: 'filter[draft]' description: 'filter by draft' example: consequatur required: false schema: type: string description: 'filter by draft' example: consequatur nullable: false - in: query name: 'filter[auto_publish]' description: 'filter by auto publish' example: consequatur required: false schema: type: string description: 'filter by auto publish' example: consequatur nullable: false - in: query name: 'filter[user_id]' description: 'filter by user id' example: consequatur required: false schema: type: string description: 'filter by user id' example: consequatur nullable: false - in: query name: 'filter[company_id]' description: 'filter by company id' example: consequatur required: false schema: type: string description: 'filter by company id' example: consequatur nullable: false - in: query name: 'filter[title]' description: 'filter by title' example: consequatur required: false schema: type: string description: 'filter by title' example: consequatur nullable: false - in: query name: 'filter[posts.social_network_type]' description: 'filter by social network type' example: consequatur required: false schema: type: string description: 'filter by social network type' example: consequatur nullable: false - in: query name: 'filter[description]' description: 'filter by description' example: consequatur required: false schema: type: string description: 'filter by description' example: consequatur nullable: false - in: query name: 'filter[tags.id]' description: 'filter by tag id' example: consequatur required: false schema: type: string description: 'filter by tag id' example: consequatur nullable: false - in: query name: include description: 'additional relations to include in response, separated by semi-colon.' example: user.image.thumbnail required: false schema: type: string description: 'additional relations to include in response, separated by semi-colon.' example: user.image.thumbnail nullable: false - in: query name: sort description: 'sort by field.' example: 'id, -id, title, -title, created_at, -created_at, publish_at, -publish_at' required: false schema: type: string description: 'sort by field.' example: 'id, -id, title, -title, created_at, -created_at, publish_at, -publish_at' nullable: false - in: query name: 'page[number]' description: 'page number.' example: 1 required: false schema: type: integer description: 'page number.' example: 1 nullable: false - in: query name: 'page[size]' description: 'items per page (default 30).' example: 10 required: false schema: type: integer description: 'items per page (default 30).' example: 10 nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 37 title: 'Dolorum amet iste laborum eius est dolor.' topic: null draft: true auto_publish: false created_at: '2025-09-18T23:53:43.000000Z' updated_at: '2025-09-18T23:53:43.000000Z' publish_at: '1978-05-24T11:04:41.000000Z' - id: 38 title: 'Rerum id et necessitatibus architecto aut consequatur debitis.' topic: null draft: true auto_publish: false created_at: '2025-09-18T23:53:43.000000Z' updated_at: '2025-09-18T23:53:43.000000Z' publish_at: '1989-03-24T10:32:03.000000Z' properties: data: type: array example: - id: 37 title: 'Dolorum amet iste laborum eius est dolor.' topic: null draft: true auto_publish: false created_at: '2025-09-18T23:53:43.000000Z' updated_at: '2025-09-18T23:53:43.000000Z' publish_at: '1978-05-24T11:04:41.000000Z' - id: 38 title: 'Rerum id et necessitatibus architecto aut consequatur debitis.' topic: null draft: true auto_publish: false created_at: '2025-09-18T23:53:43.000000Z' updated_at: '2025-09-18T23:53:43.000000Z' publish_at: '1989-03-24T10:32:03.000000Z' items: type: object properties: id: type: integer example: 37 title: type: string example: 'Dolorum amet iste laborum eius est dolor.' topic: type: string example: null draft: type: boolean example: true auto_publish: type: boolean example: false created_at: type: string example: '2025-09-18T23:53:43.000000Z' updated_at: type: string example: '2025-09-18T23:53:43.000000Z' publish_at: type: string example: '1978-05-24T11:04:41.000000Z' tags: - PostGroup '/api/companies/{company_id}/postGroups': get: summary: 'GET api/companies/{companyId}/postGroups' operationId: gETApicompaniescompanyIdpostGroups description: 'Return the list of post groups by company' parameters: - in: query name: 'filter[draft]' description: 'filter by draft' example: consequatur required: false schema: type: string description: 'filter by draft' example: consequatur nullable: false - in: query name: 'filter[auto_publish]' description: 'filter by auto publish' example: consequatur required: false schema: type: string description: 'filter by auto publish' example: consequatur nullable: false - in: query name: 'filter[user_id]' description: 'filter by user id' example: consequatur required: false schema: type: string description: 'filter by user id' example: consequatur nullable: false - in: query name: 'filter[company_id]' description: 'filter by company id' example: consequatur required: false schema: type: string description: 'filter by company id' example: consequatur nullable: false - in: query name: 'filter[title]' description: 'filter by title' example: consequatur required: false schema: type: string description: 'filter by title' example: consequatur nullable: false - in: query name: 'filter[posts.social_network_type]' description: 'filter by social network type' example: consequatur required: false schema: type: string description: 'filter by social network type' example: consequatur nullable: false - in: query name: 'filter[description]' description: 'filter by description' example: consequatur required: false schema: type: string description: 'filter by description' example: consequatur nullable: false - in: query name: 'filter[tags.id]' description: 'filter by tag id' example: consequatur required: false schema: type: string description: 'filter by tag id' example: consequatur nullable: false - in: query name: include description: 'additional relations to include in response, separated by semi-colon.' example: user.image.thumbnail required: false schema: type: string description: 'additional relations to include in response, separated by semi-colon.' example: user.image.thumbnail nullable: false - in: query name: sort description: 'sort by field.' example: 'id, -id, title, -title, created_at, -created_at, publish_at, -publish_at' required: false schema: type: string description: 'sort by field.' example: 'id, -id, title, -title, created_at, -created_at, publish_at, -publish_at' nullable: false - in: query name: 'page[number]' description: 'page number.' example: 1 required: false schema: type: integer description: 'page number.' example: 1 nullable: false - in: query name: 'page[size]' description: 'items per page (default 30).' example: 10 required: false schema: type: integer description: 'items per page (default 30).' example: 10 nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 39 title: 'Dolorum amet iste laborum eius est dolor.' topic: null draft: true auto_publish: false created_at: '2025-09-18T23:53:43.000000Z' updated_at: '2025-09-18T23:53:43.000000Z' publish_at: '1978-05-24T11:04:41.000000Z' - id: 40 title: 'Nisi qui id totam temporibus quia ipsam.' topic: null draft: false auto_publish: true created_at: '2025-09-18T23:53:43.000000Z' updated_at: '2025-09-18T23:53:43.000000Z' publish_at: '1994-04-04T00:13:36.000000Z' properties: data: type: array example: - id: 39 title: 'Dolorum amet iste laborum eius est dolor.' topic: null draft: true auto_publish: false created_at: '2025-09-18T23:53:43.000000Z' updated_at: '2025-09-18T23:53:43.000000Z' publish_at: '1978-05-24T11:04:41.000000Z' - id: 40 title: 'Nisi qui id totam temporibus quia ipsam.' topic: null draft: false auto_publish: true created_at: '2025-09-18T23:53:43.000000Z' updated_at: '2025-09-18T23:53:43.000000Z' publish_at: '1994-04-04T00:13:36.000000Z' items: type: object properties: id: type: integer example: 39 title: type: string example: 'Dolorum amet iste laborum eius est dolor.' topic: type: string example: null draft: type: boolean example: true auto_publish: type: boolean example: false created_at: type: string example: '2025-09-18T23:53:43.000000Z' updated_at: type: string example: '2025-09-18T23:53:43.000000Z' publish_at: type: string example: '1978-05-24T11:04:41.000000Z' tags: - PostGroup post: summary: 'POST api/postGroups' operationId: pOSTApipostGroups description: 'Create a new post group' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 42 title: 'Dolorum amet iste laborum eius est dolor.' topic: null draft: true auto_publish: false created_at: '2025-09-18T23:53:43.000000Z' updated_at: '2025-09-18T23:53:43.000000Z' publish_at: '1978-05-24T11:04:41.000000Z' properties: data: type: object properties: id: type: integer example: 42 title: type: string example: 'Dolorum amet iste laborum eius est dolor.' topic: type: string example: null draft: type: boolean example: true auto_publish: type: boolean example: false created_at: type: string example: '2025-09-18T23:53:43.000000Z' updated_at: type: string example: '2025-09-18T23:53:43.000000Z' publish_at: type: string example: '1978-05-24T11:04:41.000000Z' tags: - PostGroup requestBody: required: false content: application/json: schema: type: object properties: title: type: required description: 'The title of the post group' example: consequatur nullable: true draft: type: The description: 'draft of the post group' example: consequatur nullable: false auto_publish: type: The description: 'auto publish of the post group' example: consequatur nullable: false publish_at: type: The description: 'publish at of the post group' example: consequatur nullable: true tags_ids: type: The description: 'tags ids of the post group' example: consequatur nullable: false parameters: - in: path name: company_id description: 'The ID of the company.' example: 1 required: true schema: type: integer - in: path name: companyId description: 'Optional parameter. The ID of the company' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: consequatur '/api/postGroups/{id}': get: summary: 'GET api/postGroups/{id}' operationId: gETApipostGroupsid description: 'Return the post group' parameters: - in: query name: include description: 'additional relations to include in response, separated by semi-colon.' example: user.image.thumbnail required: false schema: type: string description: 'additional relations to include in response, separated by semi-colon.' example: user.image.thumbnail nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: id: 41 title: 'Molestias ipsam sit veniam sed fuga aspernatur.' topic: null draft: false auto_publish: false created_at: '2025-09-18T23:53:43.000000Z' updated_at: '2025-09-18T23:53:43.000000Z' publish_at: '1998-01-11T17:45:56.000000Z' properties: data: type: object properties: id: type: integer example: 41 title: type: string example: 'Molestias ipsam sit veniam sed fuga aspernatur.' topic: type: string example: null draft: type: boolean example: false auto_publish: type: boolean example: false created_at: type: string example: '2025-09-18T23:53:43.000000Z' updated_at: type: string example: '2025-09-18T23:53:43.000000Z' publish_at: type: string example: '1998-01-11T17:45:56.000000Z' tags: - PostGroup put: summary: 'PUT api/postGroups/{id}' operationId: pUTApipostGroupsid description: 'Update the post group' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 43 title: 'Dolorum amet iste laborum eius est dolor.' topic: null draft: true auto_publish: false created_at: '2025-09-18T23:53:43.000000Z' updated_at: '2025-09-18T23:53:43.000000Z' publish_at: '1978-05-24T11:04:41.000000Z' properties: data: type: object properties: id: type: integer example: 43 title: type: string example: 'Dolorum amet iste laborum eius est dolor.' topic: type: string example: null draft: type: boolean example: true auto_publish: type: boolean example: false created_at: type: string example: '2025-09-18T23:53:43.000000Z' updated_at: type: string example: '2025-09-18T23:53:43.000000Z' publish_at: type: string example: '1978-05-24T11:04:41.000000Z' tags: - PostGroup requestBody: required: false content: application/json: schema: type: object properties: title: type: required description: 'The title of the post group' example: consequatur nullable: true draft: type: The description: 'draft of the post group' example: consequatur nullable: false auto_publish: type: The description: 'auto publish of the post group' example: consequatur nullable: false publish_at: type: The description: 'publish at of the post group' example: consequatur nullable: true tags_ids: type: The description: 'tags ids of the post group' example: consequatur nullable: false delete: summary: 'DELETE api/postGroups/{id}' operationId: dELETEApipostGroupsid description: 'Delete the post group' parameters: [] responses: 204: description: '' tags: - PostGroup parameters: - in: path name: id description: 'Optional parameter. The ID of the post group' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: consequatur '/api/postGroups/{id}/publish': post: summary: 'POST api/postGroups/{id}/publish' operationId: pOSTApipostGroupsidpublish description: 'Publish the posts that are in pending or error status for the given social network type in the post group' parameters: - in: query name: social_network_type description: 'The social network type (facebook twitter, instagram, threads, linkedin, tiktok, discord, medium, pinterest, youtube, canva)' example: consequatur required: false schema: type: string description: 'The social network type (facebook twitter, instagram, threads, linkedin, tiktok, discord, medium, pinterest, youtube, canva)' example: consequatur nullable: false responses: 204: description: '' tags: - PostGroup requestBody: required: true content: application/json: schema: type: object properties: social_network_type: type: string description: '' example: consequatur nullable: false required: - social_network_type parameters: - in: path name: id description: 'Optional parameter. The ID of the post group' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: consequatur /api/subscriptionLimits: get: summary: 'GET api/subscriptionLimits' operationId: gETApisubscriptionLimits description: 'Return the list of subscription limits' parameters: - in: query name: include description: 'additional relations to include in response, separated by semi-colon.' example: company required: false schema: type: string description: 'additional relations to include in response, separated by semi-colon.' example: company nullable: false - in: query name: 'filter[company_id]' description: 'filter by company id' example: consequatur required: false schema: type: string description: 'filter by company id' example: consequatur nullable: false - in: query name: 'filter[user_id]' description: 'filter by user id, null allowed' example: consequatur required: false schema: type: string description: 'filter by user id, null allowed' example: consequatur nullable: false - in: query name: sort description: 'sort by field.' example: 'id, -id, created_at, -created_at' required: false schema: type: string description: 'sort by field.' example: 'id, -id, created_at, -created_at' nullable: false - in: query name: 'page[number]' description: 'page number.' example: 1 required: false schema: type: integer description: 'page number.' example: 1 nullable: false - in: query name: 'page[size]' description: 'items per page (default 30).' example: 10 required: false schema: type: integer description: 'items per page (default 30).' example: 10 nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 48 company_id: 139 user_id: 313 users_amount: 498 words_amount: 62211 images_amount: 1867 premium_images_amount: 5571 bytes_amount: 612111894 created_at: '2025-09-18T23:53:45.000000Z' updated_at: '2025-09-18T23:53:45.000000Z' - id: 49 company_id: 140 user_id: 315 users_amount: 369 words_amount: 87707 images_amount: 643 premium_images_amount: 6030 bytes_amount: 345083069 created_at: '2025-09-18T23:53:45.000000Z' updated_at: '2025-09-18T23:53:45.000000Z' properties: data: type: array example: - id: 48 company_id: 139 user_id: 313 users_amount: 498 words_amount: 62211 images_amount: 1867 premium_images_amount: 5571 bytes_amount: 612111894 created_at: '2025-09-18T23:53:45.000000Z' updated_at: '2025-09-18T23:53:45.000000Z' - id: 49 company_id: 140 user_id: 315 users_amount: 369 words_amount: 87707 images_amount: 643 premium_images_amount: 6030 bytes_amount: 345083069 created_at: '2025-09-18T23:53:45.000000Z' updated_at: '2025-09-18T23:53:45.000000Z' items: type: object properties: id: type: integer example: 48 company_id: type: integer example: 139 user_id: type: integer example: 313 users_amount: type: integer example: 498 words_amount: type: integer example: 62211 images_amount: type: integer example: 1867 premium_images_amount: type: integer example: 5571 bytes_amount: type: integer example: 612111894 created_at: type: string example: '2025-09-18T23:53:45.000000Z' updated_at: type: string example: '2025-09-18T23:53:45.000000Z' tags: - 'Subscription Limit' post: summary: 'POST api/subscriptionLimits' operationId: pOSTApisubscriptionLimits description: 'Create a new subscription limit' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 51 company_id: 142 user_id: 319 users_amount: 498 words_amount: 62211 images_amount: 1867 premium_images_amount: 5571 bytes_amount: 612111894 created_at: '2025-09-18T23:53:45.000000Z' updated_at: '2025-09-18T23:53:45.000000Z' properties: data: type: object properties: id: type: integer example: 51 company_id: type: integer example: 142 user_id: type: integer example: 319 users_amount: type: integer example: 498 words_amount: type: integer example: 62211 images_amount: type: integer example: 1867 premium_images_amount: type: integer example: 5571 bytes_amount: type: integer example: 612111894 created_at: type: string example: '2025-09-18T23:53:45.000000Z' updated_at: type: string example: '2025-09-18T23:53:45.000000Z' tags: - 'Subscription Limit' requestBody: required: false content: application/json: schema: type: object properties: company_id: type: The description: 'ID of the company' example: consequatur nullable: false user_id: type: The description: 'ID of the user ~nullable, when set, the subscription limit is for a specific user if not set, the subscription limit is for all users of the company~' example: consequatur nullable: true users_amount: type: The description: 'amount of users' example: consequatur nullable: true words_amount: type: The description: 'amount of words' example: consequatur nullable: true images_amount: type: The description: 'amount of images' example: consequatur nullable: true premium_images_amount: type: The description: 'amount of premium images' example: consequatur nullable: true bytes_amount: type: The description: 'amount of bytes' example: consequatur nullable: true '/api/subscriptionLimits/{id}': get: summary: 'GET api/subscriptionLimits/{id}' operationId: gETApisubscriptionLimitsid description: 'Return the subscription limit' parameters: - in: query name: include description: 'additional relations to include in response, separated by semi-colon.' example: company required: false schema: type: string description: 'additional relations to include in response, separated by semi-colon.' example: company nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: id: 50 company_id: 141 user_id: 317 users_amount: 496 words_amount: 50866 images_amount: 3140 premium_images_amount: 3311 bytes_amount: 284733364 created_at: '2025-09-18T23:53:45.000000Z' updated_at: '2025-09-18T23:53:45.000000Z' properties: data: type: object properties: id: type: integer example: 50 company_id: type: integer example: 141 user_id: type: integer example: 317 users_amount: type: integer example: 496 words_amount: type: integer example: 50866 images_amount: type: integer example: 3140 premium_images_amount: type: integer example: 3311 bytes_amount: type: integer example: 284733364 created_at: type: string example: '2025-09-18T23:53:45.000000Z' updated_at: type: string example: '2025-09-18T23:53:45.000000Z' tags: - 'Subscription Limit' put: summary: 'PUT api/subscriptionLimits/{id}' operationId: pUTApisubscriptionLimitsid description: 'Update the subscription limit' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 52 company_id: 143 user_id: 321 users_amount: 498 words_amount: 62211 images_amount: 1867 premium_images_amount: 5571 bytes_amount: 612111894 created_at: '2025-09-18T23:53:45.000000Z' updated_at: '2025-09-18T23:53:45.000000Z' properties: data: type: object properties: id: type: integer example: 52 company_id: type: integer example: 143 user_id: type: integer example: 321 users_amount: type: integer example: 498 words_amount: type: integer example: 62211 images_amount: type: integer example: 1867 premium_images_amount: type: integer example: 5571 bytes_amount: type: integer example: 612111894 created_at: type: string example: '2025-09-18T23:53:45.000000Z' updated_at: type: string example: '2025-09-18T23:53:45.000000Z' tags: - 'Subscription Limit' requestBody: required: false content: application/json: schema: type: object properties: users_amount: type: The description: 'amount of users' example: consequatur nullable: true words_amount: type: The description: 'amount of words' example: consequatur nullable: true images_amount: type: The description: 'amount of images' example: consequatur nullable: true premium_images_amount: type: The description: 'amount of premium images' example: consequatur nullable: true bytes_amount: type: The description: 'amount of bytes' example: consequatur nullable: true delete: summary: 'DELETE api/subscriptionLimits/{id}' operationId: dELETEApisubscriptionLimitsid description: 'Delete the subscription limit' parameters: [] responses: 204: description: '' tags: - 'Subscription Limit' parameters: - in: path name: id description: 'Optional parameter. The ID of the subscription limit' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: consequatur /api/users: get: summary: 'GET api/users' operationId: gETApiusers description: 'Return the list of users' parameters: - in: query name: include description: 'additional relations to include in response, separated by semi-colon.' example: image.thumbnail required: false schema: type: string description: 'additional relations to include in response, separated by semi-colon.' example: image.thumbnail nullable: false - in: query name: 'filter[name]' description: 'filter by name' example: consequatur required: false schema: type: string description: 'filter by name' example: consequatur nullable: false - in: query name: 'filter[email]' description: 'filter by email' example: consequatur required: false schema: type: string description: 'filter by email' example: consequatur nullable: false - in: query name: 'filter[companies.id]' description: 'filter by company id' example: consequatur required: false schema: type: string description: 'filter by company id' example: consequatur nullable: false - in: query name: sort description: 'sort by field.' example: 'id, -id, created_at, -created_at' required: false schema: type: string description: 'sort by field.' example: 'id, -id, created_at, -created_at' nullable: false - in: query name: 'page[number]' description: 'page number.' example: 1 required: false schema: type: integer description: 'page number.' example: 1 nullable: false - in: query name: 'page[size]' description: 'items per page (default 30).' example: 10 required: false schema: type: integer description: 'items per page (default 30).' example: 10 nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 266 name: 'Dr. Cornelius Luettgen V' email: russel.bert@example.net referral_code: T0TIYI language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' - id: 267 name: 'Monty Schmeler' email: schultz.robyn@example.com referral_code: NGO0AM language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' properties: data: type: array example: - id: 266 name: 'Dr. Cornelius Luettgen V' email: russel.bert@example.net referral_code: T0TIYI language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' - id: 267 name: 'Monty Schmeler' email: schultz.robyn@example.com referral_code: NGO0AM language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' items: type: object properties: id: type: integer example: 266 name: type: string example: 'Dr. Cornelius Luettgen V' email: type: string example: russel.bert@example.net referral_code: type: string example: T0TIYI language: type: string example: null timezone: type: string example: null notification_settings: type: string example: null credits: type: integer example: 0 pm_type: type: string example: null pm_last_four: type: string example: null cancel_reason: type: string example: null referrer_url: type: string example: null land_url: type: string example: null has_password: type: boolean example: true created_at: type: string example: '2025-09-18T23:53:42.000000Z' updated_at: type: string example: '2025-09-18T23:53:42.000000Z' banned_at: type: string example: null password_changed_at: type: string example: '2025-09-18T23:53:42.000000Z' tags: - User post: summary: 'POST api/users' operationId: pOSTApiusers description: 'Create a new user, if user already exists, it will be attached to the company provided with an invitation' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 269 name: 'Dr. Cornelius Luettgen V' email: reichel.charity@example.net referral_code: XHM46I language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' properties: data: type: object properties: id: type: integer example: 269 name: type: string example: 'Dr. Cornelius Luettgen V' email: type: string example: reichel.charity@example.net referral_code: type: string example: XHM46I language: type: string example: null timezone: type: string example: null notification_settings: type: string example: null credits: type: integer example: 0 pm_type: type: string example: null pm_last_four: type: string example: null cancel_reason: type: string example: null referrer_url: type: string example: null land_url: type: string example: null has_password: type: boolean example: true created_at: type: string example: '2025-09-18T23:53:42.000000Z' updated_at: type: string example: '2025-09-18T23:53:42.000000Z' banned_at: type: string example: null password_changed_at: type: string example: '2025-09-18T23:53:42.000000Z' tags: - User requestBody: required: false content: application/json: schema: type: object properties: name: type: required description: 'The name of the user' example: consequatur nullable: false email: type: required description: 'The email of the user' example: qkunze@example.com nullable: false company_id: type: required description: 'The ID of the company' example: consequatur nullable: false language: type: The description: 'language of the user' example: consequatur nullable: false timezone: type: The description: 'timezone of the user' example: Europe/Malta nullable: false referrer_url: type: string description: 'Must be a valid URL. Must not be greater than 255 characters.' example: 'https://www.mueller.com/laborum-eius-est-dolor-dolores-minus-voluptatem' nullable: false land_url: type: string description: 'Must be a valid URL. Must not be greater than 255 characters.' example: 'http://schmeler.com/a-quo-sed-fugit-facilis-perferendis-dolores-molestias' nullable: false role: type: The description: 'role of the user in the company ~owner, admin, user, client~, default: user' example: consequatur nullable: false '/api/users/{id}': get: summary: 'GET api/users/{id}' operationId: gETApiusersid description: 'Return the user' parameters: - in: query name: include description: 'additional relations to include in response, separated by semi-colon.' example: image.thumbnail required: false schema: type: string description: 'additional relations to include in response, separated by semi-colon.' example: image.thumbnail nullable: false responses: 200: description: '' content: application/json: schema: type: object example: data: id: 268 name: 'Dr. Enoch Harber II' email: murazik.kacey@example.net referral_code: VSL6NK language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' properties: data: type: object properties: id: type: integer example: 268 name: type: string example: 'Dr. Enoch Harber II' email: type: string example: murazik.kacey@example.net referral_code: type: string example: VSL6NK language: type: string example: null timezone: type: string example: null notification_settings: type: string example: null credits: type: integer example: 0 pm_type: type: string example: null pm_last_four: type: string example: null cancel_reason: type: string example: null referrer_url: type: string example: null land_url: type: string example: null has_password: type: boolean example: true created_at: type: string example: '2025-09-18T23:53:42.000000Z' updated_at: type: string example: '2025-09-18T23:53:42.000000Z' banned_at: type: string example: null password_changed_at: type: string example: '2025-09-18T23:53:42.000000Z' tags: - User put: summary: 'PUT api/users/{id}' operationId: pUTApiusersid description: 'Update the user' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 270 name: 'Dr. Cornelius Luettgen V' email: dsmith@example.com referral_code: LOOLDE language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:42.000000Z' updated_at: '2025-09-18T23:53:42.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:42.000000Z' properties: data: type: object properties: id: type: integer example: 270 name: type: string example: 'Dr. Cornelius Luettgen V' email: type: string example: dsmith@example.com referral_code: type: string example: LOOLDE language: type: string example: null timezone: type: string example: null notification_settings: type: string example: null credits: type: integer example: 0 pm_type: type: string example: null pm_last_four: type: string example: null cancel_reason: type: string example: null referrer_url: type: string example: null land_url: type: string example: null has_password: type: boolean example: true created_at: type: string example: '2025-09-18T23:53:42.000000Z' updated_at: type: string example: '2025-09-18T23:53:42.000000Z' banned_at: type: string example: null password_changed_at: type: string example: '2025-09-18T23:53:42.000000Z' tags: - User requestBody: required: false content: application/json: schema: type: object properties: name: type: The description: 'name of the user' example: consequatur nullable: false email: type: The description: 'email of the user' example: qkunze@example.com nullable: false password: type: string description: '' example: 'O[2UZ5ij-e/dl4m{o,' nullable: false language: type: The description: 'language of the user' example: consequatur nullable: false timezone: type: The description: 'timezone of the user' example: Europe/Malta nullable: false referral_code: type: string description: 'The referral_code of an existing record in the users table.' example: consequatur nullable: false notification_settings: type: object description: '' example: [] nullable: false properties: post_error: type: boolean description: '' example: false nullable: false post_published: type: boolean description: '' example: true nullable: false social_network_expired: type: boolean description: '' example: false nullable: false internal_comment_received: type: boolean description: '' example: true nullable: false referrer_url: type: string description: 'Must be a valid URL. Must not be greater than 255 characters.' example: 'http://emard.info/dolores-minus-voluptatem-quisquam-quibusdam-sed-vel-a' nullable: false land_url: type: string description: 'Must be a valid URL. Must not be greater than 255 characters.' example: 'http://carter.com/perferendis-dolores-molestias-ipsam-sit-veniam-sed.html' nullable: false frontend_url: type: string description: 'Must be a valid URL.' example: 'http://boyle.com/quas-dignissimos-perferendis-voluptatibus-incidunt-nostrum-quia-possimus-rerum' nullable: false white_label_id: type: integer description: 'The id of an existing record in the white_labels table.' example: 17 nullable: false delete: summary: 'DELETE api/users/{id}' operationId: dELETEApiusersid description: 'Delete the user or remove it from company if company_id is provided' parameters: - in: query name: company_id description: 'The ID of the company to remove the user from' example: consequatur required: false schema: type: string description: 'The ID of the company to remove the user from' example: consequatur nullable: false responses: 204: description: '' tags: - User requestBody: required: false content: application/json: schema: type: object properties: company_id: type: string description: '' example: null nullable: false parameters: - in: path name: id description: 'Optional parameter. The ID of the user' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: consequatur '/api/companies/{company_id}/users/{id}': put: summary: 'PUT api/companies/{company_id}/users/{id}' operationId: pUTApicompaniescompanyIdusersid description: "Update the user's role in the company" parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 276 name: 'Dr. Cornelius Luettgen V' email: jaylan50@example.com referral_code: 2DHUQX language: null timezone: null notification_settings: null credits: 0 pm_type: null pm_last_four: null cancel_reason: null referrer_url: null land_url: null has_password: true created_at: '2025-09-18T23:53:43.000000Z' updated_at: '2025-09-18T23:53:43.000000Z' banned_at: null password_changed_at: '2025-09-18T23:53:43.000000Z' properties: data: type: object properties: id: type: integer example: 276 name: type: string example: 'Dr. Cornelius Luettgen V' email: type: string example: jaylan50@example.com referral_code: type: string example: 2DHUQX language: type: string example: null timezone: type: string example: null notification_settings: type: string example: null credits: type: integer example: 0 pm_type: type: string example: null pm_last_four: type: string example: null cancel_reason: type: string example: null referrer_url: type: string example: null land_url: type: string example: null has_password: type: boolean example: true created_at: type: string example: '2025-09-18T23:53:43.000000Z' updated_at: type: string example: '2025-09-18T23:53:43.000000Z' banned_at: type: string example: null password_changed_at: type: string example: '2025-09-18T23:53:43.000000Z' tags: - User requestBody: required: false content: application/json: schema: type: object properties: role: type: The description: 'role of the user in the company ~owner, admin, user, client~' example: consequatur nullable: false parameters: - in: path name: company_id description: 'Optional parameter. The ID of the company' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: consequatur - in: path name: id description: 'Optional parameter. The ID of the user' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: consequatur