> ## Documentation Index > Fetch the complete documentation index at: https://docs.adside.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get > Read stable creative IDs, numbers and current render revisions CLI: `adside creatives get` ## OpenAPI ````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/creatives/{dropId} openapi: 3.1.0 info: title: Adside API version: 1.0.0 description: >- Campaigns, creatives, assets and reporting across your ad accounts. Call it with a personal API key as a bearer token, or with the `adside` CLI: each page names its command. servers: - url: https://api.adside.ai description: Production security: - userAccess: [] tags: - name: Account - name: Reporting - name: Meta - name: Google Ads - name: LinkedIn - name: TikTok - name: Reddit - name: Snapchat - name: X - name: Google Tag Manager - name: Creatives - name: Creative styles - name: Media - name: Characters - name: Assets - name: Brands - name: Brain - name: Research - name: Boards - name: Artifacts - name: Audiences - name: Ad comments - name: Publications - name: Routines - name: Skills - name: To-dos - name: Audit - name: Credits paths: /v1/workspaces/{workspaceId}/creatives/{dropId}: get: tags: - Creatives summary: Get description: |- Read stable creative IDs, numbers and current render revisions CLI: `adside creatives get` operationId: creatives.get parameters: - name: workspaceId in: path required: true schema: type: string minLength: 1 - name: dropId in: path required: true schema: type: string minLength: 1 responses: '200': description: Success content: application/json: schema: $schema: https://json-schema.org/draft/2020-12/schema type: object properties: advertiser: type: object properties: name: type: string website: type: string required: - name - website additionalProperties: false inputs: type: object properties: creativeCount: type: integer minimum: 0 maximum: 9007199254740991 references: type: array items: type: object properties: label: type: string url: anyOf: - type: string format: uri - type: 'null' required: - label - url additionalProperties: false required: - creativeCount - references additionalProperties: false dropId: type: string minLength: 1 maxLength: 300 name: type: string prompt: type: string activeRunId: anyOf: - type: string minLength: 1 maxLength: 300 - type: 'null' latestPublicRunId: anyOf: - type: string minLength: 1 maxLength: 300 - type: 'null' creatives: type: array items: type: object properties: creativeId: type: string minLength: 1 maxLength: 300 number: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 currentCreativeRevisionId: anyOf: - type: string minLength: 1 maxLength: 300 - type: 'null' reviewStatus: type: string enum: - unreviewed - kept - discarded renders: type: object propertyNames: type: string enum: - story - portrait - square - landscape - wide - twitter - link additionalProperties: type: string minLength: 1 maxLength: 300 media: type: array items: type: object properties: format: type: string enum: - story - portrait - square - landscape - wide - twitter - link assetId: type: string minLength: 1 maxLength: 300 url: type: string format: uri mimeType: type: string required: - format - assetId - url - mimeType additionalProperties: false title: type: string note: type: string kind: type: string enum: - static - animation - video copy: anyOf: - type: object properties: primaryText: type: string maxLength: 1024 headline: type: string maxLength: 255 description: type: string maxLength: 255 callToAction: type: string enum: - APPLY_NOW - BOOK_TRAVEL - BOOK_NOW - BUY_TICKETS - CALL_NOW - CONTACT_US - DONATE_NOW - DOWNLOAD - EXPLORE_MORE - GET_DIRECTIONS - GET_OFFER - GET_PROMOTIONS - GET_QUOTE - GET_SHOWTIMES - LEARN_MORE - LIKE_PAGE - LISTEN_NOW - OPEN_LINK - ORDER_NOW - PLAY_GAME - REQUEST_TIME - SAVE - SEE_DETAILS - SEE_MENU - MESSAGE_PAGE - WHATSAPP_MESSAGE - SHOP_NOW - SIGN_UP - SUBSCRIBE - USE_APP - WATCH_MORE required: - primaryText - headline - description - callToAction additionalProperties: false - type: 'null' originalCopy: anyOf: - type: object properties: primaryText: type: string maxLength: 1024 headline: type: string maxLength: 255 description: type: string maxLength: 255 callToAction: type: string enum: - APPLY_NOW - BOOK_TRAVEL - BOOK_NOW - BUY_TICKETS - CALL_NOW - CONTACT_US - DONATE_NOW - DOWNLOAD - EXPLORE_MORE - GET_DIRECTIONS - GET_OFFER - GET_PROMOTIONS - GET_QUOTE - GET_SHOWTIMES - LEARN_MORE - LIKE_PAGE - LISTEN_NOW - OPEN_LINK - ORDER_NOW - PLAY_GAME - REQUEST_TIME - SAVE - SEE_DETAILS - SEE_MENU - MESSAGE_PAGE - WHATSAPP_MESSAGE - SHOP_NOW - SIGN_UP - SUBSCRIBE - USE_APP - WATCH_MORE required: - primaryText - headline - description - callToAction additionalProperties: false - type: 'null' selectionMap: type: object propertyNames: type: string enum: - story - portrait - square - landscape - wide - twitter - link additionalProperties: maxItems: 500 type: array items: type: object properties: role: type: string minLength: 1 maxLength: 120 text: type: string maxLength: 500 elementId: type: string minLength: 1 maxLength: 240 sourcePath: type: string minLength: 1 maxLength: 500 sourceLine: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 x: type: number minimum: 0 maximum: 1 'y': type: number minimum: 0 maximum: 1 width: type: number exclusiveMinimum: 0 maximum: 1 height: type: number exclusiveMinimum: 0 maximum: 1 required: - role - text - sourcePath - x - 'y' - width - height additionalProperties: false interactivePreview: default: true type: boolean disclosure: type: object properties: generatedMedia: type: array items: type: object properties: file: type: string provider: type: string model: type: string prompt: type: string required: - file - provider - model - prompt additionalProperties: false simulatedUi: type: array items: type: string required: - generatedMedia - simulatedUi additionalProperties: false revisions: type: array items: type: object properties: id: type: string minLength: 1 maxLength: 300 number: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ canEdit: type: boolean required: - id - number - createdAt - canEdit additionalProperties: false required: - creativeId - number - currentCreativeRevisionId - reviewStatus - renders - media - title - note - kind - copy - originalCopy - selectionMap - interactivePreview - disclosure - revisions additionalProperties: false comments: type: array items: type: object properties: id: type: string minLength: 1 maxLength: 300 canEdit: type: boolean creativeId: type: string minLength: 1 maxLength: 300 creativeRevisionId: type: string minLength: 1 maxLength: 300 body: type: string target: oneOf: - type: object properties: kind: type: string const: creative required: - kind additionalProperties: false - type: object properties: kind: type: string const: element previewVariant: type: string enum: - story - portrait - square - landscape - wide - twitter - link x: type: number minimum: 0 maximum: 1 'y': type: number minimum: 0 maximum: 1 width: type: number exclusiveMinimum: 0 maximum: 1 height: type: number exclusiveMinimum: 0 maximum: 1 elementRole: type: string maxLength: 120 elementText: type: string maxLength: 500 elementId: type: string maxLength: 240 sourcePath: type: string minLength: 1 maxLength: 500 sourceLine: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 timeSeconds: type: number minimum: 0 selectionSource: type: string enum: - render - live contextAssetId: type: string minLength: 1 visualEdit: oneOf: - type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ kind: type: string const: text nodePath: minItems: 1 maxItems: 40 type: array items: type: integer minimum: 0 maximum: 10000 before: type: string maxLength: 4000 after: type: string minLength: 1 maxLength: 4000 required: - id - kind - nodePath - before - after additionalProperties: false - type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ kind: type: string const: resize nodePath: minItems: 1 maxItems: 40 type: array items: type: integer minimum: 0 maximum: 10000 before: type: object properties: width: type: number exclusiveMinimum: 0 maximum: 1 height: type: number exclusiveMinimum: 0 maximum: 1 required: - width - height additionalProperties: false after: type: object properties: width: type: number exclusiveMinimum: 0 maximum: 1 height: type: number exclusiveMinimum: 0 maximum: 1 required: - width - height additionalProperties: false required: - id - kind - nodePath - before - after additionalProperties: false - type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ kind: type: string const: reorder nodePath: minItems: 1 maxItems: 40 type: array items: type: integer minimum: 0 maximum: 10000 blockPath: minItems: 1 maxItems: 40 type: array items: type: integer minimum: 0 maximum: 10000 placement: type: string enum: - before - after anchor: type: object properties: nodePath: minItems: 1 maxItems: 40 type: array items: type: integer minimum: 0 maximum: 10000 blockPath: minItems: 1 maxItems: 40 type: array items: type: integer minimum: 0 maximum: 10000 elementRole: type: string minLength: 1 maxLength: 120 elementText: type: string maxLength: 500 sourcePath: type: string minLength: 1 maxLength: 500 sourceLine: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 elementId: type: string maxLength: 240 required: - nodePath - blockPath - elementRole - elementText - sourcePath - sourceLine additionalProperties: false required: - id - kind - nodePath - blockPath - placement - anchor additionalProperties: false required: - kind - previewVariant - x - 'y' - width - height additionalProperties: false - type: object properties: kind: type: string const: region previewVariant: type: string enum: - story - portrait - square - landscape - wide - twitter - link x: type: number minimum: 0 maximum: 1 'y': type: number minimum: 0 maximum: 1 width: type: number exclusiveMinimum: 0 maximum: 1 height: type: number exclusiveMinimum: 0 maximum: 1 elementRole: type: string maxLength: 120 elementText: type: string maxLength: 500 elementId: type: string maxLength: 240 sourcePath: type: string minLength: 1 maxLength: 500 sourceLine: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 timeSeconds: type: number minimum: 0 selectionSource: type: string enum: - render - live contextAssetId: type: string minLength: 1 required: - kind - previewVariant - x - 'y' - width - height additionalProperties: false createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ submittedAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: 'null' sentAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ - type: 'null' required: - id - canEdit - creativeId - creativeRevisionId - body - target - createdAt - submittedAt - sentAt additionalProperties: false required: - advertiser - inputs - dropId - name - prompt - activeRunId - latestPublicRunId - creatives - comments additionalProperties: false security: - userAccess: [] components: securitySchemes: userAccess: type: http scheme: bearer description: >- A personal API key (`adside_pat_…`) or a token from `adside login`. Either carries the permissions of the person it belongs to. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.