{"source_url":"https://api.bynder.com/reference/adduserstogroup.md","page_updatedAt":"2026-07-15T15:50:57.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Groups","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Groups (Preferred)"}],"paths":{"/api/1/groups/{groupId}/add-users":{"post":{"operationId":"addUsersToGroup","summary":"Add users to a group","description":"Adds one or more users to the specified group. Pass a single-element array to add one user.\n\nUsers that are already members of the group are silently ignored (the operation is idempotent).\nAn empty `user_ids` array is accepted and is a no-op.\n\nRequires the **GROUPMANAGEMENT** security role.\n","tags":["Groups (Preferred)"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"ID of the group (hyphens optional)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMembersInput"}}}},"responses":{"200":{"description":"Users added successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMembersResult"}}}},"400":{"description":"One or more user IDs do not exist in the account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"description":"Validation error (e.g. missing `user_ids` field or malformed UUID)."}},"security":[{"permanentToken":["GROUPMANAGEMENT"]},{"OAuth2":["GROUPMANAGEMENT"]}]}}},"components":{"responses":{"Unauthorized":{"description":"Missing or invalid authentication. The response body is empty."},"Forbidden":{"description":"The authenticated user does not have the **GROUPMANAGEMENT** security role."},"NotFound":{"description":"Group not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"schemas":{"GroupMembersInput":{"type":"object","required":["user_ids"],"properties":{"user_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the users to add or remove. An empty list is a no-op."}}},"GroupMembersResult":{"type":"object","properties":{"user_count":{"type":"integer","description":"Updated number of members in the group after the operation."}}},"ErrorResponse":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable description of the error."}}}}},"NotFoundResponse":{"type":"object","properties":{"detail":{"type":"string","example":"Not Found"}}}},"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups`"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/closecampaign.md","page_updatedAt":"2026-01-07T16:02:10.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Campaigns API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Campaigns","description":""}],"paths":{"/api/workflow/campaigns/{id}":{"post":{"summary":"Close campaign","description":"Requires the CAMPAIGNWRITE security role.","tags":["Campaigns"],"operationId":"closeCampaign","security":[{"OAuth2":["CAMPAIGNWRITE"]},{"permanentToken":["CAMPAIGNWRITE"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"responses":{"204":{"description":"Campaign closed successfully"},"404":{"description":"Campaign not found"}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"CAMPAIGNOVERVIEW":"","CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"CAMPAIGNOVERVIEW":"","CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/create-metaproperty-access.md","page_updatedAt":"2026-01-21T16:37:01.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Access Rights and Options API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}}],"paths":{"/api/content_access/metaproperties/{metaproperty_id}":{"post":{"tags":["Access rights"],"summary":"Create metaproperty access","description":"","operationId":"Create metaproperty access","parameters":[{"name":"metaproperty_id","in":"path","description":"Metaproperty id.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesRequest"}}},"required":true},"responses":{"201":{"description":"Metaproperty access created","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesResponse1"},"description":"","contentMediaType":"application/json"}}}}},"deprecated":false},"parameters":[]}},"components":{"schemas":{"ApiContentAccessMetapropertiesRequest":{"title":"ApiContentAccessMetapropertiesRequest","type":"object","properties":{"principals":{"type":"array","items":{"$ref":"#/components/schemas/Principal"},"description":""},"level":{"$ref":"#/components/schemas/Level"}}},"Principal":{"title":"Principal","type":"object","properties":{"principalId":{"type":"string","examples":["00000000-0000-0000-0000000000000000"]},"principalType":{"$ref":"#/components/schemas/PrincipalType"}}},"PrincipalType":{"title":"PrincipalType","enum":["user","group","profile"],"type":"string","examples":["user"]},"Level":{"title":"Level","const":"metaproperty.hide","type":"string","examples":["metaproperty.hide"]},"ApiContentAccessMetapropertiesResponse1":{"title":"ApiContentAccessMetapropertiesResponse1","type":"object","properties":{"principalId":{"type":"string","examples":["00000000-0000-0000-0000-000000000000"]},"principalType":{"type":"string","examples":["user"]}}}},"securitySchemes":{"permanentToken":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://DefaultParameterValue/","tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}}}}}},"security":[{"OAuth2":[]},{"permanentToken":[]}],"tags":[{"name":"Access rights","description":""}]}}
{"source_url":"https://api.bynder.com/reference/creategroup.md","page_updatedAt":"2026-07-15T15:50:57.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Groups","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Groups (Preferred)"}],"paths":{"/api/1/groups":{"post":{"operationId":"createGroup","summary":"Create a group","description":"Creates a new group.\n\nRequires the **GROUPMANAGEMENT** security role.\n","tags":["Groups (Preferred)"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the group. Must be unique within the account. Must be a string (numbers are not coerced)."},"description":{"type":["string","null"],"description":"Optional description of the group."}}}}}},"responses":{"201":{"description":"Group created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"description":"A group with this name already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error (e.g. `name` is missing or not a string)."}},"security":[{"permanentToken":["GROUPMANAGEMENT"]},{"OAuth2":["GROUPMANAGEMENT"]}]}}},"components":{"responses":{"Unauthorized":{"description":"Missing or invalid authentication. The response body is empty."},"Forbidden":{"description":"The authenticated user does not have the **GROUPMANAGEMENT** security role."}},"schemas":{"Group":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":["string","null"]},"user_count":{"type":"integer","description":"Number of members in the group."}},"example":{"id":"0397e4bd-33fe-4b8f-a51d-4c2f1d9b6c1a","name":"Marketing","description":"Everyone in the marketing department","user_count":12}},"ErrorResponse":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable description of the error."}}}}}},"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups`"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/createwebhookconfiguration.md","page_updatedAt":"2026-08-03T15:12:29.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Webhooks API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}}],"tags":[{"name":"Configurations","description":""}],"paths":{"/v7/webhooks/public/api/subscriptions":{"post":{"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"message":"Subscription Config ID cf2493be-c808-41da-bcc2-cfb31f38b457 created","record":{"configId":"cf2493be-c808-41da-bcc2-cfb31f38b457","endpoint":"example@example.com","events":["asset_bank.media.archived","asset_bank.media.pre_archived","asset_bank.media.deleted","asset_bank.media.updated","asset_bank.media.meta_updated","asset_bank.media.create","workflow.job.create","antivirus.scan.failed"],"is_legacy":false,"migratedSubscriptions":"[]","name":"example-webhook-name","portalId":"62dddddd-eeee-ffff-aaaa-9f78fggggggg","preArchivedNotificationDays":1,"protocol":"email","subscriptionArn":"pendingconfirmation","topicArn":"arn:aws:sns:us-east-1:003565342056:62dddddd-eeee-ffff-aaaa-9f78fggggggg-example-webhook-name-cf2493be-c808-41da-bcc2-cfb31f38b457","userId":"DDDDDDE1-DDDD-DDDD-DDDDDD059F8AFFFF"},"success":true}}},"schema":{"example":{"message":"Subscription Config ID cf2493be-c808-41da-bcc2-cfb31f38b457 created","record":{"configId":"cf2493be-c808-41da-bcc2-cfb31f38b457","endpoint":"example@example.com","events":["asset_bank.media.archived","asset_bank.media.pre_archived","asset_bank.media.deleted","asset_bank.media.updated","asset_bank.media.meta_updated","asset_bank.media.create","workflow.job.create","antivirus.scan.failed"],"is_legacy":false,"migratedSubscriptions":"[]","name":"example-webhook-name","portalId":"62dddddd-eeee-ffff-aaaa-9f78fggggggg","preArchivedNotificationDays":1,"protocol":"email","subscriptionArn":"pendingconfirmation","topicArn":"arn:aws:sns:us-east-1:003565342056:62dddddd-eeee-ffff-aaaa-9f78fggggggg-example-webhook-name-cf2493be-c808-41da-bcc2-cfb31f38b457","userId":"DDDDDDE1-DDDD-DDDD-DDDDDD059F8AFFFF"},"success":true},"properties":{"message":{"type":"string"},"record":{"properties":{"configId":{"type":"string"},"endpoint":{"type":"string"},"events":{"items":{"type":"string"},"type":"array"},"is_legacy":{"type":"boolean"},"migratedSubscriptions":{"type":"string"},"name":{"type":"string"},"portalId":{"type":"string"},"preArchivedNotificationDays":{"type":"number"},"protocol":{"type":"string"},"subscriptionArn":{"type":"string"},"topicArn":{"type":"string"},"userId":{"type":"string"}},"type":"object"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK","headers":{}},"400":{"content":{"application/json":{"examples":{"response":{"value":{"message":"Failed to create subscription test-public-api-docs: INVALID_ARGUMENT: Combination of subscription name, protocol, and endpoint already exists","success":false}}},"schema":{"example":{"message":"Failed to create subscription test-public-api-docs: INVALID_ARGUMENT: Combination of subscription name, protocol, and endpoint already exists","success":false},"properties":{"message":{"type":"string"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Bad Request","headers":{}}},"tags":["Configurations"],"description":"Please be aware that using this endpoint requires the `Manage Webhooks configurations` security role.","operationId":"createWebhookConfiguration","requestBody":{"content":{"application/json":{"schema":{"properties":{"endpoint":{"description":"Endpoint for the Webhooks subscription.","type":"string"},"events":{"description":"List of events to subscribe to.","items":{},"type":"array"},"name":{"description":"Display name for the Webhooks configuration.","type":"string"},"preArchivedNotificationDays":{"description":"Required to have a value of 1 or greater if the \"asset_bank.media.pre_archived\" event is subscribed to","type":"number"},"protocol":{"description":"Protocol for the Webhooks subscription. Possible values: \"http\", \"https\", \"email\", \"email-json\", \"sqs\".","type":"string"}},"required":["name","endpoint","protocol","events"],"type":"object"}}}},"summary":"Create a Webhook configuration"}}}}}
{"source_url":"https://api.bynder.com/reference/delete-metaproperty-access.md","page_updatedAt":"2026-01-21T16:37:01.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Access Rights and Options API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}}],"paths":{"/api/content_access/metaproperties/{metaproperty_id}":{"delete":{"tags":["Access rights"],"summary":"Delete metaproperty access","description":"","operationId":"Delete metaproperty access","parameters":[{"name":"metaproperty_id","in":"path","description":"Metaproperty id.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesRequest1"}}},"required":true},"responses":{"204":{"description":"Metaproperty access deleted","headers":{},"content":{}}},"deprecated":false},"parameters":[]}},"components":{"schemas":{"ApiContentAccessMetapropertiesRequest1":{"title":"ApiContentAccessMetapropertiesRequest1","type":"object","properties":{"contentAccessIds":{"type":"array","items":{"type":"string"},"description":""}}}},"securitySchemes":{"permanentToken":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://DefaultParameterValue/","tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}}}}}},"security":[{"OAuth2":[]},{"permanentToken":[]}],"tags":[{"name":"Access rights","description":""}]}}
{"source_url":"https://api.bynder.com/reference/delete_api-media-options.md","page_updatedAt":"2026-05-15T13:36:18.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"ARCHIVEDOWNLOAD":"","ARCHIVEMEDIA":"","EMARGOMEDIA":"","KEYVISUALDOWNLOAD":"","MARKPUBLIC":"","MEDIAEDIT":"","MEDIAREMOVE":"","STATISTICS":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"ARCHIVEDOWNLOAD":"","ARCHIVEMEDIA":"","EMARGOMEDIA":"","KEYVISUALDOWNLOAD":"","MARKPUBLIC":"","MEDIAEDIT":"","MEDIAREMOVE":"","STATISTICS":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Asset Management API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/media/options":{"delete":{"requestBody":{"content":{"application/json":{"schema":{"properties":{"asset_id":{"example":"00000000-0000-0000-0000000000000000","type":"string"},"metaproperty_id":{"example":"00000000-0000-0000-0000000000000000","type":"string"},"metaproperty_option_ids":{"items":{"example":"00000000-0000-0000-0000000000000000","type":"string"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"204":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"No Content","type":"string"},"statuscode":{"example":204,"type":"integer"}},"type":"object"}}},"description":"No Content"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Access denied","type":"string"},"statuscode":{"example":403,"type":"integer"}},"type":"object"}}},"description":"Access denied"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Not Found","type":"string"},"statuscode":{"example":404,"type":"integer"}},"type":"object"}}},"description":"Not Found"}},"security":[{"permanentToken":["MEDIAEDIT"]},{"OAuth2":["MEDIAEDIT"]}],"summary":"Delete metaproperty options","tags":["Media options"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"","name":"Media options"}]}}
{"source_url":"https://api.bynder.com/reference/delete_api-media-usage.md","page_updatedAt":"2026-01-29T09:49:04.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Asset Usage API","version":"1.0.0","description":"These calls allow you to keep track of assets being exported from Bynder and imported into a third party application. In order to get started or find an existing integration id you should check out this [Bynder support](https://help.bynder.com/en/216226-track-asset-usage.html#UUID-5db586ff-9502-8e5b-4355-ca3630fceee3_N1579707153615_body) article. If you want to register a new third party application please contact us at [support@bynder.com](mailto:support@bynder.com).\n"},"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["STATISTICS"]},{"permanentToken":["STATISTICS"]}],"tags":[{"name":"Asset Usage","description":"These calls allow you to keep track of assets being exported from Bynder and imported into a third party application. In order to get started or find an existing integration id you should check out this Bynder support article. If you want to register a new third party application please contact us at [support@bynder.com](mailto:support@bynder.com).\n\n__Warning:__ Requires the STATISTICS security role.\n"}],"paths":{"/api/media/usage":{"delete":{"summary":"Delete asset usage","description":"Delete an asset usage entry.","tags":["Asset Usage"],"parameters":[{"in":"query","name":"integration_id","schema":{"type":"string"},"description":"Integration id."},{"in":"query","name":"asset_id","schema":{"type":"string"},"description":"Asset id."},{"in":"query","name":"uri","schema":{"type":"string"},"description":"Asset location."}],"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"integration_id":{"type":"string"},"asset_id":{"type":"string"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"STATISTICS":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"STATISTICS":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/delete_api-v4-collections-id-media.md","page_updatedAt":"2026-01-07T13:31:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Collections API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Collections assets","description":""}],"paths":{"/api/v4/collections/{id}/media":{"delete":{"summary":"Remove assets from a collection","description":"Remove assets from a specific collection by ID.","tags":["Collections assets"],"security":[{"OAuth2":["COLLECTIONS"]},{"permanentToken":["COLLECTIONS"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"deleteIds","in":"query","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000"}}],"responses":{"204":{"description":"No Content"},"403":{"description":"Access denied.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Access denied"},"statuscode":{"type":"integer","example":403}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/delete_api-v4-collections-id.md","page_updatedAt":"2026-01-07T13:31:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Collections API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Collections ID","description":""}],"paths":{"/api/v4/collections/{id}":{"delete":{"summary":"Delete collection","description":"Delete a specific collection by ID.","tags":["Collections ID"],"security":[{"OAuth2":[]},{"permanentToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Collection not found.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Collection not found"},"statuscode":{"type":"integer","example":404}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/delete_api-v4-media-id.md","page_updatedAt":"2026-05-15T13:36:18.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"ARCHIVEDOWNLOAD":"","ARCHIVEMEDIA":"","EMARGOMEDIA":"","KEYVISUALDOWNLOAD":"","MARKPUBLIC":"","MEDIAEDIT":"","MEDIAREMOVE":"","STATISTICS":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"ARCHIVEDOWNLOAD":"","ARCHIVEMEDIA":"","EMARGOMEDIA":"","KEYVISUALDOWNLOAD":"","MARKPUBLIC":"","MEDIAEDIT":"","MEDIAREMOVE":"","STATISTICS":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Asset Management API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/v4/media/{id}":{"delete":{"description":"Requires the **MEDIAREMOVE** security role.","parameters":[{"description":"OAuth 2.0 Bearer access token.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Asset id.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"statuscode":{"type":"string"}},"type":"object"}}},"description":"Access denied"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"statuscode":{"type":"string"}},"type":"object"}}},"description":"Media not found"}},"security":[{"permanentToken":["","MEDIAREMOVE"]},{"OAuth2":["","MEDIAREMOVE"]}],"summary":"Delete asset","tags":["Media ID"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"","name":"Media ID"}]}}
{"source_url":"https://api.bynder.com/reference/delete_api-v4-metaproperties-id-options-optionid-dependencies-dependencyid.md","page_updatedAt":"2026-05-11T06:38:49.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Dependencies for Metaproperties and Options","version":"1.0.0"},"tags":[{"name":"Option dependency (Please use new Automations API if possible)"}],"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"paths":{"/api/v4/metaproperties/{id}/options/{optionId}/dependencies/{dependencyId}":{"delete":{"summary":"Delete a dependency","description":"Delete a dependency from a metaproperty option.","tags":["Option dependency (Please use new Automations API if possible)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"dependencyId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unknown metaproperty"},"statuscode":{"type":"string","example":"404"}}},"examples":{"example-unknown-metaproperty":{"value":{"message":"Unknown metaproperty","statuscode":404}},"example-unknown-metaproperty-option":{"value":{"message":"Unknown metaproperty option","statuscode":404}},"example-unknown-dependency-option":{"value":{"message":"Unknown dependency option","statuscode":404}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/delete_api-v4-metaproperties-id-options-optionid-dependencies-group-groupid-dependencyid.md","page_updatedAt":"2026-05-11T06:38:49.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Dependencies for Metaproperties and Options","version":"1.0.0"},"tags":[{"name":"Option dependency group (Please use new Automations API if possible)"}],"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"paths":{"/api/v4/metaproperties/{id}/options/{optionId}/dependencies/group/{groupId}/{dependencyId}":{"delete":{"summary":"Remove a dependency option from a group","description":"Remove a dependency option from a specific dependency group for a metaproperty option.","tags":["Option dependency group (Please use new Automations API if possible)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"description":"The id of the metaproperty the (metaproperty) option belongs to."},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"description":"The id of the (metaproperty) option the dependency group belongs to."},{"name":"groupId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"description":"The id of the dependency group you’d like to remove a dependency from."},{"name":"dependencyId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"description":"The id of the dependency (metaproperty option) you’d like to remove from the dependency group."}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unknown metaproperty"},"statuscode":{"type":"string","example":"404"}}},"examples":{"example-unknown-metaproperty":{"value":{"message":"Unknown metaproperty","statuscode":"404"}},"example-unknown-metaproperty-option":{"value":{"message":"Unknown metaproperty option","statuscode":"404"}},"example-unknown-group":{"value":{"message":"Unknown group","statuscode":"404"}},"example-unknown-dependency-option":{"value":{"message":"Unknown dependency option","statuscode":"404"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/delete_api-v4-metaproperties-id-options-optionid.md","page_updatedAt":"2026-05-11T06:38:40.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty options","version":"1.0"},"openapi":"3.1.0","paths":{"/api/v4/metaproperties/{id}/options/{optionId}":{"delete":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}},{"in":"path","name":"optionId","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"responses":{"204":{"content":{"application/json":{"example":{"message":"Meta property option deleted successfully","statuscode":"204"}}},"description":"No Content"},"404":{"content":{"application/json":{"examples":{"notFound":{"value":{"message":"Meta property option not found","statuscode":"404"}}},"schema":{"properties":{"message":{"example":"Meta property option not found","type":"string"},"statuscode":{"example":"404","type":"string"}},"type":"object"}}},"description":"Meta property option not found"}},"summary":"Delete option","tags":["Options - Old API (Please use new API if possible)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Options - Old API (Please use new API if possible)"}]}}
{"source_url":"https://api.bynder.com/reference/delete_api-v4-metaproperties-id.md","page_updatedAt":"2026-05-11T07:21:24.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty","version":"1.0"},"openapi":"3.1.0","paths":{"/api/v4/metaproperties/{id}":{"delete":{"description":"Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.","parameters":[{"description":"Metaproperty id.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"content":{"application/json":{"examples":{"example-1":{"value":{"message":"Metaproperty not found","statuscode":404}}}}},"description":"Metaproperty not found"}},"summary":"Delete metaproperty","tags":["Metaproperties - Old API (Please use new API if possible)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Metaproperties - Old API (Please use new API if possible)"}]}}
{"source_url":"https://api.bynder.com/reference/delete_api-v4-tags-id-media.md","page_updatedAt":"2026-01-07T10:53:22.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Tags API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Tags","description":""}],"paths":{"/api/v4/tags/{id}/media":{"delete":{"summary":"Remove tag from assets","description":"Remove a tag from a list of assets.","tags":["Tags"],"security":[{"OAuth2":["MEDIAEDIT","MEDIAAUDIT"]},{"permanentToken":["MEDIAEDIT","MEDIAAUDIT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"deleteIds","in":"query","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Media not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Media 00000000-0000-0000-0000000000000000 not found"},"statuscode":{"type":"integer","example":404}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"MEDIAEDIT":"","MEDIAAUDIT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"MEDIAEDIT":"","MEDIAAUDIT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/delete_api-v4-users-id.md","page_updatedAt":"2026-01-06T13:41:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Users","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Users ID","description":"Manage specific users by their ID. This includes retrieving, updating, and deleting user information based on the user ID.\n"}],"paths":{"/api/v4/users/{id}":{"delete":{"summary":"Delete user","tags":["Users ID"],"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The id or username of the user you’d like to delete."}],"responses":{"204":{"description":"User deleted"}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"Grants permission to manage users"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"Grants permission to manage users"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/delete_api-workflow-campaigns-id.md","page_updatedAt":"2026-01-07T16:02:10.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Campaigns API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Campaigns","description":""}],"paths":{"/api/workflow/campaigns/{id}":{"delete":{"summary":"Delete campaign","description":"Requires the CAMPAIGNREMOVE security role.","tags":["Campaigns"],"security":[{"OAuth2":["CAMPAIGNREMOVE"]},{"permanentToken":["CAMPAIGNREMOVE"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"responses":{"204":{"description":"Campaign deleted successfully"}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"CAMPAIGNOVERVIEW":"","CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"CAMPAIGNOVERVIEW":"","CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/delete_api-workflow-groups-id.md","page_updatedAt":"2026-01-07T15:22:03.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Users and Groups API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Groups","description":""}],"paths":{"/api/workflow/groups/{id}":{"delete":{"summary":"Delete group","tags":["Groups"],"security":[{"permanentToken":["GROUPOVERVIEW","WORKFLOWADMIN"]},{"OAuth2":["GROUPOVERVIEW","WORKFLOWADMIN"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"responses":{"204":{"description":"Group deleted"}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/delete_api-workflow-jobs-id.md","page_updatedAt":"2026-05-15T13:16:00.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Jobs API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Jobs","description":""}],"paths":{"/api/workflow/jobs/{id}":{"delete":{"summary":"Delete job","description":"Requires the JOBREMOVE security role.","tags":["Jobs"],"security":[{"permanentToken":["JOBREMOVE"]},{"OAuth2":["JOBREMOVE"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"00000000-0000-0000-0000-000000000000"}],"responses":{"204":{"description":"No Content","content":{"application/json":{"examples":{"example-1":{"value":{}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/deleteapi1assetassetsassetid.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashAssetReply":{"properties":{"assetId":{"type":"string"}},"title":"TrashAssetReply","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}":{"delete":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Delete an asset that is currently in draft. Due to the draft state, you cannot restore the asset from the trashcan.","operationId":"deleteApi1AssetAssetsAssetid","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrashAssetReply"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Delete asset","tags":["General endpoints"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Retrieve, validate, and manage existing assets and their versions.","name":"General endpoints"}]}}
{"source_url":"https://api.bynder.com/reference/deleteapi1assetassetsassetidembargosembargoid.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DeleteEmbargoReply":{"properties":{"assetId":{"type":"string"}},"title":"DeleteEmbargoReply","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/embargos/{embargoId}":{"delete":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Completely delete an existing asset embargo.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"deleteApi1AssetAssetsAssetidEmbargosEmbargoid","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"embargoId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteEmbargoReply"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Delete embargo","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/deleteapi1assetassetsassetidmetapropertiesmetapropertyid.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"AssetTaxonomy":{"properties":{"assetId":{"type":"string"},"id":{"type":"string"},"metaPropertyOptionGroups":{"items":{"$ref":"#/components/schemas/MetaPropertyOptionGroup"},"type":"array"},"metaPropertyValues":{"items":{"$ref":"#/components/schemas/MetaPropertyValue"},"type":"array"},"metadata":{"items":{"$ref":"#/components/schemas/AssetTaxonomyMetaDataValue"},"type":"array"},"portalId":{"type":"string"},"taxonomyStatus":{"type":"string"},"timeStampModified":{"format":"date-time","type":"string"},"versionId":{"type":"string"}},"title":"AssetTaxonomy","type":"object"},"AssetTaxonomyMetaDataValue":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"AssetTaxonomyMetaDataValue","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"MetaPropertyOptionGroup":{"properties":{"isRemoved":{"type":"boolean"},"metaPropertyId":{"type":"string"},"metaPropertyType":{"$ref":"#/components/schemas/MetaPropertyType"},"values":{"items":{"$ref":"#/components/schemas/ValueReference"},"type":"array"}},"title":"MetaPropertyOptionGroup","type":"object"},"MetaPropertyType":{"enum":["option","tag","autotag"],"title":"MetaPropertyType","type":"string"},"MetaPropertyValue":{"properties":{"isRemoved":{"type":"boolean"},"metaPropertyId":{"type":"string"},"metaPropertyType":{"$ref":"#/components/schemas/MetaPropertyValueType"},"value":{"type":"string"}},"title":"MetaPropertyValue","type":"object"},"MetaPropertyValueType":{"enum":["text","date"],"title":"MetaPropertyValueType","type":"string"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"},"ValueReference":{"properties":{"id":{"type":"string"},"isRemoved":{"type":"boolean"}},"title":"ValueReference","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/metaproperties/{metapropertyId}":{"delete":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Delete a metaproperties options or value from an asset.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"deleteApi1AssetAssetsAssetidMetapropertiesMetapropertyid","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"metapropertyId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetTaxonomy"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Delete individual asset metaproperty","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/deleteapi1assetassetsassetidrelationsrelationid.md","page_updatedAt":"2026-08-13T14:57:10.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RemoveAssetRelationInput":{"properties":{"relatedAssetIds":{"items":{"type":"string"},"type":"array"}},"title":"RemoveAssetRelationInput","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateAssetRelationReply":{"properties":{"assetId":{"type":"string"},"portalId":{"type":"string"},"relatedAssetIds":{"items":{"type":"string"},"type":"array"},"relationId":{"type":"string"}},"title":"UpdateAssetRelationReply","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/relations/{relationId}":{"delete":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Remove one or more assets from the set of assets the given asset is related to. This removes the bidirectional relation between the given asset and the assets given as input.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"deleteApi1AssetAssetsAssetidRelationsRelationid","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"relationId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveAssetRelationInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetRelationReply"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Remove asset relations","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/deleteapi1automationautomationsautomationid.md","page_updatedAt":"2026-05-11T06:38:26.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automations API","version":"1.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"paths":{"/api/1/automation/automations/{automationId}":{"delete":{"tags":["Automations - New taxonomy API"],"summary":"Delete automation","description":"Delete an automation by id.","operationId":"deleteApi1AutomationAutomationsAutomationid","parameters":[{"name":"x-api-correlation-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"automationId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"202":{"description":"","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}}},"examples":{"AutomationDeletedOutput":{"summary":"Response when automation was successfully deleted","value":{"message":"The automation has been deleted"}}}}}},"401":{"description":"","content":{"application/json":{"schema":{"required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}}}}},"404":{"description":"","content":{"application/json":{"schema":{"required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"AutomationNotFoundOutput":{"summary":"Response when automation was not found","value":{"errorCode":"automation-not-found","message":"The automation was not found"}}}}}}},"security":[{"httpAuth":[]}]}}},"components":{"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/deleteapi1taxonomymetapropertiesmetapropertyid.md","page_updatedAt":"2026-05-11T07:21:24.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty","version":"1.0"},"openapi":"3.1.0","paths":{"/api/1/taxonomy/metaproperties/{metapropertyId}":{"delete":{"description":"Delete a metaproperty by id","operationId":"deleteApi1TaxonomyMetapropertiesMetapropertyid","parameters":[{"in":"path","name":"metapropertyId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"MetapropertyDeleted":{"summary":"Response when the metaproperty is deleted","value":{"message":"Metaproperty has been deleted"}}},"schema":{"properties":{"message":{"type":"string"}},"required":["message"],"title":"MetapropertyDeletedOutput","type":"object"}}},"description":""},"404":{"content":{"application/json":{"examples":{"MetapropertyNotExisting":{"summary":"Response when the metaproperty does not exist","value":{"errorCode":"metaproperty-not-existing","message":"Metaproperty does not exist"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"title":"MetapropertyNotExistingOutput","type":"object"}}},"description":""}},"summary":"Delete metaproperty","tags":["Metaproperties - New API (Preferred)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Metaproperties - New API (Preferred)"}]}}
{"source_url":"https://api.bynder.com/reference/deleteapi1taxonomymetapropertiesmetapropertyidoptionsoptionid.md","page_updatedAt":"2026-05-11T06:38:40.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty options","version":"1.0"},"openapi":"3.1.0","paths":{"/api/1/taxonomy/metaproperties/{metapropertyId}/options/{optionId}":{"delete":{"description":"Delete an option by id","operationId":"deleteApi1TaxonomyMetapropertiesMetapropertyidOptionsOptionid","parameters":[{"in":"path","name":"metapropertyId","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"optionId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"OptionDeleted":{"summary":"Response when the option is deleted","value":{"message":"Metaproperty option has been deleted"}}},"schema":{"properties":{"message":{"type":"string"}},"required":["message"],"title":"OptionDeletedOutput","type":"object"}}},"description":""},"404":{"content":{"application/json":{"examples":{"OptionNotExisting":{"summary":"Response when the option does not exist","value":{"errorCode":"option-not-existing","message":"Option does not exist"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"title":"OptionNotExistingOutput","type":"object"}}},"description":""}},"summary":"Delete option","tags":["Options - New API (Preferred)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Options - New API (Preferred)"}]}}
{"source_url":"https://api.bynder.com/reference/deleteawebhookconfiguration.md","page_updatedAt":"2026-08-03T15:12:29.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Webhooks API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}}],"tags":[{"name":"Configurations","description":""}],"paths":{"/v7/webhooks/public/api/subscriptions/{id}":{"delete":{"summary":"Delete a Webhook Configuration","description":"Please be aware that using this endpoint requires the `Manage Webhooks configurations` security role.","tags":["Configurations"],"operationId":"DeleteaWebhookConfiguration","parameters":[{"name":"id","in":"path","description":"Webhook configuration ID.","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"204":{"description":"Webhook deleted successfully","headers":{},"content":{}}},"deprecated":false},"parameters":[]}}}}
{"source_url":"https://api.bynder.com/reference/deletegroup.md","page_updatedAt":"2026-07-15T15:50:57.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Groups","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Groups (Preferred)"}],"paths":{"/api/1/groups/{groupId}":{"delete":{"operationId":"deleteGroup","summary":"Delete a group","description":"Deletes a group and removes all its members from it.\n\nRequires the **GROUPMANAGEMENT** security role.\n","tags":["Groups (Preferred)"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"ID of the group to delete (hyphens optional)."}],"responses":{"204":{"description":"Group deleted successfully. No content is returned."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"description":"Validation error (malformed group ID)."}},"security":[{"permanentToken":["GROUPMANAGEMENT"]},{"OAuth2":["GROUPMANAGEMENT"]}]}}},"components":{"responses":{"Unauthorized":{"description":"Missing or invalid authentication. The response body is empty."},"Forbidden":{"description":"The authenticated user does not have the **GROUPMANAGEMENT** security role."},"NotFound":{"description":"Group not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"schemas":{"NotFoundResponse":{"type":"object","properties":{"detail":{"type":"string","example":"Not Found"}}}},"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups`"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/deleterulesruleid.md","page_updatedAt":"2026-01-27T09:17:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automation Workflow API","version":"1.0.0","description":"\nThis API allows clients to manage automation-workflow rules.\n\n<b>Servers:</b>\n\n1. <b>Local Development:</b>\n   - Base URL: http://localhost:8080/{endpoint}\n\n2. <b>Stage or Production:</b>\n   - Base URL: https://automation-workflow-service.bynder.com/api/1/automation-workflow/{endpoint}\n\nEnsure you're using the correct server depending on the environment you're working in (local or production).\n  "},"servers":[{"url":"https://{your-bynder-domain}/api/1/automation-workflow/"}],"paths":{"/rules/{ruleId}":{"delete":{"tags":["Automation Workflow Rules"],"summary":"Deletes an automation workflow rule.","description":"Deletes an automation workflow rule by its ID.","operationId":"deleteRulesRuleid","parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseNotFound"}}}}},"security":[{},{"httpAuth":[]}]}}},"components":{"schemas":{"ErrorAuthorizationResponse":{"title":"ErrorAuthorizationResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponse":{"title":"ErrorResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponseNotFound":{"title":"ErrorResponseNotFound","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}},"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/finalise-an-uploaded-file.md","page_updatedAt":"2026-07-21T13:27:24.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Upload Assets API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://bynder-public-us-east-1.s3.amazonaws.com/","variables":{}}],"paths":{"/api/v4/upload/{uploadId}/":{"post":{"tags":["Step 4 EITHER Finalise uploaded file"],"summary":"Finalise an uploaded file","description":"The endpoints described in Step 4 are an Either/Or choice. You should use either the `Finalise an uploaded file` endpoint to finalize and process a standard upload, or the `Finalize additional file` endpoint to finalize and save an additional uploaded file as a new asset.","operationId":"Finalise an uploaded file","parameters":[{"name":"uploadId","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["T3.fS5.5HPhtYFtm2b_.e7wVe910tL5XQutKw1jkMqlP5cPQVyZkOZxZ9lJiGUk4FIw6M0CFZ3xogTWrm.GPI2p2CaglQcAS5aH37zT_vHJnbtkebYbheXIQc_.M_6hM"]}},{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"$ref":"#/components/schemas/Content-Type"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"required":["targetid","s3_filename","chunks"],"type":"object","properties":{"targetid":{"type":"string","description":"Target id as returned by the initialise call.","examples":["final/E3333526-7F87-49F9-B49C0054C0D31477/Logo.png"]},"s3_filename":{"type":"string","description":"Base location of the uploaded file.","examples":["api_uploads/159D8D4B-B981-49B8-BF0569FD144CB359/A29FABF0-26B8-44BF-890920E4C09E7C11/Logo.png"]},"chunks":{"type":"number","description":"Total number of chunks uploaded.","contentEncoding":"double","examples":[5]},"original_filename":{"type":"string","description":"Filename including special characters to be displayed in Bynder.","examples":["Logo.png"]}},"contentMediaType":"application/x-www-form-urlencoded"}}},"required":false},"responses":{"202":{"description":"Accepted","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiV4UploadResponse1"}}}},"500":{"description":"Internal Server Error","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiV4Upload500Error1"}}}}},"deprecated":false},"parameters":[]}},"components":{"schemas":{"File":{"title":"File","type":"object","properties":{"bucket":{"type":"string","examples":["BUCKET"]},"path":{"type":"string","examples":["final/2ba07d00-586a-4a44-b13c-c58598cfe828/IMG_1874.JPG"]},"type":{"type":"string","examples":["s3"]}}},"ApiV4Upload500Error1":{"title":"ApiV4Upload500Error1","type":"object","properties":{"message":{"type":"string","examples":["Could not complete upload"]},"retry":{"type":"integer","contentEncoding":"int32","examples":[1]},"success":{"type":"boolean","examples":[false]}}},"ApiV4UploadResponse1":{"title":"ApiV4UploadResponse1","type":"object","properties":{"output":{"type":"string","examples":["final/2ba07d00-586a-4a44-b13c-c58598cfe828/"]},"batchId":{"type":"string","examples":["00000000-0000-0000-0000000000000000"]},"file":{"$ref":"#/components/schemas/File"},"filename":{"type":"string","examples":["final/2ba07d00-586a-4a44-b13c-c58598cfe828/IMG_1874.JPG"]},"importId":{"type":"string","examples":["000000000-0000-0000-0000000000000000"]},"locationType":{"type":"string","examples":["s3"]},"success":{"type":"integer","contentEncoding":"int32","examples":[1]}}},"Content-Type":{"title":"Content-Type","const":"application/x-www-form-urlencoded","type":"string"}}},"security":[],"tags":[{"name":"Step 4 EITHER Finalise uploaded file","description":""}]}}
{"source_url":"https://api.bynder.com/reference/finalize-additional-file.md","page_updatedAt":"2026-07-21T13:27:24.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Upload Assets API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://bynder-public-us-east-1.s3.amazonaws.com/","variables":{}}],"paths":{"/api/v4/media/{id}/save/additional/{uploadId}/":{"post":{"tags":["Step 4 OR Finalize and save an additional uploaded file as a new asset."],"summary":"Finalize additional file","description":"The endpoints described in Step 4 are an Either/Or choice. You should use either the `Finalise an uploaded file` endpoint to finalize and process a standard upload, or the `Finalize additional file` endpoint to finalize and save an additional uploaded file as a new asset.","operationId":"Finalize additional file","parameters":[{"name":"id","in":"path","description":"Asset id to which to save the new additional.","required":true,"style":"simple","schema":{"type":"string","examples":["00000000-0000-0000-0000-000000000000"]}},{"name":"uploadId","in":"path","description":"The upload id of the file.","required":true,"style":"simple","schema":{"type":"string","examples":["T3.fS5.5HPhtYFtm2b_.e7wVe910tL5XQutKw1jkMqlP5cPQVyZkOZxZ9lJiGUk4FIw6M0CFZ3xogTWrm.GPI2p2CaglQcAS5aH37zT_vHJnbtkebYbheXIQc_.M_6hM"]}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target id as returned by the initialise call.","examples":["final/00000000-0000-0000-0000-000000000000/Logo.png"]},"s3_filename":{"type":"string","description":"Base location of the uploaded file.","examples":["api_uploads/00000000-0000-0000-0000-000000000000/00000000-0000-0000-000000000000/Logo.png"]},"chunks":{"type":"number","description":"Total number of chunks uploaded.","examples":[5]}}}}}},"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"examples":[{"mediaid":"00000000-0000-0000-0000000000000000","batchId":"00000000-0000-0000-0000000000000000","success":true,"mediaitems":[{"original":"final/00000000-0000-0000-0000000000000000/image.jpg","destination":"___URL_TO_BYNDER_CDN___"},{"original":"final/00000000-0000-0000-0000000000000000/thul-image.jpg","destination":"___URL_TO_BYNDER_CDN___"},{"original":"final/00000000-0000-0000-0000000000000000/mini-image.jpg","destination":"___URL_TO_BYNDER_CDN___"}]}],"contentMediaType":"application/json"},"examples":{"success":{"summary":"Successful response","value":{"mediaid":"00000000-0000-0000-0000000000000000","batchId":"00000000-0000-0000-0000000000000000","success":true,"mediaitems":null}}}}}}},"deprecated":false},"parameters":[]}},"security":[],"tags":[{"name":"Step 4 OR Finalize and save an additional uploaded file as a new asset.","description":""}]}}
{"source_url":"https://api.bynder.com/reference/get-closest-amazon-s3-upload-endpoint.md","page_updatedAt":"2026-07-21T13:27:24.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Upload Assets API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://bynder-public-us-east-1.s3.amazonaws.com/","variables":{}}],"paths":{"/api/upload/endpoint":{"get":{"tags":["Step 1 Get closest AmazonS3 upload endpoint"],"summary":"Get closest Amazon S3 upload endpoint","description":"Get the closest AmazonS3 upload endpoint.","operationId":"Get closest Amazon S3 upload endpoint","parameters":[],"responses":{"200":{"description":"Successful response","headers":{},"content":{"application/json":{"schema":{"type":"string","examples":["https://bynder-public-eu-central-1.s3.amazonaws.com/"],"contentMediaType":"application/json"},"example":"https://bynder-public-eu-central-1.s3.amazonaws.com/"}}}},"deprecated":false,"security":[{"OAuth2":["MEDIAUPLOAD","MEDIAUPLOADFORAPPROVAL"]},{"permanentToken":["MEDIAUPLOAD","MEDIAUPLOADFORAPPROVAL"]}]},"parameters":[]}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://your-bynder-domainDefaultValue/token","scopes":{"MEDIAUPLOAD":"","MEDIAUPLOADFORAPPROVAL":""}},"authorizationCode":{"authorizationUrl":"https://your-bynder-domainDefaultValue/","tokenUrl":"https://your-bynder-domainDefaultValue/token","scopes":{"MEDIAUPLOAD":"","MEDIAUPLOADFORAPPROVAL":""}}}}}},"security":[],"tags":[{"name":"Step 1 Get closest AmazonS3 upload endpoint","description":"This endpoint gets the AmazonS3 endpoint that is closest to your current location."}]}}
{"source_url":"https://api.bynder.com/reference/get_api-1-content-access-options-optionid-visibility.md","page_updatedAt":"2026-07-13T13:24:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Access Rights and Options API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}}],"paths":{"/api/1/content-access/options/{optionId}/visibility":{"get":{"summary":"Retrieve Option Default Visibility","tags":["Options"],"parameters":[{"name":"optionId","in":"path","required":true,"schema":{"type":"string"},"description":"Option ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"defaultVisibility":{"type":"boolean"}}}}}},"403":{"description":"Forbidden"}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://DefaultParameterValue/","tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}}}}}},"security":[{"OAuth2":[]},{"permanentToken":[]}],"tags":[{"name":"Options","description":""}]}}
{"source_url":"https://api.bynder.com/reference/get_api-1-content-access-options-optionid.md","page_updatedAt":"2026-01-21T16:37:01.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Access Rights and Options API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}}],"paths":{"/api/1/content-access/options/{optionId}":{"get":{"summary":"Retrieve Option Access Rights","tags":["Options"],"parameters":[{"name":"optionId","in":"path","required":true,"schema":{"type":"string"},"description":"Option ID"},{"name":"principalId","in":"query","required":false,"schema":{"type":"string"},"description":"Principal ID"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":20,"minimum":1,"maximum":1000},"description":"Number of results to return"},{"name":"start","in":"query","required":false,"schema":{"type":"string"},"description":"Cursor for next page"},{"name":"before","in":"query","required":false,"schema":{"type":"string"},"description":"Cursor for previous page"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesResponse"}}}}},"403":{"description":"Forbidden"}}}}},"components":{"schemas":{"ApiContentAccessMetapropertiesResponse":{"title":"ApiContentAccessMetapropertiesResponse","type":"object","properties":{"id":{"type":"string","examples":["00000000-0000-0000-0000-000000000000"]},"contentId":{"type":"string","examples":["00000000-0000-0000-0000-000000000000"]},"contentType":{"type":"string","examples":["metaproperty"]},"level":{"type":"string","examples":["metaproperty.hide"]},"ruleType":{"type":"string","examples":["allow"]},"principalId":{"type":"string","examples":["00000000-0000-0000-0000-000000000000"]},"principalType":{"type":"string","examples":["user"]},"principalName":{"type":"string","examples":["User full name"]},"principalExtraInformation":{"$ref":"#/components/schemas/PrincipalExtraInformation"}}},"PrincipalExtraInformation":{"title":"PrincipalExtraInformation","type":"object","properties":{"email":{"type":"string","examples":["user_email@bynder.com"]}}}},"securitySchemes":{"permanentToken":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://DefaultParameterValue/","tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}}}}}},"security":[{"OAuth2":[]},{"permanentToken":[]}],"tags":[{"name":"Options","description":""}]}}
{"source_url":"https://api.bynder.com/reference/get_api-media-usage.md","page_updatedAt":"2026-01-29T09:49:04.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Asset Usage API","version":"1.0.0","description":"These calls allow you to keep track of assets being exported from Bynder and imported into a third party application. In order to get started or find an existing integration id you should check out this [Bynder support](https://help.bynder.com/en/216226-track-asset-usage.html#UUID-5db586ff-9502-8e5b-4355-ca3630fceee3_N1579707153615_body) article. If you want to register a new third party application please contact us at [support@bynder.com](mailto:support@bynder.com).\n"},"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["STATISTICS"]},{"permanentToken":["STATISTICS"]}],"tags":[{"name":"Asset Usage","description":"These calls allow you to keep track of assets being exported from Bynder and imported into a third party application. In order to get started or find an existing integration id you should check out this Bynder support article. If you want to register a new third party application please contact us at [support@bynder.com](mailto:support@bynder.com).\n\n__Warning:__ Requires the STATISTICS security role.\n"}],"paths":{"/api/media/usage":{"get":{"summary":"Retrieve asset usage","description":"Retrieve asset usage information.","tags":["Asset Usage"],"parameters":[{"in":"query","name":"asset_id","schema":{"type":"string"},"description":"Asset id."},{"in":"query","name":"integration_id","schema":{"type":"string"},"description":"Integration id."},{"in":"query","name":"uri","schema":{"type":"string"},"description":"URI."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"asset_id":{"type":"string"},"id":{"type":"string"},"integration":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"},"uri":{"type":"string"},"additional":{"type":"string"}}}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"asset_id":{"type":"string"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"STATISTICS":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"STATISTICS":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-pim-metaproperties-id-options.md","page_updatedAt":"2026-01-07T16:10:48.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Product Layer Metaproperties API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Options","description":""}],"paths":{"/api/pim/metaproperties/{id}/options":{"get":{"summary":"Retrieve metaproperty options","description":"Retrieve a paginated list of options for the given metaproperty id.","tags":["Options"],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-0000000000000000"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"example":"asc"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","example":20}}],"responses":{"200":{"description":"Successfully retrieved metaproperty options","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"Product A option 1"},"label":{"type":"string","example":"Product A option 1"},"description":{"type":"string","example":"Metaproperty option 1 for Product A"},"metapropertyid":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"product_options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"Product A option 1 child"},"label":{"type":"string","example":"Product A option 1 child"},"description":{"type":"string","example":"Metaproperty option 1 child"},"metapropertyid":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"metaproperty.view":"","METAPROPERTYMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"metaproperty.view":"","METAPROPERTYMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-pim-metaproperties-id.md","page_updatedAt":"2026-01-07T16:10:48.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Product Layer Metaproperties API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Metaproperties","description":""}],"paths":{"/api/pim/metaproperties/{id}":{"get":{"summary":"Retrieve specific metaproperty","description":"Retrieve the details of a specific metaproperty.","tags":["Metaproperties"],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-0000000000000000"}}],"responses":{"200":{"description":"Successfully retrieved specific metaproperty","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"Product A"},"label":{"type":"string","example":"Product A"},"description":{"type":"string","example":"Metaproperty for Product A"},"mp_options":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"Product A option 1"},"label":{"type":"string","example":"Product A option 1"},"description":{"type":"string","example":"Metaproperty option 1 for Product A"},"metapropertyid":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"relations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"Product B option 1"},"label":{"type":"string","example":"Product B option 1"},"description":{"type":"string","example":"Metaproperty option 1 for Product B"},"metapropertyid":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"metaproperty.view":"","METAPROPERTYMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"metaproperty.view":"","METAPROPERTYMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-pim-metaproperties.md","page_updatedAt":"2026-01-07T16:10:48.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Product Layer Metaproperties API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Metaproperties","description":""}],"paths":{"/api/pim/metaproperties":{"get":{"summary":"Retrieve metaproperties","description":"Retrieve a list of metaproperties.","tags":["Metaproperties"],"security":[{"OAuth2":["metaproperty.view"]},{"permanentToken":["metaproperty.view"]}],"responses":{"200":{"description":"Successfully retrieved metaproperties","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"metaproperty.view":"","METAPROPERTYMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"metaproperty.view":"","METAPROPERTYMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-store-order-id-products.md","page_updatedAt":"2026-01-09T14:05:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Brandstore API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Orders","description":""}],"paths":{"/api/store/order/{id}/products":{"get":{"summary":"Retrieve specific order by id","tags":["Orders"],"security":[{"permanentToken":["brandstore.orderadmin.edit"]},{"OAuth2":["brandstore.orderadmin.edit"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"responses":{"200":{"description":"Specific order products","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"orderId":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"product":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"Train the trainer product"},"description":{"type":"string","example":"This is such a nice product!"},"isFeatured":{"type":"boolean","example":false},"product_number":{"type":"string","example":"999999999"},"size_height":{"type":"number","example":1},"size_width":{"type":"number","example":1},"size_depth":{"type":"number","example":1},"weight":{"type":"number","example":1},"min_quantity":{"type":"integer","example":1},"max_quantity":{"type":"integer","example":10},"default_quantity":{"type":"integer","example":1},"datecreated":{"type":"string","example":"2016-08-10T12:14:16+00:00"},"isActive":{"type":"boolean","example":true},"product_type":{"type":"string","example":"print"},"product_package":{"type":"string","example":"unit"},"sku":{"type":"string","example":"1"},"step":{"type":"integer","example":1},"display_length_unit":{"type":"string","example":"cm"},"isFree":{"type":"boolean","example":false},"isShipping":{"type":"boolean","example":false}}},"referenceId":{"type":"string","example":"999999999"},"name":{"type":"string","example":"Train the trainer product"},"itemPrice":{"type":"number","example":0.2333},"quantity":{"type":"integer","example":3}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"brandstore.orderadmin.view":"","brandstore.orderadmin.edit":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"brandstore.orderadmin.view":"","brandstore.orderadmin.edit":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-store-order-id.md","page_updatedAt":"2026-01-09T14:05:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Brandstore API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Orders","description":""}],"paths":{"/api/store/order/{id}/":{"get":{"summary":"Retrieve specific order info","tags":["Orders"],"security":[{"permanentToken":["brandstore.orderadmin.view"]},{"OAuth2":["brandstore.orderadmin.view"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"responses":{"200":{"description":"Specific order information","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"dateCreated":{"type":"string","example":"2015-06-01T08:36:18Z"},"status":{"type":"string","example":"IN_PRODUCTION"},"orderReference":{"type":"string","example":"NL0456"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"brandstore.orderadmin.view":"","brandstore.orderadmin.edit":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"brandstore.orderadmin.view":"","brandstore.orderadmin.edit":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-store-order.md","page_updatedAt":"2026-01-09T14:05:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Brandstore API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Orders","description":""}],"paths":{"/api/store/order/":{"get":{"summary":"Retrieve orders","tags":["Orders"],"security":[{"permanentToken":["brandstore.orderadmin.view"]},{"OAuth2":["brandstore.orderadmin.view"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","example":1}}],"responses":{"200":{"description":"A list of orders","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"order_ref":{"type":"string","example":"NA13334"},"net_price":{"type":"number","example":0},"date_created":{"type":"string","example":"2018-10-25T14:26:01+00:00"},"username":{"type":"string","example":"john.doe@bynder.com"},"account_name":{"type":"string","example":"Bynder"},"order_status":{"type":"string","example":"In production"},"currency_symbol":{"type":"string","example":"8364"}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"brandstore.orderadmin.view":"","brandstore.orderadmin.edit":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"brandstore.orderadmin.view":"","brandstore.orderadmin.edit":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-store-orderproducts-id.md","page_updatedAt":"2026-01-09T14:05:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Brandstore API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Orders","description":""}],"paths":{"/api/store/orderproducts/{id}":{"get":{"summary":"Retrieve specific orderline","tags":["Orders"],"security":[{"permanentToken":["brandstore.orderadmin.view"]},{"OAuth2":["brandstore.orderadmin.view"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"responses":{"200":{"description":"Specific orderline information","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"status":{"type":"string","example":"unknown"},"orderId":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"customerReference":{"type":"string","example":"000000000000"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"brandstore.orderadmin.view":"","brandstore.orderadmin.edit":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"brandstore.orderadmin.view":"","brandstore.orderadmin.edit":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-trash-media.md","page_updatedAt":"2026-01-07T15:13:37.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Trash API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Trash","description":""}],"paths":{"/api/trash/media":{"get":{"summary":"Retrieve recently removed assets","description":"Retrieve assets removed in the last 30 days.","tags":["Trash"],"security":[{"OAuth2":["trash.assets"]},{"permanentToken":["trash.assets"]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":10,"example":20}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"example":1}},{"name":"dateRemoved","in":"query","required":false,"schema":{"type":"string","description":"Set a date range together with the \"dateRemovedFrom\" parameter. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time","example":"2017-04-01T00:00:00Z"}},{"name":"field","in":"query","required":false,"schema":{"type":"string","enum":["media.dateCreated","media.dateRemoved","media.name","media.username"],"example":"media.dateCreated"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"example":"asc"}}],"responses":{"200":{"description":"Successfully retrieved recently removed assets","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"name":{"type":"string","example":"Beach"},"dateRemoved":{"type":"string","format":"date-time","example":"2017-09-05T13:11:49+00:00"},"dateCreated":{"type":"string","format":"date-time","example":"2017-02-12T10:12:19+00:00"},"username":{"type":"string","example":"johndoe@bynder.com"},"userId":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"S3_filepointer":{"type":"string","example":"___URL_TO_BYNDER_CDN___"}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"trash.assets":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"trash.assets":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-account-derivatives.md","page_updatedAt":"2026-01-07T13:07:33.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Account API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":[]},{"permanentToken":[]}],"tags":[{"name":"Account","description":""}],"paths":{"/api/v4/account/derivatives":{"get":{"summary":"Retrieve derivatives","description":"A derivative is a file that is based on another source, for example, a low-resolution representation of a print-quality photo. During the upload process, Bynder can automatically create pre-defined image derivatives with different dimensions, quality, and format. Bynder can either maintain the original aspect ratio of an image, or crop or pad an image to fit the specified dimensions. We can create smaller versions of your original image asset in both a JPG and PNG file extension. However, the resolution of derivatives can't be larger than the original file.\n","tags":["Account"],"responses":{"200":{"description":"Derivatives retrieved successfully","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"prefix":{"type":"string","example":"500x500"},"height":{"type":"integer","example":500},"isCrop":{"type":"boolean","example":true},"dpi":{"type":"integer","example":-1},"width":{"type":"integer","example":500},"allowedTypes":{"type":"string","example":""},"isOnTheFly":{"type":"boolean","example":true},"isExtent":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":true}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-account.md","page_updatedAt":"2026-01-07T13:07:33.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Account API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":[]},{"permanentToken":[]}],"tags":[{"name":"Account","description":""}],"paths":{"/api/v4/account":{"get":{"summary":"Retrieve account information","tags":["Account"],"responses":{"200":{"description":"Account information retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"availableLanguages":{"type":"array","items":{"type":"string"},"example":["nl_NL","en_GB","en_US","fr_FR","de_DE","it_IT","es_ES","pl_PL"]},"defaultLanguage":{"type":"string","example":"en_US"},"name":{"type":"string","example":"Bynder"},"timeZone":{"type":"string","example":"Europe/Amsterdam"},"isOpenImageBank":{"type":"boolean","example":false}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-brands.md","page_updatedAt":"2026-03-31T14:49:15.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Brands","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"paths":{"/api/v4/brands/":{"get":{"summary":"Retrieve brands","security":[{"permanentToken":[]},{"OAuth2":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"image":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"description":{"type":"string"},"subBrands":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"image":{"type":"string"}}}}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-collections-id-media.md","page_updatedAt":"2026-01-07T13:31:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Collections API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Collections assets","description":""}],"paths":{"/api/v4/collections/{id}/media":{"get":{"summary":"Retrieve the assets of a specific collection","description":"Retrieve the assets of a specific collection by ID.","tags":["Collections assets"],"security":[{"OAuth2":[]},{"permanentToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"responses":{"200":{"description":"A list of asset IDs.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},"examples":{"example1":{"value":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001","00000000-0000-0000-0000000000000002"]}}}}},"404":{"description":"Collection not found.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Collection not found"},"statuscode":{"type":"integer","example":404}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-collections-id.md","page_updatedAt":"2026-01-07T13:31:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Collections API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Collections ID","description":""}],"paths":{"/api/v4/collections/{id}":{"get":{"summary":"Retrieve specific collection","description":"Retrieve a specific collection by ID.","tags":["Collections ID"],"security":[{"OAuth2":[]},{"permanentToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"responses":{"200":{"description":"A specific collection.","content":{"application/json":{"schema":{"type":"object","properties":{"dateCreated":{"type":"string","example":"March, 01 2017 10:49:12 +0000"},"thumbnail":{"type":"string","example":"___URL_TO_BYNDER_CDN___"},"name":{"type":"string","example":"Collection 1"},"link":{"type":"string","example":"___URL_TO_BYNDER_CDN___"},"views":{"type":"integer","example":2},"description":{"type":"string","example":"Collection 1 with various assets."},"user":{"type":"object","properties":{"id":{"type":"string","example":"80E53210-5BB0-4BF9-907F917D457801BB"},"name":{"type":"string","example":"Jane Doe"}}}}},"examples":{"example1":{"value":{"dateCreated":"March, 01 2017 10:49:12 +0000","thumbnail":"___URL_TO_BYNDER_CDN___","name":"Collection 1","link":"___URL_TO_BYNDER_CDN___","views":2,"description":"Collection 1 with various assets.","user":{"id":"80E53210-5BB0-4BF9-907F917D457801BB","name":"Jane Doe"}}}}}}},"404":{"description":"Collection not found.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Collection not found"},"statuscode":{"type":"integer","example":404}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-collections.md","page_updatedAt":"2026-01-07T13:31:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Collections API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Collections","description":""}],"paths":{"/api/v4/collections":{"get":{"summary":"Retrieve collections","description":"Retrieve a list of collections.","tags":["Collections"],"security":[{"OAuth2":["collection.public.view","INBOXPUBLIC","OUTBOXPUBLIC","PUBLICCOLLECTIONS"]},{"permanentToken":["collection.public.view","INBOXPUBLIC","OUTBOXPUBLIC","PUBLICCOLLECTIONS"]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":50,"maximum":1000}},{"name":"page","in":"query","schema":{"type":"integer","default":1}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["dateCreated asc","dateCreated desc","name asc","name desc"]}},{"name":"ids","in":"query","schema":{"type":"string","example":"00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000"}},{"name":"count","in":"query","schema":{"type":"boolean","default":false}},{"name":"keyword","in":"query","schema":{"type":"string","example":"Amsterdam"}},{"name":"isPublic","in":"query","schema":{"type":"boolean","default":false}},{"name":"minCount","in":"query","schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"A list of collections.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","example":"48817BA7-2FC3-4A43-918761514D322C15"},"dateModified":{"type":"string","example":"March, 08 2017 14:17:37 +0000"},"filename":{"type":"string","example":"collection_1"},"dateCreated":{"type":"string","example":"March, 01 2017 10:49:12 +0000"},"collectionCount":{"type":"integer","example":2},"id":{"type":"string","example":"00B627BB-8054-44C0-A343FCF40BC790CD"},"name":{"type":"string","example":"Collection 1"},"cover":{"type":"object","properties":{"thumbnail":{"type":"string","example":"___URL_TO_BYNDER_CDN___"},"thumbnails":{"type":"array","items":{"type":"string","example":"___URL_TO_BYNDER_CDN___"}},"large":{"type":"string","example":"___URL_TO_BYNDER_CDN___"}}},"user":{"type":"object","properties":{"id":{"type":"string","example":"48817BA7-2FC3-4A43-918761514D322C15"},"name":{"type":"string","example":"John Doe"}}},"description":{"type":"string","example":"Collection 1 with various assets."},"isPublic":{"type":"boolean","example":true}}}},"examples":{"example1":{"value":[{"userId":"48817BA7-2FC3-4A43-918761514D322C15","dateModified":"March, 08 2017 14:17:37 +0000","filename":"collection_1","dateCreated":"March, 01 2017 10:49:12 +0000","collectionCount":2,"id":"00B627BB-8054-44C0-A343FCF40BC790CD","name":"Collection 1","cover":{"thumbnail":"___URL_TO_BYNDER_CDN___","thumbnails":["___URL_TO_BYNDER_CDN___","___URL_TO_BYNDER_CDN___","___URL_TO_BYNDER_CDN___"],"large":"___URL_TO_BYNDER_CDN___"},"user":{"id":"48817BA7-2FC3-4A43-918761514D322C15","name":"John Doe"},"description":"Collection 1 with various assets.","isPublic":true},{"userId":"80E53210-5BB0-4BF9-907F917D457801BB","dateModified":"March, 10 2017 07:57:18 +0000","filename":"collection_2","dateCreated":"October, 30 2014 13:54:00 +0000","collectionCount":4,"id":"050960F7-98B3-461D-B967F4B84D3A3866","name":"Collection 2","cover":{"thumbnail":"___URL_TO_BYNDER_CDN___","thumbnails":["___URL_TO_BYNDER_CDN___","___URL_TO_BYNDER_CDN___","___URL_TO_BYNDER_CDN___"],"large":"___URL_TO_BYNDER_CDN___"},"user":{"id":"80E53210-5BB0-4BF9-907F917D457801BB","name":"Jane Doe"},"description":"Collection 2 with various assets.","isPublic":false}]}}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Invalid request parameters."},"statuscode":{"type":"integer","example":400}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-currentuser.md","page_updatedAt":"2026-01-06T13:41:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Users","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Current User","description":"Retrieve information about the currently authenticated user without needing to know their user ID.         \n"}],"paths":{"/api/v4/currentUser/":{"get":{"summary":"Retrieve current user","description":"Retrieve the current user information. Unlike [Retrieve specific user](#reference/users/specific-user-operations/retrieve-specific-user) this call doesn't require you to know your user id in order to retrieve your current user information.\n","tags":["Current User"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"string"},"profileId":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"department":{"type":"string"},"job":{"type":"string"},"state":{"type":"string"},"firstname":{"type":"string"},"city":{"type":"string"},"infix":{"type":"string"},"timeZone":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"persisted":{"type":"boolean"},"legalEntity":{"type":"string"},"county":{"type":"string"},"postalCode":{"type":"string"},"language":{"type":"string"},"country":{"type":"string"},"costCenter":{"type":"string"},"lastname":{"type":"string"},"cellphoneNumber":{"type":"string"},"employeeNumber":{"type":"string"},"departmentCode":{"type":"string"},"gender":{"type":"string"},"id":{"type":"string"},"companyName":{"type":"string"},"active":{"type":"boolean"},"isSSOOnly":{"type":"boolean"},"address":{"type":"string"},"terms":{"type":"string"}}}}}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-media-id-download-itemid.md","page_updatedAt":"2026-01-07T10:39:11.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Download API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Media download","description":""}],"security":[{"OAuth2":["MEDIAHIGHRES","ARCHIVEDOWNLOAD","DOWNLOADWATERMARK","KEYVISUALSDOWNLOAD"]},{"permanentToken":["MEDIAHIGHRES","ARCHIVEDOWNLOAD","DOWNLOADWATERMARK","KEYVISUALSDOWNLOAD"]}],"paths":{"/api/v4/media/{id}/download/{itemId}":{"get":{"summary":"Retrieve specific asset item download location","description":"Retrieve the download location for a specific asset item.\n__Warning:__ Requires the MEDIAHIGHRES security role.\n__Warning:__ Requires the ARCHIVEDOWNLOAD security role if the asset in question is archived.\n__Warning:__ Requires the DOWNLOADWATERMARK security role if the asset in question is watermarked.\n__Warning:__ Requires the KEYVISUALSDOWNLOAD security role if the asset in question is marked as limited usage.\n","tags":["Media download"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"itemId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"hash","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"URL from which you can download the requested asset file.","content":{"application/json":{"schema":{"type":"object","properties":{"disclaimer":{"type":"string","example":"<p>1. The photographs and video in the mediabank are to be used by anyone and everyone.</p>"},"s3_file":{"type":"string","example":"___TEMPORARY_DOWNLOAD_URL___"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"MEDIAHIGHRES":"","ARCHIVEDOWNLOAD":"","DOWNLOADWATERMARK":"","KEYVISUALSDOWNLOAD":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"MEDIAHIGHRES":"","ARCHIVEDOWNLOAD":"","DOWNLOADWATERMARK":"","KEYVISUALSDOWNLOAD":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-media-id-download.md","page_updatedAt":"2026-01-07T10:39:11.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Download API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Media download","description":""}],"security":[{"OAuth2":["MEDIAHIGHRES","ARCHIVEDOWNLOAD","DOWNLOADWATERMARK","KEYVISUALSDOWNLOAD"]},{"permanentToken":["MEDIAHIGHRES","ARCHIVEDOWNLOAD","DOWNLOADWATERMARK","KEYVISUALSDOWNLOAD"]}],"paths":{"/api/v4/media/{id}/download":{"get":{"summary":"Retrieve asset download location","description":"Retrieve the download location for an asset.\n__Warning:__ Requires the MEDIAHIGHRES security role.\n__Warning:__ Requires the ARCHIVEDOWNLOAD security role if the asset in question is archived.\n__Warning:__ Requires the DOWNLOADWATERMARK security role if the asset in question is watermarked.\n__Warning:__ Requires the KEYVISUALSDOWNLOAD security role if the asset in question is marked as limited usage.\n","tags":["Media download"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["original","additional"],"default":"original"}}],"responses":{"200":{"description":"URL from which you can download the requested asset file.","content":{"application/json":{"schema":{"type":"object","properties":{"disclaimer":{"type":"string","example":"<p>1. The photographs and video in the mediabank are to be used by anyone and everyone.</p>"},"s3_file":{"type":"string","example":"___TEMPORARY_DOWNLOAD_URL___"}}}}}},"400":{"description":"Invalid type","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Invalid type"},"statuscode":{"type":"string","example":"400"}}}}}},"404":{"description":"Original file not available","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Original file not available"},"statuscode":{"type":"string","example":"404"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"MEDIAHIGHRES":"","ARCHIVEDOWNLOAD":"","DOWNLOADWATERMARK":"","KEYVISUALSDOWNLOAD":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"MEDIAHIGHRES":"","ARCHIVEDOWNLOAD":"","DOWNLOADWATERMARK":"","KEYVISUALSDOWNLOAD":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-media-id-version-download.md","page_updatedAt":"2026-01-07T10:39:11.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Download API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Media download","description":""}],"security":[{"OAuth2":["MEDIAHIGHRES","ARCHIVEDOWNLOAD","DOWNLOADWATERMARK","KEYVISUALSDOWNLOAD"]},{"permanentToken":["MEDIAHIGHRES","ARCHIVEDOWNLOAD","DOWNLOADWATERMARK","KEYVISUALSDOWNLOAD"]}],"paths":{"/api/v4/media/{id}/{version}/download":{"get":{"summary":"Retrieve asset version download location","description":"Retrieve the download location for a specific asset version.\n__Warning:__ Requires the MEDIAHIGHRES security role.\n__Warning:__ Requires the ARCHIVEDOWNLOAD security role if the asset in question is archived.\n__Warning:__ Requires the DOWNLOADWATERMARK security role if the asset in question is watermarked.\n__Warning:__ Requires the KEYVISUALSDOWNLOAD security role if the asset in question is marked as limited usage.\n","tags":["Media download"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"version","in":"path","required":true,"schema":{"type":"integer","example":"3"}}],"responses":{"200":{"description":"URL from which you can download the requested asset file.","content":{"application/json":{"schema":{"type":"object","properties":{"disclaimer":{"type":"string","example":"<p>1. The photographs and video in the mediabank are to be used by anyone and everyone.</p>"},"s3_file":{"type":"string","example":"___TEMPORARY_DOWNLOAD_URL___"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"MEDIAHIGHRES":"","ARCHIVEDOWNLOAD":"","DOWNLOADWATERMARK":"","KEYVISUALSDOWNLOAD":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"MEDIAHIGHRES":"","ARCHIVEDOWNLOAD":"","DOWNLOADWATERMARK":"","KEYVISUALSDOWNLOAD":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-media-id.md","page_updatedAt":"2026-05-15T13:36:18.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"ARCHIVEDOWNLOAD":"","ARCHIVEMEDIA":"","EMARGOMEDIA":"","KEYVISUALDOWNLOAD":"","MARKPUBLIC":"","MEDIAEDIT":"","MEDIAREMOVE":"","STATISTICS":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"ARCHIVEDOWNLOAD":"","ARCHIVEMEDIA":"","EMARGOMEDIA":"","KEYVISUALDOWNLOAD":"","MARKPUBLIC":"","MEDIAEDIT":"","MEDIAREMOVE":"","STATISTICS":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Asset Management API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/v4/media/{id}":{"get":{"description":"Requires the **STATISTICS** security role in order to retrieve *views* and *downloads* statistics data in the response, using the `stats` parameter.","parameters":[{"description":"OAuth 2.0 Bearer access token.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Asset id.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Include information about the different asset media items including versions.","in":"query","name":"versions","schema":{"default":false,"type":"boolean"}},{"description":"Include information about *views* and *downloads*.","in":"query","name":"stats","schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"activeOriginalFocusPoint":{"properties":{"x":{"type":"integer"},"y":{"type":"integer"}},"type":"object"},"archive":{"type":"boolean"},"brandId":{"format":"uuid","type":"string"},"copyright":{"type":"string"},"dateCreated":{"format":"date-time","type":"string"},"dateModified":{"format":"date-time","type":"string"},"datePublished":{"format":"date-time","type":"string"},"description":{"type":"string"},"downloads":{"type":"integer"},"extension":{"items":{"type":"string"},"type":"array"},"fileSize":{"type":"integer"},"height":{"type":"integer"},"id":{"format":"uuid","type":"string"},"idHash":{"type":"string"},"isPublic":{"type":"boolean"},"limited":{"type":"boolean"},"name":{"type":"string"},"orientation":{"type":"string"},"original":{"type":"string"},"propertyOptions":{"items":{"type":"string"},"type":"array"},"property_assettype":{"items":{"type":"string"},"type":"array"},"relatedAssets":{"items":{"properties":{"assets":{"items":{"type":"string"},"type":"array"},"metaPropertyId":{"type":"string"},"metaPropertyName":{"type":"string"}},"type":"object"},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"thumbnails":{"properties":{"mini":{"type":"string"},"thul":{"type":"string"},"webimage":{"type":"string"}},"type":"object"},"transformBaseUrl":{"type":"string"},"type":{"type":"string"},"userCreated":{"type":"string"},"videoPreviewURLs":{"items":{"type":"string"},"type":"array"},"views":{"type":"integer"},"watermarked":{"type":"boolean"},"width":{"type":"integer"}},"type":"object"}}},"description":"Successful response"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"statuscode":{"type":"string"}},"type":"object"}}},"description":"File not found"}},"security":[{"permanentToken":["","STATISTICS"]},{"OAuth2":["","STATISTICS"]}],"summary":"Retrieve specific asset","tags":["Media ID"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"","name":"Media ID"}]}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-media.md","page_updatedAt":"2026-05-15T13:36:18.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"ARCHIVEDOWNLOAD":"","ARCHIVEMEDIA":"","EMARGOMEDIA":"","KEYVISUALDOWNLOAD":"","MARKPUBLIC":"","MEDIAEDIT":"","MEDIAREMOVE":"","STATISTICS":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"ARCHIVEDOWNLOAD":"","ARCHIVEMEDIA":"","EMARGOMEDIA":"","KEYVISUALDOWNLOAD":"","MARKPUBLIC":"","MEDIAEDIT":"","MEDIAREMOVE":"","STATISTICS":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Asset Management API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/v4/media/":{"get":{"description":"`original` is only returned for assets marked as public and requires the account to have the `seoBaseUrl` setting configured.\n","parameters":[{"description":"OAuth 2.0 Bearer access token.","in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"description":"Brand id, can be retrieved using the Retrieve brands and subbrands call.","in":"query","name":"brandId","schema":{"format":"uuid","type":"string"}},{"description":"Sub-brand id, can be retrieved using the Retrieve brands and subbrands call.","in":"query","name":"subBrandId","schema":{"format":"uuid","type":"string"}},{"description":"Category id, can be retrieved using the Retrieve categories call.","in":"query","name":"categoryId","schema":{"format":"uuid","type":"string"}},{"description":"Collection id, can be retrieved using the Retrieve collections call.","in":"query","name":"collectionId","schema":{"format":"uuid","type":"string"}},{"description":"Asset id, will return the asset for that id.","in":"query","name":"id","schema":{"format":"uuid","type":"string"}},{"description":"Comma-separated list of asset ids. Will return an asset for each existing id.","in":"query","name":"ids","schema":{"type":"string"}},{"description":"Comma-separated list of (metaproperty) option ids, can be retrieved using the Retrieve metaproperties call.","in":"query","name":"propertyOptionId","schema":{"type":"string"}},{"description":"Comma-separated list of tags, can be retrieved using the Retrieve tags call.","in":"query","name":"tags","schema":{"type":"string"}},{"description":"Comma-separated list of asset types.","in":"query","name":"type","schema":{"enum":["image","document","audio","video","3d"],"type":"string"}},{"description":"Comma-separated list of asset orientation.","in":"query","name":"orientation","schema":{"enum":["square","portrait","landscape"],"type":"string"}},{"description":"Metaproperty option name or comma-separated list ids of metaproperty options for that metaproperty. Beware that NAME should be replaced with the actual metaproperty name. This is an AND operation when passing multiple values. If a Date type metaproperty is added, retrieving assets using the dates for that metaproperty is not supported.","in":"query","name":"property_NAME","schema":{"type":"string"}},{"description":"Indicates whether or not the response should only contain assets marked as \"limited usage\".","in":"query","name":"limited","schema":{"type":"boolean"}},{"description":"Indicates whether or not the response should only contain archived assets.","in":"query","name":"archive","schema":{"type":"boolean"}},{"description":"Indicates whether or not the response should only contain assets marked as public.","in":"query","name":"isPublic","schema":{"type":"boolean"}},{"description":"Search on filenames, tags, extensions, collection names, guidelines, brandstore, campaigns in workflow, enriched PDFs, word documents.","in":"query","name":"keyword","schema":{"type":"string"}},{"description":"Retrieve assets created after this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","in":"query","name":"dateCreated","schema":{"format":"date-time","type":"string"}},{"description":"Set a date range together with the \"dateCreated\" parameter. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","in":"query","name":"dateCreatedTo","schema":{"format":"date-time","type":"string"}},{"description":"Retrieve assets created on this specific date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","in":"query","name":"dateCreatedOn","schema":{"format":"date-time","type":"string"}},{"description":"Retrieve assets modified after this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","in":"query","name":"dateModified","schema":{"format":"date-time","type":"string"}},{"description":"Set a date range together with the \"dateModified\" parameter. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","in":"query","name":"dateModifiedTo","schema":{"format":"date-time","type":"string"}},{"description":"Retrieve assets modified on this specific date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","in":"query","name":"dateModifiedOn","schema":{"format":"date-time","type":"string"}},{"description":"Order of the returned list of assets.","in":"query","name":"orderBy","schema":{"enum":["dateCreated asc","dateModified asc","datePublished asc","name asc","dateCreated desc","dateModified desc","datePublished desc","name desc"],"type":"string"}},{"description":"Maximum number of results.","in":"query","name":"limit","schema":{"default":50,"maximum":1000,"type":"integer"}},{"description":"Offset page for results: return the N-th set of limit-results.\n","in":"query","name":"page","schema":{"default":1,"type":"integer"}},{"description":"Indicating whether or not the response should include count results.","in":"query","name":"count","schema":{"default":false,"type":"boolean"}},{"description":"Indicating whether or not the response should include the total count of results.","in":"query","name":"total","schema":{"default":false,"type":"boolean"}},{"description":"Indicating whether or not the response should include all the different media items (derivatives) available for each asset.","in":"query","name":"includeMediaItems","schema":{"default":false,"type":"boolean"}},{"description":"Indicating whether or not the response should include the active version number.","in":"query","name":"includeVersionNumber","schema":{"default":false,"type":"boolean"}},{"description":"cursorMark returned in the X-Bynder-NextCursor response header which allows to return the next set of results.","in":"query","name":"cursor","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"archive":{"type":"boolean"},"brandId":{"format":"uuid","type":"string"},"copyright":{"type":"string"},"dateCreated":{"format":"date-time","type":"string"},"dateModified":{"format":"date-time","type":"string"},"datePublished":{"format":"date-time","type":"string"},"description":{"type":"string"},"extension":{"items":{"type":"string"},"type":"array"},"fileSize":{"type":"integer"},"height":{"type":"integer"},"id":{"format":"uuid","type":"string"},"idHash":{"type":"string"},"isPublic":{"type":"boolean"},"limited":{"type":"boolean"},"mediaItems":{"items":{"properties":{"name":{"type":"string"},"publicUrl":{"type":"string"},"type":{"type":"string"}},"type":"object"},"type":"array"},"name":{"type":"string"},"orientation":{"type":"string"},"original":{"type":"string"},"propertyOptions":{"items":{"type":"string"},"type":"array"},"property_limitedrights":{"type":"string"},"tags":{"items":{"type":"string"},"type":"array"},"thumbnails":{"properties":{"mini":{"type":"string"},"thul":{"type":"string"},"webimage":{"type":"string"}},"type":"object"},"transformBaseUrl":{"type":"string"},"type":{"type":"string"},"userCreated":{"type":"string"},"videoPreviewURLs":{"items":{"type":"string"},"type":"array"},"watermarked":{"type":"boolean"},"width":{"type":"integer"}},"type":"object"},"type":"array"}}},"description":"Successful response","headers":{"X-Bynder-NextCursor":{"description":"SOLR nextCursorMark which can be used to return the next X number of results. Returned when solr-cursor account feature is enabled.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"statuscode":{"type":"string"}},"type":"object"}}},"description":"Not Found"}},"security":[{"permanentToken":["","ARCHIVEMEDIA","ARCHIVEDOWNLOAD","EMARGOMEDIA","KEYVISUALDOWNLOAD"]},{"OAuth2":["","ARCHIVEMEDIA","ARCHIVEDOWNLOAD","EMARGOMEDIA","KEYVISUALDOWNLOAD"]}],"summary":"Retrieve assets","tags":["Media"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"","name":"Media"}]}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-metaproperties-id-options-dependencies.md","page_updatedAt":"2026-05-11T06:38:49.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Dependencies for Metaproperties and Options","version":"1.0.0"},"tags":[{"name":"Option dependency (Please use new Automations API if possible)"}],"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"paths":{"/api/v4/metaproperties/{id}/options/dependencies":{"get":{"summary":"Retrieve option dependencies for a metaproperty","description":"Retrieve all metaproperty option dependencies for a specific metaproperty.","tags":["Option dependency (Please use new Automations API if possible)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"responses":{"200":{"description":"A list of metaproperty option dependencies.","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}}},"examples":{"example1":{"value":{"00000000-0000-0000-0000000000000000":{"00000000-0000-0000-0000000000000000":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001","00000000-0000-0000-0000000000000002"],"ungrouped":["00000000-0000-0000-0000000000000000"]}}}}}}},"404":{"description":"Unknown metaproperty","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unknown metaproperty"},"statuscode":{"type":"string","example":"404"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-metaproperties-id-options-optionid-dependencies.md","page_updatedAt":"2026-05-11T06:38:49.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Dependencies for Metaproperties and Options","version":"1.0.0"},"tags":[{"name":"Option dependency (Please use new Automations API if possible)"}],"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"paths":{"/api/v4/metaproperties/{id}/options/{optionId}/dependencies":{"get":{"summary":"Retrieve dependencies for a metaproperty option","description":"Retrieve dependencies for a metaproperty option.","tags":["Option dependency (Please use new Automations API if possible)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"includeGroupedResults","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"A list of specific metaproperty option dependencies.","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}}]},"examples":{"example1":{"value":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001"]},"example2":{"value":{"00000000-0000-0000-0000000000000000":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001","00000000-0000-0000-0000000000000002"],"ungrouped":["00000000-0000-0000-0000000000000000"]}}}}}},"404":{"description":"Unknown metaproperty or metaproperty option","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unknown metaproperty"},"statuscode":{"type":"string","example":"404"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-metaproperties-id-options.md","page_updatedAt":"2026-05-11T06:38:40.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty options","version":"1.0"},"openapi":"3.1.0","paths":{"/api/v4/metaproperties/{id}/options":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}},{"in":"query","name":"name","required":false,"schema":{"example":"Amsterdam","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"default":50,"example":250,"maximum":1000,"type":"integer"}},{"in":"query","name":"page","required":false,"schema":{"default":1,"example":1,"type":"integer"}},{"in":"query","name":"externalReference","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example1":{"value":[{"active":1,"date":"2017-02-15T14:54:58+00:00","displayLabel":"Yellow","id":"00000000-0000-0000-0000000000000000","label":"Yellow","labels":{"en_US":"Yellow","nl_NL":"Geel"},"name":"yellow"},{"active":1,"date":"2017-02-15T15:50:55+00:00","displayLabel":"Red","id":"00000000-0000-0000-0000000000000000","label":"Red","labels":{"en_US":"Red","nl_NL":"Rood"},"name":"red"}]}},"schema":{"items":{"properties":{"active":{"example":1,"type":"integer"},"date":{"example":"2017-02-15T14:54:58+00:00","format":"date-time","type":"string"},"displayLabel":{"example":"Yellow","type":"string"},"id":{"example":"00000000-0000-0000-0000000000000000","type":"string"},"label":{"example":"Yellow","type":"string"},"labels":{"properties":{"en_US":{"example":"Yellow","type":"string"},"nl_NL":{"example":"Geel","type":"string"}},"type":"object"},"name":{"example":"yellow","type":"string"}},"type":"object"},"type":"array"}}},"description":"Successful response"},"400":{"content":{"application/json":{"examples":{"invalidId":{"value":{"message":"Invalid metaproperty ID","statuscode":"400"}}},"schema":{"properties":{"message":{"example":"Invalid metaproperty ID","type":"string"},"statuscode":{"example":"400","type":"string"}},"type":"object"}}},"description":"Invalid metaproperty ID"}},"summary":"Retrieve options for a metaproperty","tags":["Options - Old API (Please use new API if possible)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Options - Old API (Please use new API if possible)"}]}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-metaproperties-id.md","page_updatedAt":"2026-05-11T07:21:24.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty","version":"1.0"},"openapi":"3.1.0","paths":{"/api/v4/metaproperties/{id}":{"get":{"parameters":[{"description":"Metaproperty id.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Indicates whether or not the response should include asset count results for metaproperty-options.","in":"query","name":"count","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Comma-separated list of asset types. Filters the count results by asset type.","in":"query","name":"type","required":false,"schema":{"enum":["image","document","audio","video","3d"],"type":"string"}},{"description":"Indicates whether or not the response should include the metaproperty options of the metaproperty.","in":"query","name":"options","required":false,"schema":{"default":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":{"id":"00000000-0000-0000-0000000000000000","isApiField":true,"isDisplayField":false,"isDrilldown":false,"isEditable":true,"isFilterable":true,"isMainfilter":true,"isMultifilter":false,"isMultiselect":false,"isRequired":false,"label":"Colours","name":"colours","options":[{"active":true,"date":"February, 15 2017 14:54:58 +0000","description":"","descriptions":{},"displayLabel":"Yellow","hideByDefault":false,"id":"00000000-0000-0000-0000000000000000","image":"___URL_TO_BYNDER_CDN___","isSelectable":true,"label":"Yellow","labels":{"en_US":"Yellow","nl_NL":"Geel"},"linkedOptionIds":[],"name":"yellow","pregeneratedZipFileSize":0,"product_suffix":"","zindex":1},{"active":true,"date":"February, 15 2017 15:50:55 +0000","description":"","descriptions":{},"displayLabel":"Red","hideByDefault":false,"id":"00000000-0000-0000-0000000000000000","image":"___URL_TO_BYNDER_CDN___","isSelectable":true,"label":"Red","labels":{"en_US":"Red","nl_NL":"Rood"},"linkedOptionIds":[],"name":"red","pregeneratedZipFileSize":0,"product_suffix":"","zindex":1}],"showInDuplicateView":false,"showInGridView":false,"showInListView":true,"type":"sidebar","useDependencies":false,"zindex":16}}}}},"description":"Successful response"},"404":{"content":{"application/json":{"examples":{"example-1":{"value":{"message":"Metaproperty not found","statuscode":404}}}}},"description":"Metaproperty not found"}},"summary":"Retrieve metaproperty","tags":["Metaproperties - Old API (Please use new API if possible)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Metaproperties - Old API (Please use new API if possible)"}]}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-metaproperties-options-dependencies.md","page_updatedAt":"2026-05-11T06:38:49.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Dependencies for Metaproperties and Options","version":"1.0.0"},"tags":[{"name":"Option dependency (Please use new Automations API if possible)"}],"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"paths":{"/api/v4/metaproperties/options/dependencies":{"get":{"summary":"Retrieve global option dependencies","description":"Retrieve all metaproperty option dependencies globally.","tags":["Option dependency (Please use new Automations API if possible)"],"responses":{"200":{"description":"A list of global option dependencies.","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}}}},"examples":{"example1":{"value":{"00000000-0000-0000-0000000000000000":{"00000000-0000-0000-0000000000000000":{"00000000-0000-0000-0000000000000000":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001","00000000-0000-0000-0000000000000002"]}},"00000000-0000-0000-0000000000000001":{"00000000-0000-0000-0000000000000000":{"ungrouped":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001"]}}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-metaproperties-options.md","page_updatedAt":"2026-05-11T06:38:40.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty options","version":"1.0"},"openapi":"3.1.0","paths":{"/api/v4/metaproperties/options":{"get":{"parameters":[{"in":"query","name":"ids","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example1":{"value":[{"active":1,"date":"2017-02-15T14:54:58+00:00","displayLabel":"Yellow","id":"00000000-0000-0000-0000000000000000","label":"Yellow","labels":{"en_US":"Yellow","nl_NL":"Geel"},"name":"yellow"},{"active":1,"date":"2017-02-15T15:50:55+00:00","displayLabel":"Red","id":"00000000-0000-0000-0000000000000000","label":"Red","labels":{"en_US":"Red","nl_NL":"Rood"},"name":"red"}]}}}},"description":"A list of options"},"400":{"content":{"application/json":{"examples":{"invalidId":{"value":{"message":"Invalid metaproperty option id sent","statuscode":"400"}},"noData":{"value":{"message":"No data sent","statuscode":"400"}}}}},"description":"Invalid request"}},"summary":"Retrieve options by ids","tags":["Options - Old API (Please use new API if possible)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Options - Old API (Please use new API if possible)"}]}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-metaproperties.md","page_updatedAt":"2026-05-11T07:21:24.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty","version":"1.0"},"openapi":"3.1.0","paths":{"/api/v4/metaproperties":{"get":{"parameters":[{"description":"Indicates whether or not the response should include asset count results for metaproperty-options.","in":"query","name":"count","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Comma-separated list of asset types. Filters the count results by asset type.","in":"query","name":"type","required":false,"schema":{"enum":["image","document","audio","video","3d"],"type":"string"}},{"description":"Indicates whether or not the response should include the metaproperty options of each metaproperty. \n__Warning:__ Always ensure to remove the metaproperty options from the response when using this endpoint. Include the param `options=0` in every request sent.","in":"query","name":"options","required":false,"schema":{"default":true,"type":"boolean"}},{"description":"Comma-separated list of metaproperty ids. Will return a metaproperty for each existing id.","in":"query","name":"ids","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"example-1":{"value":{"Bob_button":{"id":"00000000-0000-0000-0000000000000001","isApiField":true,"isDisplayField":false,"isDrilldown":false,"isEditable":true,"isFilterable":true,"isMainfilter":true,"isMultifilter":false,"isMultiselect":false,"isRequired":false,"label":"Bob_button","name":"Bob_button","showInDuplicateView":false,"showInGridView":false,"showInListView":true,"type":"button","useDependencies":false,"zindex":2},"Colours":{"id":"00000000-0000-0000-0000000000000000","isApiField":true,"isDisplayField":false,"isDrilldown":false,"isEditable":true,"isFilterable":true,"isMainfilter":true,"isMultifilter":false,"isMultiselect":false,"isRequired":false,"label":"Colours","name":"colours","options":[{"active":true,"date":"February, 15 2017 14:54:58 +0000","description":"","descriptions":{},"displayLabel":"Yellow","hideByDefault":false,"id":"00000000-0000-0000-0000000000000000","image":"___URL_TO_BYNDER_CDN___","isSelectable":true,"label":"Yellow","labels":{"en_US":"Yellow","nl_NL":"Geel"},"linkedOptionIds":[],"name":"yellow","pregeneratedZipFileSize":0,"product_suffix":"","zindex":1},{"active":true,"date":"February, 15 2017 15:50:55 +0000","description":"","descriptions":{},"displayLabel":"Red","hideByDefault":false,"id":"00000000-0000-0000-0000000000000001","image":"___URL_TO_BYNDER_CDN___","isSelectable":true,"label":"Red","labels":{"en_US":"Red","nl_NL":"Rood"},"linkedOptionIds":[],"name":"red","pregeneratedZipFileSize":0,"product_suffix":"","zindex":1}],"showInDuplicateView":false,"showInGridView":false,"showInListView":true,"type":"sidebar","useDependencies":false,"zindex":16}}}}}},"description":"Successful response"}},"summary":"Retrieve metaproperties","tags":["Metaproperties - Old API (Please use new API if possible)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Metaproperties - Old API (Please use new API if possible)"}]}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-profiles-id.md","page_updatedAt":"2026-01-12T12:57:21.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Security Roles","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Profiles","description":"To determine the security profile for your user you can compare the security profile id with the profileId retrieved from either the Retrieve specific user or Retrieve current user call. It's the API's responsibility to enforce that users can only perform allowed actions but nevertheless we recommend that your application checks whether or not an action can be performed because this will create a better user experience.\n"}],"paths":{"/api/v4/profiles/{id}":{"get":{"summary":"Retrieve specific security profile","description":"This call allows you to retrieve your own security profile without requiring the PERMISSIONMANAGEMENT security role. In order to get your own security profile use your user profile id retrieved by executing the Specific User or Current User call.\n","tags":["Profiles"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Security profile id."}],"security":[{"OAuth2":["","PERMISSIONMANAGEMENT"]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}}},"example":"{\n  \"name\": \"Admin\",\n  \"id\": \"1\",\n  \"roles\": [\n    \"GROUPMANAGEMENT\",\n    \"USERMANAGEMENT\",\n    \"PERMISSIONMANAGEMENT\"\n  ]\n}\n"}}},"401":{"description":"Invalid or expired token","content":{"text/plain":{"schema":{"type":"string"},"example":"Invalid or expired token.\n"}}}}}}},"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PERMISSIONMANAGEMENT":"Grants permission to manage permissions"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PERMISSIONMANAGEMENT":"Grants permission to manage permissions"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-profiles.md","page_updatedAt":"2026-01-12T12:57:21.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Security Roles","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Profiles","description":"To determine the security profile for your user you can compare the security profile id with the profileId retrieved from either the Retrieve specific user or Retrieve current user call. It's the API's responsibility to enforce that users can only perform allowed actions but nevertheless we recommend that your application checks whether or not an action can be performed because this will create a better user experience.\n"}],"paths":{"/api/v4/profiles/":{"get":{"summary":"Retrieve security profiles","description":"To determine the security profile for your user you can compare the security profile id with the profileId retrieved from either the Retrieve specific user or Retrieve current user call. It’s the API’s responsibility to enforce that users can only perform allowed actions but nevertheless we recommend that your application checks whether or not an action can be performed because this will create a better user experience.\n","tags":["Profiles"],"security":[{"permanentToken":["PERMISSIONMANAGEMENT"]},{"OAuth2":["PERMISSIONMANAGEMENT"]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}}}}},"example":"[\n  {\n    \"name\": \"Admin\",\n    \"id\": \"1\",\n    \"roles\": [\n      \"GROUPMANAGEMENT\",\n      \"USERMANAGEMENT\",\n      \"PERMISSIONMANAGEMENT\"\n    ]\n  },\n  {\n    \"name\": \"User\",\n    \"id\": \"2\",\n    \"roles\": [\n      \"USERMANAGEMENT\"\n    ]\n  }\n]\n"}}},"401":{"description":"Invalid or expired token","content":{"text/plain":{"schema":{"type":"string"},"example":"Invalid or expired token.\n"}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PERMISSIONMANAGEMENT":"Grants permission to manage permissions"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PERMISSIONMANAGEMENT":"Grants permission to manage permissions"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-smartfilters.md","page_updatedAt":"2026-01-07T10:48:12.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Smartfilters API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Smartfilters","description":""}],"security":[{"OAuth2":[]},{"permanentToken":[]}],"paths":{"/api/v4/smartfilters":{"get":{"summary":"Retrieve smartfilters","description":"Retrieve a list of smartfilters.","tags":["Smartfilters"],"responses":{"200":{"description":"A list of smartfilters.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"icon":{"type":"string","example":"fa fa-group"},"labels":{"type":"object","properties":{"nl_NL":{"type":"string","example":"Destinations"},"en_US":{"type":"string","example":"Destinations"},"fr_FR":{"type":"string","example":"Destinations"},"de_DE":{"type":"string","example":"Destinations"}}},"zindex":{"type":"integer","example":0},"id":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"metaproperties":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}}}},"examples":{"example1":{"value":[{"icon":"fa fa-group","labels":{"nl_NL":"Destinations","en_US":"Destinations","fr_FR":"Destinations","de_DE":"Destinations"},"zindex":0,"id":"00000000-0000-0000-0000000000000000","metaproperties":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000000"]},{"icon":"fa fa-tag","labels":{"nl_NL":"Holiday","en_US":"Holiday","fr_FR":"Holiday","de_DE":"Holiday"},"zindex":1,"id":"00000000-0000-0000-0000000000000000","metaproperties":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000000"]}]}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-tags.md","page_updatedAt":"2026-01-07T10:53:22.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Tags API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Tags","description":""}],"paths":{"/api/v4/tags":{"get":{"summary":"Retrieve tags","description":"Retrieve a list of tags.","tags":["Tags"],"security":[{"OAuth2":[]},{"permanentToken":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","default":50,"maximum":1000}},{"name":"page","in":"query","schema":{"type":"integer","default":1}},{"name":"orderBy","in":"query","schema":{"type":"string","enum":["tag asc","tag desc","mediaCount desc"]}},{"name":"keyword","in":"query","schema":{"type":"string"}},{"name":"mincount","in":"query","schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"A list of tags.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"tag":{"type":"string","example":"Landscape"},"mediaCount":{"type":"integer","example":12}}}},"examples":{"example1":{"value":[{"id":"00000000-0000-0000-0000000000000000","tag":"Landscape","mediaCount":12},{"id":"00000000-0000-0000-0000000000000001","tag":"Amsterdam","mediaCount":82}]}}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"`keyword` and `mincount` is not a valid combination"},"statuscode":{"type":"integer","example":400}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"MEDIAEDIT":"","MEDIAAUDIT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"MEDIAEDIT":"","MEDIAAUDIT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-users-id.md","page_updatedAt":"2026-01-06T13:41:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Users","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Users ID","description":"Manage specific users by their ID. This includes retrieving, updating, and deleting user information based on the user ID.\n"}],"paths":{"/api/v4/users/{id}":{"get":{"summary":"Retrieve specific user","tags":["Users ID"],"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The id or username of the user you’d like to retrieve."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"phoneNumber":{"type":"string"},"profileId":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"department":{"type":"string"},"job":{"type":"string"},"state":{"type":"string"},"firstname":{"type":"string"},"city":{"type":"string"},"infix":{"type":"string"},"timeZone":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"persisted":{"type":"boolean"},"legalEntity":{"type":"string"},"county":{"type":"string"},"postalCode":{"type":"string"},"language":{"type":"string"},"country":{"type":"string"},"costCenter":{"type":"string"},"groups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}},"lastname":{"type":"string"},"cellphoneNumber":{"type":"string"},"employeeNumber":{"type":"string"},"departmentCode":{"type":"string"},"gender":{"type":"string"},"id":{"type":"string"},"companyName":{"type":"string"},"active":{"type":"boolean"},"isSSOOnly":{"type":"boolean"},"address":{"type":"string"},"terms":{"type":"string"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"Grants permission to manage users"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"Grants permission to manage users"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-v4-users.md","page_updatedAt":"2026-01-06T13:41:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Users","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Users","description":"Manage users within your Bynder account. You can create, retrieve, update, and delete users as needed.\n"}],"paths":{"/api/v4/users/":{"get":{"summary":"Retrieve users","tags":["Users"],"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"parameters":[{"name":"includeInActive","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"Whether to include inactive users in the list of results."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100},"description":"Maximum results to return. If limit is not provided, all results are returned."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1},"description":"What page of results to return."}],"responses":{"200":{"description":"Successful response","headers":{"X-Pagination-TotalRecords":{"schema":{"type":"integer"},"description":"Total number of records."},"X-Pagination-TotalPages":{"schema":{"type":"integer"},"description":"Total number of pages."},"X-Pagination-Page":{"schema":{"type":"integer"},"description":"Current page number."},"X-Pagination-Limit":{"schema":{"type":"integer"},"description":"Limit of records per page."}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"email2":{"type":"string"},"salesrepId":{"type":"string"},"name":{"type":"string"},"id":{"type":"string"},"active":{"type":"integer"},"isSSOOnly":{"type":"boolean"},"username":{"type":"string"},"email":{"type":"string"},"profileId":{"type":"string"},"employeeNumber":{"type":"string"},"timeZone":{"type":"string"},"website":{"type":"string"},"country":{"type":"string"},"groups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}}}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"Grants permission to manage users"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"Grants permission to manage users"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-campaigns-id-jobs.md","page_updatedAt":"2026-05-15T13:16:00.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Jobs API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Campaign jobs","description":""}],"paths":{"/api/workflow/campaigns/{id}/jobs":{"get":{"summary":"Retrieve the jobs of a specific campaign","description":"Requires the CAMPAIGNOVERVIEW security role.","tags":["Campaign jobs"],"security":[{"permanentToken":["CAMPAIGNOVERVIEW"]},{"OAuth2":["CAMPAIGNOVERVIEW"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"00000000-0000-0000-0000-000000000000"},{"name":"dateCreatedFrom","in":"query","schema":{"type":"string","description":"Retrieve jobs created after this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time"},"example":"2020-01-01T12:00:00Z"},{"name":"dateCreatedTo","in":"query","schema":{"type":"string","description":"Set a date range together with the \"dateCreated\" parameter. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time"},"example":"2020-01-01T12:00:00Z"},{"name":"dateModifiedFrom","in":"query","schema":{"type":"string","description":"Retrieve jobs modified after this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time"},"example":"2020-01-01T12:00:00Z"},{"name":"dateModifiedTo","in":"query","schema":{"type":"string","description":"Set a date range together with the \"dateModified\" parameter. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time"},"example":"2020-01-01T12:00:00Z"},{"name":"deadlineFrom","in":"query","schema":{"type":"string","description":"Retrieve jobs with a deadline after this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time"},"example":"2020-01-01T12:00:00Z"},{"name":"deadlineTo","in":"query","schema":{"type":"string","description":"Retrieve jobs with a deadline before this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time"},"example":"2020-01-01T12:00:00Z"},{"name":"resonsibleIDs","in":"query","schema":{"type":"string"},"example":"00000000000000000000000000000000,00000000000000000000000000000000"},{"name":"accountableIDs","in":"query","schema":{"type":"string"},"example":"00000000000000000000000000000000,00000000000000000000000000000000"},{"name":"status","in":"query","schema":{"type":"string"},"example":"Approved,NeedsChanges"},{"name":"orderBy","in":"query","schema":{"type":"string"},"example":"dateModified desc"},{"name":"limit","in":"query","schema":{"type":"integer"},"example":100},{"name":"page","in":"query","schema":{"type":"integer"},"example":1}],"responses":{"200":{"description":"Successful response","headers":{"X-Pagination-TotalRecords":{"schema":{"type":"integer"},"example":10000},"X-Pagination-TotalPages":{"schema":{"type":"integer"},"example":100},"X-Pagination-Page":{"schema":{"type":"integer"},"example":2},"X-Pagination-Limit":{"schema":{"type":"integer"},"example":100}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"deadline":{"type":"string"},"createdByID":{"type":"string"},"accountableID":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"basedOnPreset":{"type":"string"},"presetID":{"type":"string"},"campaignID":{"type":"string"},"bookedMinutes":{"type":"number"},"jobKey":{"type":"string"},"dateFinished":{"type":"string"},"jobFinishedHistory":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string"}}}},"job_stages":{"type":"array","items":{"type":"object","properties":{"position":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"}}}},"job_previous_stage":{"type":"object","properties":{"position":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"}}},"job_active_stage":{"type":"object","properties":{"position":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"}}},"job_next_stage":{"type":"object","properties":{"position":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"}}},"jobMetaproperties":{"type":"object","additionalProperties":{"type":"string"}}}}},"examples":{"example-1":{"value":[{"job_stages":[{"position":1,"status":"Approved","id":"00000000-0000-0000-0000-000000000000"},{"position":2,"status":"Active","id":"00000000-0000-0000-0000-000000000000"},{"position":3,"status":"Idle","id":"00000000-0000-0000-0000-000000000000"}],"dateModified":"2017-03-30T11:43:19+00:00","presetID":null,"jobKey":"0000-0","dateFinished":"2021-02-25T16:19:42+00:00","jobFinishedHistory":[{"userId":"00000000-0000-0000-0000-000000000000","date":"2021-02-24T16:23:48+00:00"},{"userId":"00000000-0000-0000-0000-000000000000","date":"2021-02-25T16:19:42+00:00"}],"jobMetaproperties":{"00000000-0000-0000-0000-000000000001":"00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000002":"Country","00000000-0000-0000-0000-000000000003":"City"},"createdByID":"00000000-0000-0000-0000-000000000000","job_next_stage":{"position":3,"status":"Idle","id":"00000000-0000-0000-0000-000000000000"},"id":"00000000-0000-0000-0000-000000000000","description":"","accountableID":"00000000-0000-0000-0000-000000000000","basedOnPreset":false,"dateCreated":"2017-03-30T11:42:30+00:00","job_active_stage":{"position":2,"status":"Active","id":"00000000-0000-0000-0000-000000000000"},"deadline":null,"name":"Test API","campaignID":"00000000-0000-0000-0000-000000000000","job_previous_stage":{"position":1,"status":"Approved","id":"00000000-0000-0000-0000-000000000000"}},{"job_stages":[{"position":1,"status":"Approved","id":"00000000-0000-0000-0000-000000000000"},{"position":2,"status":"Active","id":"00000000-0000-0000-0000-000000000000"},{"position":3,"status":"Idle","id":"00000000-0000-0000-0000-000000000000","bookedMinutes":5}],"dateModified":"2017-03-30T11:43:19+00:00","presetID":null,"jobKey":"0000-0","dateFinished":null,"jobFinishedHistory":null,"jobMetaproperties":{"00000000-0000-0000-0000-000000000001":"00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000002":"Country","00000000-0000-0000-0000-000000000003":"City"},"createdByID":"00000000-0000-0000-0000-000000000000","job_next_stage":{"position":3,"status":"Idle","id":"00000000-0000-0000-0000-000000000000"},"id":"00000000-0000-0000-0000-000000000000","description":"","accountableID":"00000000-0000-0000-0000-000000000000","basedOnPreset":false,"dateCreated":"2017-03-30T11:42:30+00:00","job_active_stage":{"position":2,"status":"Active","id":"00000000-0000-0000-0000-000000000000"},"deadline":null,"name":"Test API with booked time","campaignID":"00000000-0000-0000-0000-000000000000","bookedMinutes":10,"job_previous_stage":{"position":1,"status":"Approved","id":"00000000-0000-0000-0000-000000000000"}}]}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-campaigns-id.md","page_updatedAt":"2026-01-07T16:02:10.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Campaigns API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Campaigns","description":""}],"paths":{"/api/workflow/campaigns/{id}":{"get":{"summary":"Retrieve specific campaign","description":"Requires the CAMPAIGNOVERVIEW security role.","tags":["Campaigns"],"security":[{"OAuth2":["CAMPAIGNOVERVIEW"]},{"permanentToken":["CAMPAIGNOVERVIEW"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"responses":{"200":{"description":"Successfully retrieved specific campaign","content":{"application/json":{"schema":{"type":"object","properties":{"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"Example campaign"},"key":{"type":"string","example":"excp"},"closed":{"type":"boolean","example":false},"description":{"type":"string","example":"Campaign example"},"dateStart":{"type":"string","format":"date-time","example":"2017-02-01T00:00:00+00:00"},"deadline":{"type":"string","format":"date","example":"2017-03-03T00:00:00"},"accountID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"presetID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"createdByID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"responsibleID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"dateCreated":{"type":"string","format":"date-time","example":"2017-01-10T07:43:12+00:00"},"dateModified":{"type":"string","format":"date-time","example":"2017-01-10T07:43:12+00:00"},"thumbnailURL":{"type":"string","example":"https://bynder-public-eu-central-1.s3.eu-central-1.amazonaws.com:443/workflow/campaign/988BBB04-F0E2-4A28-B5F892890849BAFE/FEE78434-649A-449B-A62A1C6C6D59CAC3/500x500.jpg"},"campaignMetaproperties":{"type":"object","additionalProperties":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"CAMPAIGNOVERVIEW":"","CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"CAMPAIGNOVERVIEW":"","CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-campaigns.md","page_updatedAt":"2026-01-07T16:02:10.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Campaigns API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Campaigns","description":""}],"paths":{"/api/workflow/campaigns":{"get":{"summary":"Retrieve campaigns","description":"Requires the CAMPAIGNOVERVIEW security role.","tags":["Campaigns"],"security":[{"OAuth2":["CAMPAIGNOVERVIEW"]},{"permanentToken":["CAMPAIGNOVERVIEW"]}],"responses":{"200":{"description":"Successfully retrieved campaigns","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"dateStart":{"type":"string","format":"date-time","example":"2017-02-01T00:00:00+00:00"},"description":{"type":"string","example":"Campaign example"},"responsibleID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"dateModified":{"type":"string","format":"date-time","example":"2017-01-10T07:43:12+00:00"},"dateCreated":{"type":"string","format":"date-time","example":"2017-01-10T07:43:12+00:00"},"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"deadline":{"type":"string","format":"date","example":"2017-03-03T00:00:00"},"createdByID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"accountID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"presetID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"closed":{"type":"boolean","example":false},"key":{"type":"string","example":"excp"},"name":{"type":"string","example":"Example campaign"},"thumbnailURL":{"type":"string","example":"https://bynder-public-eu-central-1.s3.eu-central-1.amazonaws.com:443/workflow/campaign/988BBB04-F0E2-4A28-B5F892890849BAFE/FEE78434-649A-449B-A62A1C6C6D59CAC3/500x500.jpg"},"campaignMetaproperties":{"type":"object","additionalProperties":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"CAMPAIGNOVERVIEW":"","CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"CAMPAIGNOVERVIEW":"","CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-groups-id.md","page_updatedAt":"2026-01-07T15:22:03.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Users and Groups API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Groups","description":""}],"paths":{"/api/workflow/groups/{id}":{"get":{"summary":"Retrieve specific group","tags":["Groups"],"security":[{"permanentToken":["GROUPOVERVIEW","WORKFLOWADMIN"]},{"OAuth2":["GROUPOVERVIEW","WORKFLOWADMIN"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"responses":{"200":{"description":"A specific workflow group","content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"bynderUser":{"type":"object","properties":{"firstName":{"type":"string","example":"FirstName"},"lastName":{"type":"string","example":"LastName"},"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"infix":{"type":"string","example":null},"email":{"type":"string","example":"test@bynder.com"}}},"fullName":{"type":"string","example":"FirstName LastName"},"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}},"accountID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"createdByID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"Content Reviewers"},"dateCreated":{"type":"string","example":"2017-10-27T16:32:16+00:00"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-groups.md","page_updatedAt":"2026-01-07T15:22:03.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Users and Groups API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Groups","description":""}],"paths":{"/api/workflow/groups/":{"get":{"summary":"Retrieve groups","tags":["Groups"],"security":[{"permanentToken":["GROUPOVERVIEW","WORKFLOWADMIN"]},{"OAuth2":["GROUPOVERVIEW","WORKFLOWADMIN"]}],"responses":{"200":{"description":"A list of workflow groups","content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"type":"object","properties":{"bynderUser":{"type":"object","properties":{"firstName":{"type":"string","example":"FirstName"},"lastName":{"type":"string","example":"LastName"},"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"infix":{"type":"string","example":null},"email":{"type":"string","example":"test@bynder.com"}}},"fullName":{"type":"string","example":"FirstName LastName"},"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}},"accountID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"createdByID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","example":"Content Reviewers"},"dateCreated":{"type":"string","example":"2017-10-27T16:32:16+00:00"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-jobs-id-media.md","page_updatedAt":"2026-05-15T13:16:00.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Jobs API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Job media","description":""}],"paths":{"/api/workflow/jobs/{id}/media":{"get":{"summary":"Retrieve media of specific job","description":"Requires the JOBOVERVIEW security role.","tags":["Job media"],"security":[{"permanentToken":["JOBOVERVIEW"]},{"OAuth2":["JOBOVERVIEW"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"00000000-0000-0000-0000-000000000000"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"filename":{"type":"string"},"uploader_name":{"type":"string"},"responsible_name":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"orientation":{"type":"string"},"original_url":{"type":"string"},"status":{"type":"string"},"versionParentID":{"type":"string"},"version":{"type":"number"},"previews":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"}}}},"sub_versions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"filename":{"type":"string"},"uploader_name":{"type":"string"},"responsible_name":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"orientation":{"type":"string"},"original_url":{"type":"string"},"status":{"type":"string"},"versionParentID":{"type":"string"},"version":{"type":"number"},"previews":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"}}}},"sub_versions":{"type":"array","items":{}}}}}}}},"examples":{"example-1":{"value":[{"id":"00000000-0000-0000-0000-000000000000","filename":"filename.png","uploader_name":"John Doe","responsible_name":"John Doe","dateCreated":"2021-05-12T08:48:01+00:00","dateModified":"2021-05-12T08:51:22+00:00","orientation":"square","original_url":"https://url.to.file/original.png","status":"AwaitingApproval","versionParentID":null,"version":1,"previews":[{"type":"thumbnail","url":"https://url.to.file/preview.png"},{"type":"preview","url":"https://url.to.file/preview.png"},{"type":"activity","url":"https://url.to.file/preview.png"}],"sub_versions":[{"id":"00000000-0000-0000-0000-000000000000","filename":"filename.png","uploader_name":"John Doe","responsible_name":"John Doe","dateCreated":"2021-05-13T08:48:01+00:00","dateModified":"2021-05-13T08:51:22+00:00","orientation":"square","original_url":"https://url.to.file/original.png","status":"AwaitingApproval","versionParentID":"00000000-0000-0000-0000-000000000000","version":2,"previews":[{"type":"thumbnail","url":"https://url.to.file/preview.png"},{"type":"preview","url":"https://url.to.file/preview.png"},{"type":"activity","url":"https://url.to.file/preview.png"}],"sub_versions":[]}]}]}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-jobs-id-stages.md","page_updatedAt":"2026-05-15T13:16:00.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Jobs API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"paths":{"/api/workflow/jobs/{id}/stages":{"get":{"summary":"Retrieve stages of specific job","description":"Requires the JOBOVERVIEW security role.","tags":["Job stages"],"security":[{"permanentToken":["JOBOVERVIEW"]},{"OAuth2":["JOBOVERVIEW"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"00000000-0000-0000-0000-000000000000"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"deadline":{"type":"string","nullable":true},"dateCreated":{"type":"string"},"createdByID":{"type":"string"},"status":{"type":"string","enum":["Idle","Active","Cancelled","Approved","NeedsChanges"]},"position":{"type":"number"},"responsible":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["user","group"]}}}}}},"examples":{"example-1":{"value":[{"id":"00000000-0000-0000-0000-000000000000","name":"Start stage","description":"This is the first stage","deadline":null,"dateCreated":"2021-02-08T16:38:03+00:00","createdByID":"00000000-0000-0000-0000-000000000000","status":"Active","position":1,"responsible":{"id":"00000000-0000-0000-0000-000000000000","type":"user"}},{"id":"00000000-0000-0000-0000-000000000000","name":"Second stage","description":"","deadline":"2021-02-18T18:00:00+00:00","dateCreated":"2021-02-08T16:38:03+00:00","createdByID":"00000000-0000-0000-0000-000000000000","status":"Idle","position":2,"responsible":{"id":"00000000-0000-0000-0000-000000000000","type":"group"}}]}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-jobs-id.md","page_updatedAt":"2026-05-15T13:16:00.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Jobs API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Jobs","description":""}],"paths":{"/api/workflow/jobs/{id}":{"get":{"summary":"Retrieve specific job","description":"Requires the JOBOVERVIEW security role.","tags":["Jobs"],"security":[{"permanentToken":["JOBOVERVIEW"]},{"OAuth2":["JOBOVERVIEW"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"00000000-0000-0000-0000-000000000000"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"deadline":{"type":"string"},"createdByID":{"type":"string"},"accountableID":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"basedOnPreset":{"type":"string"},"presetID":{"type":"string"},"campaignID":{"type":"string"},"bookedMinutes":{"type":"number"},"jobKey":{"type":"string"},"dateFinished":{"type":"string"},"jobFinishedHistory":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string"}}}},"job_stages":{"type":"array","items":{"type":"object","properties":{"position":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"}}}},"job_previous_stage":{"type":"object","properties":{"position":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"}}},"job_active_stage":{"type":"object","properties":{"position":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"}}},"job_next_stage":{"type":"object","properties":{"position":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"}}},"jobMetaproperties":{"type":"object","additionalProperties":{"type":"string"}}}},"examples":{"example-1":{"value":{"id":"00000000-0000-0000-0000-000000000000","name":"Test API","description":"","deadline":null,"createdByID":"00000000-0000-0000-0000-000000000000","accountableID":"00000000-0000-0000-0000-000000000000","dateCreated":"2017-03-30T11:42:30+00:00","dateModified":"2017-03-30T11:43:19+00:00","basedOnPreset":false,"presetID":null,"campaignID":"00000000-0000-0000-0000-000000000000","bookedMinutes":10,"jobKey":"0000-0","dateFinished":"2021-02-25T16:19:42+00:00","jobFinishedHistory":[{"userId":"00000000-0000-0000-0000-000000000000","date":"2021-02-24T16:23:48+00:00"},{"userId":"00000000-0000-0000-0000-000000000000","date":"2021-02-25T16:19:42+00:00"}],"job_stages":[{"position":1,"status":"Approved","id":"00000000-0000-0000-0000-000000000000"},{"position":2,"status":"Active","id":"00000000-0000-0000-0000-000000000000"},{"position":3,"status":"Idle","id":"00000000-0000-0000-0000-000000000000"}],"job_previous_stage":{"position":1,"status":"Approved","id":"00000000-0000-0000-0000-000000000000"},"job_active_stage":{"position":2,"status":"Active","id":"00000000-0000-0000-0000-000000000000"},"job_next_stage":{"position":3,"status":"Idle","id":"00000000-0000-0000-0000-000000000000"},"jobMetaproperties":{}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-jobs.md","page_updatedAt":"2026-05-15T13:16:00.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Jobs API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Jobs","description":""}],"paths":{"/api/workflow/jobs":{"get":{"summary":"Retrieve jobs","tags":["Jobs"],"security":[{"permanentToken":["JOBOVERVIEW"]},{"OAuth2":["JOBOVERVIEW"]}],"parameters":[{"name":"dateCreatedFrom","in":"query","schema":{"type":"string","description":"Retrieve jobs created after this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time"},"example":"2020-01-01T12:00:00Z"},{"name":"dateCreatedTo","in":"query","schema":{"type":"string","description":"Set a date range together with the \"dateCreated\" parameter. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time"},"example":"2020-01-01T12:00:00Z"},{"name":"dateModifiedFrom","in":"query","schema":{"type":"string","description":"Retrieve jobs modified after this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time"},"example":"2020-01-01T12:00:00Z"},{"name":"dateModifiedTo","in":"query","schema":{"type":"string","description":"Set a date range together with the \"dateModified\" parameter. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time"},"example":"2020-01-01T12:00:00Z"},{"name":"deadlineFrom","in":"query","schema":{"type":"string","description":"Retrieve jobs with a deadline after this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time"},"example":"2020-01-01T12:00:00Z"},{"name":"deadlineTo","in":"query","schema":{"type":"string","description":"Retrieve jobs with a deadline before this date. ISO8601 format yyyy-mm-ddThh:mm:ssZ.","format":"date-time"},"example":"2020-01-01T12:00:00Z"},{"name":"resonsibleIDs","in":"query","schema":{"type":"string"},"example":"00000000000000000000000000000000,00000000000000000000000000000000"},{"name":"accountableIDs","in":"query","schema":{"type":"string"},"example":"00000000000000000000000000000000,00000000000000000000000000000000"},{"name":"status","in":"query","schema":{"type":"string"},"example":"Approved,NeedsChanges"},{"name":"orderBy","in":"query","schema":{"type":"string"},"example":"deadline asc"},{"name":"limit","in":"query","schema":{"type":"integer"},"example":100},{"name":"page","in":"query","schema":{"type":"integer"},"example":1}],"responses":{"200":{"description":"Successful response","headers":{"X-Pagination-TotalRecords":{"schema":{"type":"integer"},"example":10000},"X-Pagination-TotalPages":{"schema":{"type":"integer"},"example":100},"X-Pagination-Page":{"schema":{"type":"integer"},"example":2},"X-Pagination-Limit":{"schema":{"type":"integer"},"example":100}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"deadline":{"type":"string"},"createdByID":{"type":"string"},"accountableID":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"basedOnPreset":{"type":"string"},"presetID":{"type":"string"},"campaignID":{"type":"string"},"bookedMinutes":{"type":"number"},"jobKey":{"type":"string"},"dateFinished":{"type":"string"},"jobFinishedHistory":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string"},"date":{"type":"string"}}}},"job_stages":{"type":"array","items":{"type":"object","properties":{"position":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"}}}},"job_previous_stage":{"type":"object","properties":{"position":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"}}},"job_active_stage":{"type":"object","properties":{"position":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"}}},"job_next_stage":{"type":"object","properties":{"position":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"}}},"jobMetaproperties":{"type":"object","properties":{"metapropertyId":{"type":"string"}}}}}},"examples":{"example-1":{"value":[{"job_stages":[{"position":1,"status":"Approved","id":"00000000-0000-0000-0000-000000000000"},{"position":2,"status":"Active","id":"00000000-0000-0000-0000-000000000000"},{"position":3,"status":"Idle","id":"00000000-0000-0000-0000-000000000000"}],"dateModified":"2017-03-30T11:43:19+00:00","presetID":null,"jobKey":"0000-0","dateFinished":null,"jobFinishedHistory":null,"jobMetaproperties":{"00000000-0000-0000-0000-000000000001":"00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000002":"Country","00000000-0000-0000-0000-000000000003":"City"},"createdByID":"00000000-0000-0000-0000-000000000000","job_next_stage":{"position":3,"status":"Idle","id":"00000000-0000-0000-0000-000000000000"},"id":"00000000-0000-0000-0000-000000000000","description":"","accountableID":"00000000-0000-0000-0000-000000000000","basedOnPreset":false,"dateCreated":"2017-03-30T11:42:30+00:00","job_active_stage":{"position":2,"status":"Active","id":"00000000-0000-0000-0000-000000000000"},"deadline":null,"name":"Test API","campaignID":"00000000-0000-0000-0000-000000000000","job_previous_stage":{"position":1,"status":"Approved","id":"00000000-0000-0000-0000-000000000000"}},{"job_stages":[{"position":1,"status":"Approved","id":"00000000-0000-0000-0000-000000000000"},{"position":2,"status":"Active","id":"00000000-0000-0000-0000-000000000000"},{"position":3,"status":"Idle","id":"00000000-0000-0000-0000-000000000000","bookedMinutes":5}],"dateModified":"2017-03-30T11:43:19+00:00","presetID":null,"jobKey":"0000-0","dateFinished":"2021-02-25T16:19:42+00:00","jobFinishedHistory":[{"userId":"00000000-0000-0000-0000-000000000000","date":"2021-02-24T16:23:48+00:00"},{"userId":"00000000-0000-0000-0000-000000000000","date":"2021-02-25T16:19:42+00:00"}],"jobMetaproperties":{"00000000-0000-0000-0000-000000000001":"00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000002":"Country","00000000-0000-0000-0000-000000000003":"City"},"createdByID":"00000000-0000-0000-0000-000000000000","job_next_stage":{"position":3,"status":"Idle","id":"00000000-0000-0000-0000-000000000000"},"id":"00000000-0000-0000-0000-000000000000","description":"","accountableID":"00000000-0000-0000-0000-000000000000","basedOnPreset":false,"dateCreated":"2017-03-30T11:42:30+00:00","job_active_stage":{"position":2,"status":"Active","id":"00000000-0000-0000-0000-000000000000"},"deadline":null,"name":"Test API with booked time","campaignID":"00000000-0000-0000-0000-000000000000","bookedMinutes":10,"job_previous_stage":{"position":1,"status":"Approved","id":"00000000-0000-0000-0000-000000000000"}}]}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-metaproperties-id.md","page_updatedAt":"2026-01-07T15:29:32.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Metaproperties API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Metaproperties","description":""}],"paths":{"/api/workflow/metaproperties/{id}":{"get":{"summary":"Retrieve specific metaproperty","tags":["Metaproperties"],"security":[{"permanentToken":["METAPROPERTYOVERVIEW"]},{"OAuth2":["METAPROPERTYOVERVIEW"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"responses":{"200":{"description":"Metaproperty object","content":{"application/json":{"schema":{"type":"object","properties":{"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"label":{"type":"string","example":"Holiday Type"},"short_name":{"type":"string","example":"JOB-9"},"description":{"type":"string","example":""},"export":{"type":"string","example":"false"},"removed_by":{"type":"string","example":null},"dependency":{"type":"string","example":null},"position":{"type":"number","example":12},"default":{"type":"boolean","example":true},"dateCreated":{"type":"string","example":"2017-10-27T16:31:52+00:00"},"exportName":{"type":"string","example":""},"type":{"type":"string","example":"select"},"required":{"type":"boolean","example":false},"dependencyValue":{"type":"string","example":null},"assetbank_metaproperty":{"type":"string","example":null},"entity":{"type":"string","enum":["job","campaign"],"example":"job"},"created_by":{"type":"object","properties":{"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"fullName":{"type":"string","example":"User1"}}},"options":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"position":{"type":"number","example":1},"default":{"type":"boolean","example":true},"label":{"type":"string","example":"Beach"},"dateCreated":{"type":"string","example":"2017-10-27T16:31:52+00:00"},"metapropertyID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_by":{"type":"object","properties":{"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"fullName":{"type":"string","example":"User1"}}}}}}}},"examples":{"example-1":{"value":{"ID":"00000000-0000-0000-0000-000000000000","label":"Holiday Type","short_name":"JOB-9","description":"","export":"false","removed_by":null,"dependency":null,"position":12,"default":true,"dateCreated":"2017-10-27T16:31:52+00:00","exportName":"","type":"select","required":false,"dependencyValue":null,"assetbank_metaproperty":null,"entity":"job","created_by":{"ID":"00000000-0000-0000-0000-000000000000","fullName":"User1"},"options":[{"ID":"00000000-0000-0000-0000-000000000000","position":1,"default":true,"label":"Beach","dateCreated":"2017-10-27T16:31:52+00:00","metapropertyID":"00000000-0000-0000-0000-000000000000","created_by":{"ID":"00000000-0000-0000-0000-000000000000","fullName":"User1"}},{"ID":"00000000-0000-0000-0000-000000000000","position":2,"default":false,"label":"Sightseeing","dateCreated":"2017-10-27T16:32:16+00:00","metapropertyID":"00000000-0000-0000-0000-000000000000","created_by":{"ID":"00000000-0000-0000-0000-000000000000","fullName":"User1"}},{"ID":"00000000-0000-0000-0000-000000000000","position":3,"default":false,"label":"Wintersport","dateCreated":"2017-10-27T16:32:16+00:00","metapropertyID":"00000000-0000-0000-0000-000000000000","created_by":{"ID":"00000000-0000-0000-0000-000000000000","fullName":"User1"}},{"ID":"00000000-0000-0000-0000-000000000000","position":4,"default":false,"label":"Nature","dateCreated":"2017-10-27T16:32:16+00:00","metapropertyID":"00000000-0000-0000-0000-000000000000","created_by":{"ID":"00000000-0000-0000-0000-000000000000","fullName":"User1"}}]}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYOVERVIEW":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYOVERVIEW":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-metaproperties.md","page_updatedAt":"2026-01-07T15:29:32.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Metaproperties API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Metaproperties","description":""}],"paths":{"/api/workflow/metaproperties":{"get":{"summary":"Retrieve metaproperties","tags":["Metaproperties"],"security":[{"permanentToken":["METAPROPERTYOVERVIEW"]},{"OAuth2":["METAPROPERTYOVERVIEW"]}],"responses":{"200":{"description":"List of metaproperties","content":{"application/json":{"schema":{"type":"object","properties":{"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"label":{"type":"string","example":"Holiday Type"},"short_name":{"type":"string","example":"JOB-9"},"description":{"type":"string","example":""},"export":{"type":"string","example":"false"},"removed_by":{"type":"string","example":null},"dependency":{"type":"string","example":null},"position":{"type":"number","example":12},"default":{"type":"boolean","example":true},"dateCreated":{"type":"string","example":"2017-10-27T16:31:52+00:00"},"exportName":{"type":"string","example":""},"type":{"type":"string","example":"select"},"required":{"type":"boolean","example":false},"dependencyValue":{"type":"string","example":null},"assetbank_metaproperty":{"type":"string","example":null},"entity":{"type":"string","enum":["job","campaign"],"example":"job"},"created_by":{"type":"object","properties":{"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"fullName":{"type":"string","example":"User1"}}},"options":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"position":{"type":"number","example":1},"default":{"type":"boolean","example":true},"label":{"type":"string","example":"Beach"},"dateCreated":{"type":"string","example":"2017-10-27T16:31:52+00:00"},"metapropertyID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"created_by":{"type":"object","properties":{"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"fullName":{"type":"string","example":"User1"}}}}}}}},"examples":{"example-1":{"value":{"ID":"00000000-0000-0000-0000-000000000000","label":"Holiday Type","short_name":"JOB-9","description":"","export":"false","removed_by":null,"dependency":null,"position":12,"default":true,"dateCreated":"2017-10-27T16:31:52+00:00","exportName":"","type":"select","required":false,"dependencyValue":null,"assetbank_metaproperty":null,"entity":"job","created_by":{"ID":"00000000-0000-0000-0000-000000000000","fullName":"User1"},"options":[{"ID":"00000000-0000-0000-0000-000000000000","position":1,"default":true,"label":"Beach","dateCreated":"2017-10-27T16:31:52+00:00","metapropertyID":"00000000-0000-0000-0000-000000000000","created_by":{"ID":"00000000-0000-0000-0000-000000000000","fullName":"User1"}},{"ID":"00000000-0000-0000-0000-000000000000","position":2,"default":false,"label":"Sightseeing","dateCreated":"2017-10-27T16:32:16+00:00","metapropertyID":"00000000-0000-0000-0000-000000000000","created_by":{"ID":"00000000-0000-0000-0000-000000000000","fullName":"User1"}},{"ID":"00000000-0000-0000-0000-000000000000","position":3,"default":false,"label":"Wintersport","dateCreated":"2017-10-27T16:32:16+00:00","metapropertyID":"00000000-0000-0000-0000-000000000000","created_by":{"ID":"00000000-0000-0000-0000-000000000000","fullName":"User1"}},{"ID":"00000000-0000-0000-0000-000000000000","position":4,"default":false,"label":"Nature","dateCreated":"2017-10-27T16:32:16+00:00","metapropertyID":"00000000-0000-0000-0000-000000000000","created_by":{"ID":"00000000-0000-0000-0000-000000000000","fullName":"User1"}}]}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYOVERVIEW":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYOVERVIEW":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-presets-job-id.md","page_updatedAt":"2026-05-15T13:16:00.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Jobs API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Presets","description":""}],"paths":{"/api/workflow/presets/job/{id}":{"get":{"summary":"Retrieve specific job preset","tags":["Presets"],"security":[{"permanentToken":["PRESETOVERVIEW"]},{"OAuth2":["PRESETOVERVIEW"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"00000000-0000-0000-0000-000000000000"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"ID":{"type":"string"},"name":{"type":"string"},"ftp_settings":{"type":"string"},"wf_uuid":{"type":"string"},"presetstages":{"type":"object","properties":{"ID":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"position":{"type":"string"},"editableBy":{"type":"string"},"restrictToGroupID":{"type":"string"},"type":{"type":"string"},"responsibleID":{"type":"string"},"responsibleGroupID":{"type":"string"}}}}},"examples":{"example-1":{"value":{"ID":"00000000-0000-0000-0000-000000000000","name":"API name","ftp_settings":{},"wf_uuid":"00000000-0000-0000-0000-000000000000","presetstages":{"ID":"00000000-0000-0000-0000-000000000000","name":"Revision Stage","description":"","position":"1.0","editableBy":"all","restrictToGroupID":null,"type":"download","responsibleID":null,"responsibleGroupID":null}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-users-id.md","page_updatedAt":"2026-01-07T15:22:03.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Users and Groups API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Users","description":""}],"paths":{"/api/workflow/users/{id}":{"get":{"summary":"Retrieve specific user","tags":["Users"],"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"responses":{"200":{"description":"A specific workflow user","content":{"application/json":{"schema":{"type":"object","properties":{"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"fullname":{"type":"string","example":"Firstname Lastname"},"BynderUser":{"type":"object","properties":{"firstName":{"type":"string","example":"Firstname"},"lastName":{"type":"string","example":"Lastname"},"infix":{"type":"string","example":"Van"},"email":{"type":"string","example":"example@example.com"},"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_api-workflow-users.md","page_updatedAt":"2026-01-07T15:22:03.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Users and Groups API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Users","description":""}],"paths":{"/api/workflow/users/":{"get":{"summary":"Retrieve users","tags":["Users"],"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"responses":{"200":{"description":"A list of workflow users","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"ID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"fullname":{"type":"string","example":"Firstname Lastname"},"BynderUser":{"type":"object","properties":{"firstName":{"type":"string","example":"Firstname"},"lastName":{"type":"string","example":"Lastname"},"infix":{"type":"string","example":"Van"},"email":{"type":"string","example":"example@example.com"},"id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_transform-id-name.md","page_updatedAt":"2025-11-26T16:08:20.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Dynamic Asset Transformations API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":[]},{"permanentToken":[]}],"paths":{"/transform/{id}/{name}":{"get":{"summary":"Generate dynamic asset transformation","description":"Generate a derivative on the fly with a transformation (such as cropping, scaling, filling) applied to it.   More information about this feature can be found in our [Knowledge Base item](https://support.bynder.com/hc/en-us/articles/360018559260-Dynamic-Asset-Transformations-DAT-).\nImage operations can be passed as `io` parameters in the form of `transform:{operation},{param1}:{value1},{param2}:{value2},...`.   It's possible to specify several operations: `?io={operation1}&io={operation2}&...`. The operations will be applied in the same order they are passed in the url.\nThese are the possible image operations and their parameters:\n| Operation    | Parameter       | Possible values                                                                      | | ------------ | --------------- | ------------------------------------------------------------------------------------ | | `background` | color           | color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb)                        | | `crop`       | width           | integer                                                                              | |              | height          | integer                                                                              | |              | x               | integer                                                                              | |              | y               | integer                                                                              | |              | gravity         | topleft / top / topright / left / center / right / bottomleft / bottom / bottomright | |              | shape           | circle / square                                                                      | |              | blur            | integer                                                                              | |              | background      | color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb)                        | | `extend`     | width           | integer                                                                              | |              | height          | integer                                                                              | |              | background      | color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb)                        | | `fill`       | width           | integer                                                                              | |              | height          | integer                                                                              | |              | gravity         | topleft / top / topright / left / center / right / bottomleft / bottom / bottomright | |              | aspectratio     | {integer}x{integer}                                                                  | | `fit`        | width           | integer                                                                              | |              | height          | integer                                                                              | | `flip`       | (no parameters) |                                                                                      | | `mirror`     | (no parameters) |                                                                                      | | `rotate`     | angle           | integer between 0 and 360                                                            | |              | background      | color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb)                        | | `scale`      | width           | integer                                                                              | |              | height          | integer                                                                              |\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"io","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"The operation(s) performed on the image before it's served to the client."},{"name":"focuspoint","in":"query","required":false,"schema":{"type":"string"},"description":"Focus point as a x,y coordinate (with values between 0 - 1)."},{"name":"format","in":"query","required":false,"schema":{"type":"string"},"description":"Format of the served image. This can either be `jpg` or `png` and it will overwrite the default `webP`."},{"name":"quality","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Image quality, ranging from 1 - 100 (has no effect when `format` is set to 'png')."}],"responses":{"200":{"description":"Image","content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}},"image/png":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Image Operation not supported"},"404":{"description":"Not Found"}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_v6-authentication-oauth2-auth.md","page_updatedAt":"2025-06-04T04:53:09.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"OAuth 2.0","version":"1.0.0"},"tags":[{"name":"Authorize endpoint","description":"When using the Authorization Code grant, redirect the user to the [Authorize application](#reference/oauth-2.0/authorize-endpoint/authorize-application) endpoint. After the user\nis authenticated and approves the authorization request, Bynder will redirect the user back with an\nauthorization code which can then be passed to the [Token endpoint](#reference/oauth-2.0/token-endpoint/using-an-authorization-code).\n"}],"paths":{"/v6/authentication/oauth2/auth":{"get":{"summary":"Authorize endpoint","description":"When using the Authorization Code grant, redirect the user to the Authorize application endpoint. After the user is authenticated and approves the authorization request, Bynder will redirect the user back with an authorization code which can then be passed to the Token endpoint.\n","tags":["Authorize endpoint"],"parameters":[{"name":"client_id","in":"query","required":true,"schema":{"type":"string"},"example":"00000000-0000-0000-0000-000000000000"},{"name":"scope","in":"query","required":true,"schema":{"type":"string"},"example":"offline asset:read"},{"name":"redirect_uri","in":"query","required":true,"schema":{"type":"string"},"example":"https://localhost/callback"},{"name":"response_type","in":"query","required":true,"schema":{"type":"string"},"example":"code"},{"name":"state","in":"query","required":false,"schema":{"type":"string"},"example":"xyz"}],"responses":{"302":{"description":"Found. Redirecting to the login provider.","headers":{"Location":{"description":"URL to redirect the user to for login.","schema":{"type":"string"}}},"content":{"text/plain":{"examples":{"example-1":{"value":"Found. Redirecting to https://your-bynder-domain/v6/login-provider/login?login_challenge=8e41a26ceb3b845114b5a37d9d0e2e50"}}}}}},"security":[{"OAuth2":[]}]}}}}}
{"source_url":"https://api.bynder.com/reference/get_v6-authentication-oauth2-scopes.md","page_updatedAt":"2025-06-04T04:53:09.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"OAuth 2.0","version":"1.0.0"},"paths":{"/v6/authentication/oauth2/scopes":{"get":{"summary":"Retrieve scopes","description":"Retrieve a JSON formatted overview of the existing scopes within Bynder and the required user permissions.","tags":["Scopes"],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"groups":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Group name"},"scopes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"scope:action"},"description":{"type":"string","example":"Scope description"},"anyOfPermissions":{"type":"array","items":{"type":"string","example":"scope.permission"}}}}}}}}}},"examples":{"example-1":{"value":{"groups":[{"name":"Group name","scopes":[{"name":"scope:action","description":"Scope description","anyOfPermissions":["scope.permission"]}]}]}}}}}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-archive.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V1","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/asset/archive":{"get":{"summary":"Retrieve asset archive events","description":"Retrieve archive events for assets within a specified date range.","tags":["Asset Usage V1"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000,"example":100}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA","example":"MTAwMA"}},{"name":"fromDateTime","in":"query","description":"Retrieve archive events occurred after this date.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-01-01T01:00:00.000Z"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-06-01T01:00:00.000Z"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string","example":"MTAwMA"}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/api/v1/asset/archive?limit=1000&cursor=MTAwMA"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"62de6d714e29485a81824fe3"},"eventType":{"type":"string","example":"asset.archive"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781Z"},"assetId":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C0"},"assetType":{"type":"string","example":"image"},"assetName":{"type":"string","example":"Product Insights"},"assetAudit":{"type":"string","example":"ACCEPTED"},"fileName":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights"}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"id\": \"62de6d714e29485a81824fe3\",\n    \"eventType\": \"asset.archive\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\",\n    \"assetType\": \"image\",\n    \"assetName\": \"Product Insights\",\n    \"assetAudit\": \"ACCEPTED\",\n    \"fileName\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights\"\n  },\n  {\n    \"id\": \"62de6d714e29485a81824fe4\",\n    \"eventType\": \"asset.archive\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:08:18.752+00:00\",\n    \"assetId\": \"C58ED8C6-6B09-4CD6-B71C32C6715834F1\",\n    \"assetType\": \"image\",\n    \"assetName\": \"Reporting Schedule Nov 2022\",\n    \"assetAudit\": \"ACCEPTED\",\n    \"fileName\": \"C58ED8C6-6B09-4CD6-B71C32C6715834F1___Reporting Schedule Nov 2022\"\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-assetid.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V1","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/asset/{assetId}":{"get":{"summary":"Retrieve all events performed in a given asset","description":"This endpoint will allow you to retrieve all the events performed in a given asset.","tags":["Asset Usage V1"],"parameters":[{"name":"assetId","in":"path","description":"Asset id.","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000,"example":100}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA","example":"MTAwMA"}},{"name":"fromDateTime","in":"query","description":"Retrieve events performed in a given asset occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-01-01T01:00"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-06-01T01:00"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string","example":"MTAwMA"}},"Next-Url":{"description":"The next url path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/api/v1/asset/CA510292-E39E-4B28-AB6444CDD2B1C5C0?limit=1000&cursor=MTAwMA"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"62de6d714e29485a81824fe3"},"eventType":{"type":"string","example":"asset.download"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"},"assetId":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C0"},"assetType":{"type":"string","example":"image"},"assetName":{"type":"string","example":"Product Insights"},"assetAudit":{"type":"string","example":"ACCEPTED"},"fileName":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights"},"mediaItemId":{"type":"string","example":"69293464-7721-4062-9E05EFAF23FE70E7"},"mediaItemType":{"type":"string","example":"original"}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"id\": \"62de6d714e29485a81824fe3\",\n    \"eventType\": \"asset.download\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\",\n    \"assetType\": \"image\",\n    \"assetName\": \"Product Insights\",\n    \"assetAudit\": \"ACCEPTED\",\n    \"fileName\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights\",\n    \"mediaItemId\": \"69293464-7721-4062-9E05EFAF23FE70E7\",\n    \"mediaItemType\": \"original\"\n  },\n  {\n    \"id\": \"62de6d714e29485a81824fe4\",\n    \"eventType\": \"asset.view\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:08:18.752+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\",\n    \"assetType\": \"image\",\n    \"assetName\": \"Product Insights\",\n    \"assetAudit\": \"ACCEPTED\",\n    \"fileName\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights\"\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-create.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V1","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/asset/create":{"get":{"summary":"Retrieve asset creation events","description":"Retrieve asset creation events within a specified date range.","tags":["Asset Usage V1"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000,"example":100}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA","example":"MTAwMA"}},{"name":"fromDateTime","in":"query","description":"Retrieve create events occurred after this date.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-01-01T01:00:00.000Z"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-06-01T01:00:00.000Z"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string","example":"MTAwMA"}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/api/v1/asset/create?limit=1000&cursor=MTAwMA"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"62de6d714e29485a81824fe3"},"eventType":{"type":"string","example":"asset.create"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781Z"},"assetId":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C0"},"assetType":{"type":"string","example":"image"},"assetName":{"type":"string","example":"Product Insights"},"assetAudit":{"type":"string","example":"ACCEPTED"},"fileName":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights"}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"id\": \"62de6d714e29485a81824fe3\",\n    \"eventType\": \"asset.create\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\",\n    \"assetType\": \"image\",\n    \"assetName\": \"Product Insights\",\n    \"assetAudit\": \"ACCEPTED\",\n    \"fileName\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights\"\n  },\n  {\n    \"id\": \"62de6d714e29485a81824fe4\",\n    \"eventType\": \"asset.create\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:08:18.752+00:00\",\n    \"assetId\": \"C58ED8C6-6B09-4CD6-B71C32C6715834F1\",\n    \"assetType\": \"image\",\n    \"assetName\": \"Reporting Schedule Nov 2022\",\n    \"assetAudit\": \"ACCEPTED\",\n    \"fileName\": \"C58ED8C6-6B09-4CD6-B71C32C6715834F1___Reporting Schedule Nov 2022\"\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-download.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V1","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/asset/download":{"get":{"summary":"Retrieve asset download events","tags":["Asset Usage V1"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA"}},{"name":"fromDateTime","in":"query","description":"Retrieve download events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string"}},"Next-Url":{"description":"The next url path to query if you want to continue with your paginated request.","schema":{"type":"string"}}},"content":{"application/json":{"examples":{"example-1":{"summary":"Example response","value":[{"id":"62de6d714e29485a81824fe3","eventType":"asset.download","userId":"1A84D758-2B3A-141F-8F07D71AA1F223BD","dateTime":"2021-11-15T10:07:57.781+00:00","assetId":"CA510292-E39E-4B28-AB6444CDD2B1C5C0","assetType":"image","assetName":"Product Insights","assetAudit":"ACCEPTED","fileName":"CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights","mediaItemId":"69293464-7721-4062-9E05EFAF23FE70E7","mediaItemType":"original"},{"id":"62de6d714e29485a81824fe4","eventType":"asset.download","userId":"1A84D758-2B3A-141F-8F07D71AA1F223BD","dateTime":"2021-11-15T10:08:18.752+00:00","assetId":"C58ED8C6-6B09-4CD6-B71C32C6715834F1","assetType":"image","assetName":"Reporting Schedule Nov 2022","assetAudit":"ACCEPTED","fileName":"C58ED8C6-6B09-4CD6-B71C32C6715834F1___Reporting Schedule Nov 2022","mediaItemId":"69293464-7721-4062-9E05EFAF23FE70E7","mediaItemType":"web"}]}}},"text/csv":{"examples":{"example-1":{"summary":"Example CSV response","value":"id,eventType,userId,dateTime,assetId,assetType,assetName,assetAudit,fileName,mediaItemId,mediaItemType\n62de6d714e29485a81824fe3,asset.download,1A84D758-2B3A-141F-8F07D71AA1F223BD,1655823377864,CA510292-E39E-4B28-AB6444CDD2B1C5C0,image,Product Insights,ACCEPTED,CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights,69293464-7721-4062-9E05EFAF23FE70E7,original\n62de6d714e29485a81824fe4,asset.download,1A84D758-2B3A-141F-8F07D71AA1F223BD,1655996103781,C58ED8C6-6B09-4CD6-B71C32C6715834F1,image,Reporting Schedule Nov 2022,ACCEPTED,C58ED8C6-6B09-4CD6-B71C32C6715834F1___Reporting Schedule Nov 2022,69293464-7721-4062-9E05EFAF23FE70E7,web\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-remove.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V1","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/asset/remove":{"get":{"summary":"Retrieve removed asset events","description":"Retrieve analytics events for removed assets.","tags":["Asset Usage V1"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000,"example":100}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA","example":"MTAwMA"}},{"name":"fromDateTime","in":"query","description":"Retrieve remove events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-01-01T01:00:00.000Z"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time","example":"2022-06-01T01:00:00.000Z"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string","example":"MTAwMA"}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/api/v1/asset/remove?limit=1000&cursor=MTAwMA"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"62de6d714e29485a81824fe3"},"eventType":{"type":"string","example":"asset.remove"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781Z"},"assetId":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C0"},"assetType":{"type":"string","example":"image"},"assetName":{"type":"string","example":"Product Insights"},"assetAudit":{"type":"string","example":"ACCEPTED"},"fileName":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights"}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"id\": \"62de6d714e29485a81824fe3\",\n    \"eventType\": \"asset.remove\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\",\n    \"assetType\": \"image\",\n    \"assetName\": \"Product Insights\",\n    \"assetAudit\": \"ACCEPTED\",\n    \"fileName\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights\"\n  },\n  {\n    \"id\": \"62de6d714e29485a81824fe4\",\n    \"eventType\": \"asset.remove\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:08:18.752+00:00\",\n    \"assetId\": \"C58ED8C6-6B09-4CD6-B71C32C6715834F1\",\n    \"assetType\": \"image\",\n    \"assetName\": \"Reporting Schedule Nov 2022\",\n    \"assetAudit\": \"ACCEPTED\",\n    \"fileName\": \"C58ED8C6-6B09-4CD6-B71C32C6715834F1___Reporting Schedule Nov 2022\"\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-v2-download.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V1","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/asset/v2/download":{"get":{"summary":"Retrieve asset download events","tags":["Asset Usage V1"],"description":"This endpoint only offers data from 2023-11-01. Use the Asset Download endpoint for previous data.","parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000,"example":100}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA","example":"MTAwMA"}},{"name":"fromDateTime","in":"query","description":"Retrieve download events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time","example":"2022-01-01T01:00"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time","example":"2022-06-01T01:00"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string","example":"MTAwMA"}},"Next-Url":{"description":"The next url path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/api/v1/asset/v2/download?limit=1000&cursor=MTAwMA"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","description":"Id of the event","example":"1408aec2-3114-43dd-be20-ffb1246a5231"},"eventType":{"type":"string","description":"Type of event","example":"AssetDownloadRequested"},"dateTime":{"type":"string","format":"date-time","description":"Date and time when the event occurred","example":"2021-11-15T10:07:57.781Z"},"userId":{"type":"string","description":"Id of the user that generated the event","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"assetId":{"type":"string","description":"Id of the asset","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C0"},"downloadReasons":{"type":"array","items":{"type":"string"},"description":"Reasons given on why the asset was downloaded","example":["reason1","reason2"]}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"eventId\": \"1408aec2-3114-43dd-be20-ffb1246a5231\",\n    \"eventType\": \"AssetDownloadRequested\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\",\n    \"downloadReasons\": [\n      \"reason1\",\n      \"reason2\"\n    ]\n  },\n  {\n    \"eventId\": \"5908aec2-3114-43dd-be20-ffb1246a5231\",\n    \"eventType\": \"AssetDownloadRequested\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"assetId\": \"C58ED8C6-6B09-4CD6-B71C32C6715834F\",\n    \"downloadReasons\": [\n      \"reason2\"\n    ]\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-asset-view.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V1","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/asset/view":{"get":{"summary":"Retrieve asset view events","tags":["Asset Usage V1"],"description":"This endpoint will be deprecated on July, 15th. Use the Asset Views V2 endpoint instead.","parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA"}},{"name":"fromDateTime","in":"query","description":"Retrieve view events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string"}},"Next-Url":{"description":"The next url path to query if you want to continue with your paginated request.","schema":{"type":"string"}}},"content":{"application/json":{"examples":{"example-1":{"summary":"Example response","value":[{"id":"62de6d714e29485a81824fe3","eventType":"asset.view","userId":"1A84D758-2B3A-141F-8F07D71AA1F223BD","dateTime":"2021-11-15T10:07:57.781+00:00","assetId":"CA510292-E39E-4B28-AB6444CDD2B1C5C0","assetType":"image","assetName":"Product Insights","assetAudit":"ACCEPTED","fileName":"CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights"},{"id":"62de6d714e29485a81824fe4","eventType":"asset.view","userId":"1A84D758-2B3A-141F-8F07D71AA1F223BD","dateTime":"2021-11-15T10:08:18.752+00:00","assetId":"C58ED8C6-6B09-4CD6-B71C32C6715834F1","assetType":"image","assetName":"Reporting Schedule Nov 2022","assetAudit":"ACCEPTED","fileName":"C58ED8C6-6B09-4CD6-B71C32C6715834F1___Reporting Schedule Nov 2022"}]}}},"text/csv":{"examples":{"example-1":{"summary":"Example CSV response","value":"id,eventType,userId,dateTime,assetId,assetType,assetName,assetAudit,fileName\n62de6d714e29485a81824fe3,asset.view,1A84D758-2B3A-141F-8F07D71AA1F223BD,1655823377864,CA510292-E39E-4B28-AB6444CDD2B1C5C0,image,Product Insights,ACCEPTED,CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights\n62de6d714e29485a81824fe4,asset.view,1A84D758-2B3A-141F-8F07D71AA1F223BD,1655996103781,C58ED8C6-6B09-4CD6-B71C32C6715834F1,image,Reporting Schedule Nov 2022,ACCEPTED,C58ED8C6-6B09-4CD6-B71C32C6715834F1___Reporting Schedule Nov 2022\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-collection-views-csv.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Collection Usage","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the collection or the user by making use of the [Collections API endpoints](#reference/collections) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/collection/views.csv":{"get":{"summary":"Retrieve collection view events in CSV format","tags":["Collection Usage"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA"}},{"name":"fromDateTime","in":"query","description":"Retrieve view events occurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string"}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string"}}},"content":{"text/csv":{"examples":{"example-1":{"summary":"Example CSV response","value":"eventId,collectionId,eventType,dateTime,userId,isOwner,viewOrigin,ipAddress,userAgent,isBynderSupport\n\"ad3c8d01-4a2f-461c-b17d-2ecc51723028\", \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\", CollectionViewed, 2021-11-15T10:07:57.781+00:00, 1A84D758-2B3A-141F-8F07D71AA1F223BD, false, internal, 192.158.1.38, \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36\", false\n\"ad3c8d01-4a2f-461c-b17d-2ecc51723028\", \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\", CollectionViewed, 2021-11-15T10:07:57.781+00:00,, false, embed, 192.158.1.38, \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36\", false\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-collection-views.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Collection Usage","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the collection or the user by making use of the [Collections API endpoints](#reference/collections) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/collection/views":{"get":{"summary":"Retrieve collection view events","tags":["Collection Usage"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA"}},{"name":"fromDateTime","in":"query","description":"Retrieve view events occurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string"}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"ad3c8d01-4a2f-461c-b17d-2ecc51723028"},"collectionId":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C0"},"eventType":{"type":"string","example":"CollectionViewed"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"isOwner":{"type":"boolean","example":false},"viewOrigin":{"type":"string","example":"internal"},"ipAddress":{"type":"string","example":"192.158.1.38"},"userAgent":{"type":"string","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36"},"isBynderSupport":{"type":"boolean","example":false}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"eventId\": \"ad3c8d01-4a2f-461c-b17d-2ecc51723028\",\n    \"collectionId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\",\n    \"eventType\": \"CollectionViewed\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"isOwner\": false,\n    \"viewOrigin\": \"internal\",\n    \"ipAddress\": \"192.158.1.38\",\n    \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36\",\n    \"isBynderSupport\": false\n  },\n  {\n    \"eventId\": \"ad3c8d01-4a2f-461c-b17d-2ecc51723028\",\n    \"collectionId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\",\n    \"eventType\": \"CollectionViewed\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"userId\": \"\",\n    \"isOwner\": false,\n    \"viewOrigin\": \"embed\",\n    \"ipAddress\": \"192.158.1.38\",\n    \"userAgent\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36\",\n    \"isBynderSupport\": false\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-historical-year-csv.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Historical Data","description":"This endpoint provides historical Analytics data beyond the 12 month retention period that applies to the Analytics API endpoints. **Note:** This data isn't available by default. Please, contact your CSM if you require access to it.\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/historical/{year}.csv":{"get":{"summary":"Retrieve historical data in CSV format","description":"This endpoint provides historical Analytics data beyond the 12 month retention period that applies to the Analytics API endpoints.","tags":["Historical Data"],"parameters":[{"name":"year","in":"path","description":"Year.","required":true,"schema":{"type":"string","example":"2022"}}],"responses":{"200":{"description":"Successful response","content":{"text/csv":{"examples":{"example-1":{"summary":"Example CSV response","value":"asset.view,2023-03-25T07:26:09.739Z,1A84D758-2B3A-141F-8F07D71AA1F223BD,CA510292-E39E-4B28-AB6444CDD2B1C5C0,Product Insights,image,ACCEPTED,CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights,\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\"\nuser.login,2023-03-22T12:26:23.862Z,1A84D758-2B3A-141F-8F07D71AA1F223BD,\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\"\nSearchExecuted,2023-02-23T11:03:30.971Z,1A84D758-2B3A-141F-8F07D71AA1F223BD,\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",[de],\"\",\"\",\"\",{168}\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-report-asset-assetid.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Reporting","description":"These endpoints provide reporting capabilities for assets of the DAM, making it easier to build your own customised reports.\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/report/asset/{assetId}":{"get":{"summary":"Retrieve specific asset report","description":"This endpoint allows you to retrieve a human readable report for a specific asset in the DAM. The report will include all the metadata of the asset.","tags":["Reporting"],"parameters":[{"name":"assetId","in":"path","description":"Asset id.","required":true,"schema":{"type":"string","example":"CD729A10-9101-47C7-9D14FA2E14CF28D9"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"assetId":{"type":"string","example":"CD729A10-9101-47C7-9D14FA2E14CF28D9"},"name":{"type":"string","example":"Asset 2"},"description":{"type":"string","example":"Asset 2 description"},"isArchived":{"type":"boolean","example":false},"type":{"type":"string","example":"image"},"audit":{"type":"string","example":"ACCEPTED"},"copyright":{"type":"string","example":""},"isLimited":{"type":"boolean","example":false},"datePublished":{"type":"string","format":"date-time","example":"2019-03-31T23:55:21.000+00:00"},"isRemoved":{"type":"boolean","example":false},"idHash":{"type":"string","example":"792e23855f02cdcb"},"phash":{"type":"string","example":"56033317620"},"userCreated":{"type":"string","example":"4BE80C1E-D8FF-4104-8CF774F06B1E60CE"},"dateCreated":{"type":"string","format":"date-time","example":"2019-03-31T23:59:40.000+00:00"},"userModified":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"dateModified":{"type":"string","format":"date-time","example":"2020-12-04T21:18:27.000+00:00"},"isWatermarked":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":false},"metaproperties":{"type":"object","additionalProperties":{"type":"string"},"example":{"metaproperty_1":"option3","metaproperty_2":"option2, option1","metaproperty_3":""}}}},"examples":{"example-1":{"summary":"Example response","value":"{\n  \"assetId\": \"CD729A10-9101-47C7-9D14FA2E14CF28D9\",\n  \"name\": \"Asset 2\",\n  \"description\": \"Asset 2 description\",\n  \"isArchived\": false,\n  \"type\": \"image\",\n  \"audit\": \"ACCEPTED\",\n  \"copyright\": \"\",\n  \"isLimited\": false,\n  \"datePublished\": \"2019-03-31T23:55:21.000+00:00\",\n  \"isRemoved\": false,\n  \"idHash\": \"792e23855f02cdcb\",\n  \"phash\": \"56033317620\",\n  \"userCreated\": \"4BE80C1E-D8FF-4104-8CF774F06B1E60CE\",\n  \"dateCreated\": \"2019-03-31T23:59:40.000+00:00\",\n  \"userModified\": \"00000000-0000-0000-0000000000000000\",\n  \"dateModified\": \"2020-12-04T21:18:27.000+00:00\",\n  \"isWatermarked\": false,\n  \"isPublic\": false,\n  \"metaproperties\": {\n    \"metaproperty_1\": \"option3\",\n    \"metaproperty_2\": \"option2, option1\",\n    \"metaproperty_3\": \"\"\n  }\n}\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-report-asset.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Reporting","description":"These endpoints provide reporting capabilities for assets of the DAM, making it easier to build your own customised reports.\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/report/asset":{"get":{"summary":"Retrieve asset reports","description":"This endpoint allows you to retrieve a human readable report of any of the assets in the DAM. The report will include all the metadata of the asset.","tags":["Reporting"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of asset reports to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA"}},{"name":"fromDateCreated","in":"query","description":"Retrieve reports of assets created after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateCreated","in":"query","description":"Set a date range together with the \"fromDateCreated\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"fromDateModified","in":"query","description":"Retrieve reports of assets modified after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateModified","in":"query","description":"Set a date range together with the \"fromDateModified\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string"}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"assetId":{"type":"string","example":"3DF53D46-4E72-47A0-A42ECC22CDE211D5"},"name":{"type":"string","example":"Asset 1"},"description":{"type":"string","example":"Asset Description"},"isArchived":{"type":"boolean","example":false},"type":{"type":"string","example":"image"},"audit":{"type":"string","example":"ACCEPTED"},"copyright":{"type":"string","example":""},"isLimited":{"type":"boolean","example":false},"datePublished":{"type":"string","format":"date-time","example":"2016-12-29T10:39:52.000+00:00"},"isRemoved":{"type":"boolean","example":true},"dateRemoved":{"type":"string","format":"date-time","example":"2019-01-04T13:19:47.000+00:00"},"idHash":{"type":"string","example":"6bb400d042cfe865"},"phash":{"type":"string","example":"56033317620"},"userCreated":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"dateCreated":{"type":"string","format":"date-time","example":"2018-12-21T13:11:46.000+00:00"},"userModified":{"type":"string","example":"00000000-0000-0000-0000000000000000"},"dateModified":{"type":"string","format":"date-time","example":"2019-01-04T13:19:47.000+00:00"},"isWatermarked":{"type":"boolean","example":false},"isPublic":{"type":"boolean","example":false},"metaproperties":{"type":"object","additionalProperties":{"type":"string"},"example":{"metaproperty_1":"option3","metaproperty_2":"option2, option1","metaproperty_3":""}}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"assetId\": \"3DF53D46-4E72-47A0-A42ECC22CDE211D5\",\n    \"name\": \"Asset 1\",\n    \"description\": \"Asset Description\",\n    \"isArchived\": false,\n    \"type\": \"image\",\n    \"audit\": \"ACCEPTED\",\n    \"copyright\": \"\",\n    \"isLimited\": false,\n    \"datePublished\": \"2016-12-29T10:39:52.000+00:00\",\n    \"isRemoved\": true,\n    \"dateRemoved\": \"2019-01-04T13:19:47.000+00:00\",\n    \"idHash\": \"6bb400d042cfe865\",\n    \"phash\": \"56033317620\",\n    \"userCreated\": \"00000000-0000-0000-0000000000000000\",\n    \"dateCreated\": \"2018-12-21T13:11:46.000+00:00\",\n    \"userModified\": \"00000000-0000-0000-0000000000000000\",\n    \"dateModified\": \"2019-01-04T13:19:47.000+00:00\",\n    \"isWatermarked\": false,\n    \"isPublic\": false\n  },\n  {\n    \"assetId\": \"CD729A10-9101-47C7-9D14FA2E14CF28D9\",\n    \"name\": \"Asset 2\",\n    \"description\": \"Asset 2 description\",\n    \"isArchived\": false,\n    \"type\": \"image\",\n    \"audit\": \"ACCEPTED\",\n    \"copyright\": \"\",\n    \"isLimited\": false,\n    \"datePublished\": \"2019-03-31T23:55:21.000+00:00\",\n    \"isRemoved\": false,\n    \"idHash\": \"792e23855f02cdcb\",\n    \"phash\": \"56033317620\",\n    \"userCreated\": \"4BE80C1E-D8FF-4104-8CF774F06B1E60CE\",\n    \"dateCreated\": \"2019-03-31T23:59:40.000+00:00\",\n    \"userModified\": \"00000000-0000-0000-0000000000000000\",\n    \"dateModified\": \"2020-12-04T21:18:27.000+00:00\",\n    \"isWatermarked\": false,\n    \"isPublic\": false,\n    \"metaproperties\": {\n      \"metaproperty_1\": \"option3\",\n      \"metaproperty_2\": \"option2, option1\",\n      \"metaproperty_3\": \"\"\n    }\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-search-executions.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Search Usage","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Assets API endpoints](#reference/assets) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/search/executions":{"get":{"summary":"Retrieve search execution events","tags":["Search Usage"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA"}},{"name":"fromDateTime","in":"query","description":"Retrieve executions events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string"}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"1408aec2-3114-43dd-be20-ffb1246a5231"},"eventType":{"type":"string","example":"SearchExecuted"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"terms":{"type":"array","items":{"type":"string"},"example":["digital"]},"filters":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","example":"language"},"value":{"type":"string","example":"english"}}}},"operator":{"type":"string","example":"OR"},"sortOrder":{"type":"object","properties":{"field":{"type":"string","example":"datePublished"},"order":{"type":"string","example":"desc"}}},"results":{"type":"object","properties":{"assets":{"type":"integer","example":48}}}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"eventId\": \"1408aec2-3114-43dd-be20-ffb1246a5231\",\n    \"eventType\": \"SearchExecuted\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"terms\": [\"digital\"],\n    \"filters\": [{\"field\": \"language\", \"value\": \"english\"}],\n    \"operator\": \"OR\",\n    \"sortOrder\": {\"field\": \"datePublished\", \"order\": \"desc\"},\n    \"results\": {\"assets\": 48}\n  },\n  {\n    \"eventId\": \"5908aec2-3114-43dd-be20-ffb1246a5231\",\n    \"eventType\": \"SearchExecuted\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"terms\": [\"template\"],\n    \"filters\": [{\"field\": \"language\", \"value\": \"spanish\"}],\n    \"operator\": \"OR\",\n    \"sortOrder\": {\"field\": \"datePublished\", \"order\": \"asc\"},\n    \"results\": {\"assets\": 23}\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-search-keyword-csv.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Search Usage","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Assets API endpoints](#reference/assets) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/search/keyword.csv":{"get":{"summary":"Retrieve search keyword events in CSV format","description":"Deprecated. Use the Search Executions endpoint instead.","tags":["Search Usage"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA"}},{"name":"fromDateTime","in":"query","description":"Retrieve keyword events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string"}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string"}}},"content":{"text/csv":{"examples":{"example-1":{"summary":"Example CSV response","value":"id,eventType,userId,dateTime,keyword,totalResults,tagsResults,assetsResults,documentsResults,guidelinesResults,collectionsResults,metapropertiesResults,collectionAssetsResults,workflowCampaignsResults,brandstoreProductsResults\n62de6d714e29485a81824fe3,search.keyword,\"1A84D758-2B3A-141F-8F07D71AA1F223BD\",1655823377864,\"digital templates\",27,0,24,0,0,3,0,0,0,0\n62de6d714e29485a81824fe4,search.keyword,\"1A84D758-2B3A-141F-8F07D71AA1F223BD\",1655996103781,digital,56,0,48,0,0,8,0,0,0,0,0\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-search-keyword.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Search Usage","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Assets API endpoints](#reference/assets) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/search/keyword":{"get":{"summary":"Retrieve search keyword events","description":"Deprecated. Use the Search Executions endpoint instead.","tags":["Search Usage"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA"}},{"name":"fromDateTime","in":"query","description":"Retrieve keyword events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string"}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"62de6d714e29485a81824fe3"},"eventType":{"type":"string","example":"search.keyword"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"},"keyword":{"type":"string","example":"digital templates"},"totalResults":{"type":"integer","example":27},"tagsResults":{"type":"integer","example":0},"assetsResults":{"type":"integer","example":24},"documentsResults":{"type":"integer","example":0},"guidelinesResults":{"type":"integer","example":0},"collectionsResults":{"type":"integer","example":3},"metapropertiesResults":{"type":"integer","example":0},"collectionAssetsResults":{"type":"integer","example":0},"workflowCampaignsResults":{"type":"integer","example":0},"brandstoreProductsResults":{"type":"integer","example":0}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"id\": \"62de6d714e29485a81824fe3\",\n    \"eventType\": \"search.keyword\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"keyword\": \"digital templates\",\n    \"totalResults\": 27,\n    \"tagsResults\": 0,\n    \"assetsResults\": 24,\n    \"documentsResults\": 0,\n    \"guidelinesResults\": 0,\n    \"collectionsResults\": 3,\n    \"metapropertiesResults\": 0,\n    \"collectionAssetsResults\": 0,\n    \"workflowCampaignsResults\": 0,\n    \"brandstoreProductsResults\": 0\n  },\n  {\n    \"id\": \"62de6d714e29485a81824fe4\",\n    \"eventType\": \"search.keyword\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"keyword\": \"assets\",\n    \"totalResults\": 56,\n    \"tagsResults\": 0,\n    \"assetsResults\": 48,\n    \"documentsResults\": 0,\n    \"guidelinesResults\": 0,\n    \"collectionsResults\": 8,\n    \"metapropertiesResults\": 0,\n    \"collectionAssetsResults\": 0,\n    \"workflowCampaignsResults\": 0,\n    \"brandstoreProductsResults\": 0\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-user-login.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"User Usage","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Assets API endpoints](#reference/assets) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/user/login":{"get":{"summary":"User Login","description":"Retrieve login events.","tags":["User Usage"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MA"}},{"name":"fromDateTime","in":"query","description":"Retrieve login events occurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string"}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string"}}},"content":{"application/json":{"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"id\": \"62de6d714e29485a81824fe3\",\n    \"eventType\": \"user.login\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\"\n  },\n  {\n    \"id\": \"62de6d714e29485a81824fe4\",\n    \"eventType\": \"user.login\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:08:18.752+00:00\"\n  }\n]\n"}}},"text/csv":{"examples":{"example-1":{"summary":"Example CSV response","value":"id,eventType,userId,dateTime\n62de6d714e29485a81824fe3,user.login,\"1A84D758-2B3A-141F-8F07D71AA1F223BD\",1655823377864\n62de6d714e29485a81824fe4,user.login,\"1A84D758-2B3A-141F-8F07D71AA1F223BD\",1655996103781\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v1-user-userid.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"User Usage","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Assets API endpoints](#reference/assets) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v1/user/{userId}":{"get":{"summary":"User Activity","description":"Retrieve all the events triggered by a given user.","tags":["User Usage"],"parameters":[{"name":"userId","in":"path","description":"User id.","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"string","default":"MDow"}},{"name":"fromDateTime","in":"query","description":"Retrieve events triggered by a user occurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds.\n","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"string"}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string"}}},"content":{"application/json":{"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"id\": \"62de6d714e29485a81824fe3\",\n    \"eventType\": \"asset.download\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\",\n    \"assetType\": \"image\",\n    \"assetName\": \"Product Insights\",\n    \"assetAudit\": \"ACCEPTED\",\n    \"fileName\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights\",\n    \"mediaItemId\": \"69293464-7721-4062-9E05EFAF23FE70E7\",\n    \"mediaItemType\": \"original\"\n  },\n  {\n    \"id\": \"62de6d714e29485a81824fe4\",\n    \"eventType\": \"asset.view\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:08:18.752+00:00\",\n    \"assetId\": \"C58ED8C6-6B09-4CD6-B71C32C6715834F1\",\n    \"assetType\": \"image\",\n    \"assetName\": \"Reporting Schedule Nov 2022\",\n    \"assetAudit\": \"ACCEPTED\",\n    \"fileName\": \"C58ED8C6-6B09-4CD6-B71C32C6715834F1___Reporting Schedule Nov 2022\"\n  }\n]\n"}}},"text/csv":{"examples":{"example-1":{"summary":"Example CSV response","value":"id,eventType,userId,dateTime,assetId,assetType,assetName,assetAudit,fileName,mediaItemId,mediaItemType\n62de6d714e29485a81824fe3,asset.download,\"1A84D758-2B3A-141F-8F07D71AA1F223BD\",1655823377864,\"CA510292-E39E-4B28-AB6444CDD2B1C5C0\",image,Product Insights,ACCEPTED,CA510292-E39E-4B28-AB6444CDD2B1C5C___Product Insights,69293464-7721-4062-9E05EFAF23FE70E7,original\n62de6d714e29485a81824fe4,asset.view,1A84D758-2B3A-141F-8F07D71AA1F223BD,1655996103781,C58ED8C6-6B09-4CD6-B71C32C6715834F1,image,Reporting Schedule Nov 2022,ACCEPTED,C58ED8C6-6B09-4CD6-B71C32C6715834F1___Reporting Schedule Nov 2022\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v2-asset-archives.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V2","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\nThis new version resolves pagination performance issues.\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v2/asset/archives":{"get":{"summary":"Retrieve asset archives","tags":["Asset Usage V2"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"integer","default":0}},{"name":"fromDateTime","in":"query","description":"Retrieve archive events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"integer","example":1000}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/v7/analytics/api/v2/asset/archives?limit=1000&cursor=1000"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"536280dd-b06e-44be-ae9f-85e2661510a1"},"eventType":{"type":"string","example":"AssetArchived"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"},"assetId":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C0"}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"eventId\": \"536280dd-b06e-44be-ae9f-85e2661510a1\",\n    \"eventType\": \"AssetArchived\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\"\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v2-asset-creations.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V2","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\nThis new version resolves pagination performance issues.\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v2/asset/creations":{"get":{"summary":"Retrieve asset creations","tags":["Asset Usage V2"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"integer","default":0}},{"name":"fromDateTime","in":"query","description":"Retrieve creation events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"integer","example":1000}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/v7/analytics/api/v2/asset/creations?limit=1000&cursor=1000"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"336280dd-b06e-44be-ae9f-85e2661510a1"},"eventType":{"type":"string","example":"AssetCreated"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"},"assetId":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C0"}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"eventId\": \"336280dd-b06e-44be-ae9f-85e2661510a1\",\n    \"eventType\": \"AssetCreated\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\"\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v2-asset-deletions.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V2","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\nThis new version resolves pagination performance issues.\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v2/asset/deletions":{"get":{"summary":"Retrieve asset deletions","tags":["Asset Usage V2"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"integer","default":0}},{"name":"fromDateTime","in":"query","description":"Retrieve deletion events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"integer","example":1000}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/v7/analytics/api/v2/asset/deletions?limit=1000&cursor=1000"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"636280dd-b06e-44be-ae9f-85e2661510a1"},"eventType":{"type":"string","example":"AssetDeleted"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"},"assetId":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C0"},"fileIds":{"type":"string","description":"Comma-separated list of file IDs.","example":"file-id-1,file-id-2"}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"eventId\": \"636280dd-b06e-44be-ae9f-85e2661510a1\",\n    \"eventType\": \"AssetDeleted\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\",\n    \"fileIds\": \"file-id-1,file-id-2\"\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v2-asset-downloads.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V2","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\nThis new version resolves pagination performance issues.\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v2/asset/downloads":{"get":{"summary":"Retrieve asset downloads","tags":["Asset Usage V2"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"integer","default":0}},{"name":"fromDateTime","in":"query","description":"Retrieve download events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"integer","example":1000}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/v7/analytics/api/v2/asset/downloads?limit=1000&cursor=1000"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"236280dd-b06e-44be-ae9f-85e2661510a1"},"eventType":{"type":"string","example":"AssetDownloaded"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"},"assetId":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C0"},"mediaItemIds":{"type":"array","items":{"type":"string"},"example":["media-item-1","media-item-2"]},"downloadReasons":{"type":"array","items":{"type":"string"},"example":["personal_use","marketing"]}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"eventId\": \"236280dd-b06e-44be-ae9f-85e2661510a1\",\n    \"eventType\": \"AssetDownloaded\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\",\n    \"mediaItemIds\": [\"media-item-1\", \"media-item-2\"],\n    \"downloadReasons\": [\"personal_use\", \"marketing\"]\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v2-asset-removes.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V2","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\nThis new version resolves pagination performance issues.\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v2/asset/removes":{"get":{"summary":"Retrieve asset removes","tags":["Asset Usage V2"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"integer","default":0}},{"name":"fromDateTime","in":"query","description":"Retrieve remove events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"integer","example":1000}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/v7/analytics/api/v2/asset/removes?limit=1000&cursor=1000"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"436280dd-b06e-44be-ae9f-85e2661510a1"},"eventType":{"type":"string","example":"AssetRemoved"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"},"assetId":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C0"}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"eventId\": \"436280dd-b06e-44be-ae9f-85e2661510a1\",\n    \"eventType\": \"AssetRemoved\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\"\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v2-asset-views.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Asset Usage V2","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Analytics Reporting tool](#reference/analytics/reporting) or the [Users API endpoints](#reference/users).\nThis new version resolves pagination performance issues.\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v2/asset/views":{"get":{"summary":"Retrieve asset views","tags":["Asset Usage V2"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"integer","default":0}},{"name":"fromDateTime","in":"query","description":"Retrieve view events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"integer","example":1000}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/api/v1/asset/view?limit=1000&cursor=1000"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"236280dd-b06e-44be-ae9f-85e2661510a1"},"eventType":{"type":"string","example":"AssetViewed"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"},"assetId":{"type":"string","example":"CA510292-E39E-4B28-AB6444CDD2B1C5C0"}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"eventId\": \"236280dd-b06e-44be-ae9f-85e2661510a1\",\n    \"eventType\": \"AssetViewed\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\"\n  },\n  {\n    \"eventId\": \"236280dd-b06e-44be-ae9f-85e2661510a2\",\n    \"eventType\": \"AssetViewed\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-16T07:13:46.781+00:00\",\n    \"assetId\": \"CA510292-E39E-4B28-AB6444CDD2B1C5C0\"\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v2-collection-views.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"Collection Usage","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the collection or the user by making use of the [Collections API endpoints](#reference/collections) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v2/collection/views":{"get":{"summary":"Retrieve collection views","tags":["Collection Usage"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"integer","default":0}},{"name":"fromDateTime","in":"query","description":"Retrieve view events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"integer","example":1000}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/v7/analytics/api/v2/collection/views?limit=1000&cursor=1000"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"936280dd-b06e-44be-ae9f-85e2661510a1"},"eventType":{"type":"string","example":"CollectionViewed"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"},"collectionId":{"type":"string","example":"DA621393-F40F-5C39-BC7555DEE3C2D6D1"},"isOwner":{"type":"boolean","example":true},"viewOrigin":{"type":"string","example":"portal"},"userAgent":{"type":"string","example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"},"isBynderSupport":{"type":"boolean","example":false}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"eventId\": \"936280dd-b06e-44be-ae9f-85e2661510a1\",\n    \"eventType\": \"CollectionViewed\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"collectionId\": \"DA621393-F40F-5C39-BC7555DEE3C2D6D1\",\n    \"isOwner\": true,\n    \"viewOrigin\": \"portal\",\n    \"userAgent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)\",\n    \"isBynderSupport\": false\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v2-user-creations.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"User Usage","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Assets API endpoints](#reference/assets) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v2/user/creations":{"get":{"summary":"Retrieve user creations","tags":["User Usage"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"integer","default":0}},{"name":"fromDateTime","in":"query","description":"Retrieve creation events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"integer","example":1000}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/v7/analytics/api/v2/user/creations?limit=1000&cursor=1000"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"836280dd-b06e-44be-ae9f-85e2661510a1"},"eventType":{"type":"string","example":"UserCreated"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"},"createdUserId":{"type":"string","example":"2B95E869-3C4B-252G-9G18E82BB2G334CE"},"eventCount":{"type":"integer","example":1},"source":{"type":"string","example":"portal"}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"eventId\": \"836280dd-b06e-44be-ae9f-85e2661510a1\",\n    \"eventType\": \"UserCreated\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\",\n    \"createdUserId\": \"2B95E869-3C4B-252G-9G18E82BB2G334CE\",\n    \"eventCount\": 1,\n    \"source\": \"portal\"\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-analytics-api-v2-user-logins.md","page_updatedAt":"2026-07-23T14:41:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0"},"tags":[{"name":"User Usage","description":"These endpoints return information related to the specific event. You can enrich these events with specific data about the asset or the user by making use of the [Assets API endpoints](#reference/assets) or the [Users API endpoints](#reference/users).\n"}],"servers":[{"url":"https://{your-bynder-domain}"}],"security":[{"permanentToken":["analytics.api:read"]},{"oauth2":["analytics.api:read"]}],"paths":{"/v7/analytics/api/v2/user/logins":{"get":{"summary":"Retrieve user logins","tags":["User Usage"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.","required":false,"schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","description":"Cursor mark returned in the response headers to be used for pagination purposes.","required":false,"schema":{"type":"integer","default":0}},{"name":"fromDateTime","in":"query","description":"Retrieve login events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDateTime","in":"query","description":"Set a date range together with the \"fromDateTime\" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful response","headers":{"Next-Cursor":{"description":"The next cursor value to send if you want to continue with your paginated request.","schema":{"type":"integer","example":1000}},"Next-Url":{"description":"The next URL path to query if you want to continue with your paginated request.","schema":{"type":"string","example":"/v7/analytics/api/v2/user/logins?limit=1000&cursor=1000"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"eventId":{"type":"string","example":"736280dd-b06e-44be-ae9f-85e2661510a1"},"eventType":{"type":"string","example":"UserLogin"},"userId":{"type":"string","example":"1A84D758-2B3A-141F-8F07D71AA1F223BD"},"dateTime":{"type":"string","format":"date-time","example":"2021-11-15T10:07:57.781+00:00"}}}},"examples":{"example-1":{"summary":"Example response","value":"[\n  {\n    \"eventId\": \"736280dd-b06e-44be-ae9f-85e2661510a1\",\n    \"eventType\": \"UserLogin\",\n    \"userId\": \"1A84D758-2B3A-141F-8F07D71AA1F223BD\",\n    \"dateTime\": \"2021-11-15T10:07:57.781+00:00\"\n  }\n]\n"}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-quarantine-v1-assets-asset-id.md","page_updatedAt":"2026-01-09T13:57:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Antivirus API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Quarantine","description":""}],"paths":{"/v7/quarantine/v1/assets/{asset_id}":{"get":{"summary":"Retrieve a quarantined asset by id","tags":["Quarantine"],"security":[{"OAuth2":["Audit quarantined assets"]},{"permanentToken":["Audit quarantined assets"]}],"parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"responses":{"200":{"description":"Quarantined asset details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"a69f3104-0107-48af-a522-b437cd700b34"},"accountId":{"type":"string","example":"9c06c1e3-f0cb-427a-88f0-a545c475047f"},"assetId":{"type":"string","example":"5c554910-11f4-49a3-b7bf-04c21c99af05"},"assetName":{"type":"string","example":"example-asset-name"},"requesterId":{"type":"string","example":"0b403671-8047-4fb9-9c59-ab4273973fb5"},"scanStatus":{"type":"string","enum":["PENDING","CLEARED","INFECTED","SKIPPED"],"example":"SKIPPED"},"dateAdded":{"type":"string","format":"date-time","example":"2024-06-28T10:42:02"},"dateModified":{"type":"string","format":"date-time","example":"2024-06-28T10:42:11"},"uploadEventType":{"type":"string","example":"LEGACY"},"fileType":{"type":"string","example":"None"},"fileSize":{"type":"integer","example":0},"scanFailureReason":{"type":"string","example":"client_error"},"reviewStatus":{"type":"string","enum":["APPROVED","REJECTED"],"example":null},"reviewedById":{"type":"string","example":null},"isRemoved":{"type":"boolean","example":false},"isSafe":{"type":"boolean","example":false}}}}}},"404":{"description":"Asset not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Asset not found"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"Audit quarantined assets":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"Audit quarantined assets":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/get_v7-quarantine-v1-assets.md","page_updatedAt":"2026-01-09T13:57:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Antivirus API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Quarantine","description":""}],"paths":{"/v7/quarantine/v1/assets":{"get":{"summary":"Retrieve a list of quarantined assets","tags":["Quarantine"],"security":[{"OAuth2":["Audit quarantined assets"]},{"permanentToken":["Audit quarantined assets"]}],"responses":{"200":{"description":"List of quarantined assets","content":{"application/json":{"schema":{"type":"object","properties":{"totalCount":{"type":"integer","example":1},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"a69f3104-0107-48af-a522-b437cd700b34"},"accountId":{"type":"string","example":"9c06c1e3-f0cb-427a-88f0-a545c475047f"},"assetId":{"type":"string","example":"5c554910-11f4-49a3-b7bf-04c21c99af05"},"assetName":{"type":"string","example":"example-asset-name"},"requesterId":{"type":"string","example":"0b403671-8047-4fb9-9c59-ab4273973fb5"},"scanStatus":{"type":"string","enum":["PENDING","CLEARED","INFECTED","SKIPPED"],"example":"SKIPPED"},"dateAdded":{"type":"string","format":"date-time","example":"2024-06-28T10:42:02"},"dateModified":{"type":"string","format":"date-time","example":"2024-06-28T10:42:11"},"uploadEventType":{"type":"string","example":"LEGACY"},"fileType":{"type":"string","example":"None"},"fileSize":{"type":"integer","example":0},"scanFailureReason":{"type":"string","example":"client_error"},"reviewStatus":{"type":"string","enum":["APPROVED","REJECTED"],"example":null},"reviewedById":{"type":"string","example":null},"isRemoved":{"type":"boolean","example":false},"isSafe":{"type":"boolean","example":false}}}}}}}}},"404":{"description":"Asset not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Asset not found"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"Audit quarantined assets":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"Audit quarantined assets":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/getactions.md","page_updatedAt":"2026-01-27T09:17:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automation Workflow API","version":"1.0.0","description":"\nThis API allows clients to manage automation-workflow rules.\n\n<b>Servers:</b>\n\n1. <b>Local Development:</b>\n   - Base URL: http://localhost:8080/{endpoint}\n\n2. <b>Stage or Production:</b>\n   - Base URL: https://automation-workflow-service.bynder.com/api/1/automation-workflow/{endpoint}\n\nEnsure you're using the correct server depending on the environment you're working in (local or production).\n  "},"servers":[{"url":"https://{your-bynder-domain}/api/1/automation-workflow/"}],"paths":{"/actions":{"get":{"tags":["Automation Workflow Actions"],"summary":"Fetches a list of available automation workflow actions.","description":"\nFetches a list of available automation workflow actions.\n\n<b>Note:</b> Only actions that the authenticated user has permission to use are included in the response.\nFor example, actions requiring specific features or roles may be omitted if the user lacks access.\n        ","operationId":"getActions","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationWorkflowActionsResponse"},"example":{"actions":[{"action_type":"AGENT_ENRICHMENT"},{"action_type":"ADD_TO_COLLECTION"},{"action_type":"AGENT_TRANSFORMATION"},{"action_type":"AGENT_BRAND_COMPLIANCE"},{"action_type":"AGENT_GOVERNANCE"}],"max_actions_limit":5}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}}}},"security":[{},{"httpAuth":[]}]}}},"components":{"schemas":{"AutomationWorkflowAction":{"title":"AutomationWorkflowAction","type":"object","required":["action_type"],"properties":{"action_type":{"type":"string"}}},"AutomationWorkflowActionsResponse":{"title":"AutomationWorkflowActionsResponse","type":"object","required":["max_actions_limit"],"properties":{"actions":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowAction"}},"max_actions_limit":{"type":"integer","format":"int32"}}},"ErrorAuthorizationResponse":{"title":"ErrorAuthorizationResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponse":{"title":"ErrorResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}},"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/getapi1assetassetsassetid.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AdvancedRights":{"properties":{"isDownloadable":{"type":"boolean"},"isPublic":{"type":"boolean"}},"title":"AdvancedRights","type":"object"},"Asset":{"properties":{"activeVersion":{"$ref":"#/components/schemas/VersionReference"},"advancedRights":{"$ref":"#/components/schemas/AdvancedRights"},"assetId":{"type":"string"},"assetStatus":{"type":"string"},"copyright":{"type":"string"},"description":{"type":"string"},"embargos":{"items":{"$ref":"#/components/schemas/AssetEmbargo"},"type":"array"},"moduleCode":{"$ref":"#/components/schemas/AssetModuleCode"},"name":{"type":"string"},"origin":{"type":"string"},"portalId":{"type":"string"},"timeStampCreated":{"format":"date-time","type":"string"},"timeStampModified":{"format":"date-time","type":"string"},"timeStampPublished":{"format":"date-time","type":"string"},"userCreatedId":{"type":"string"},"userModifiedId":{"type":"string"}},"title":"Asset","type":"object"},"AssetEmbargo":{"properties":{"embargoId":{"type":"string"},"embargoType":{"$ref":"#/components/schemas/AssetEmbargoType"},"timestampEnd":{"format":"date-time","type":"string"},"timestampStart":{"format":"date-time","type":"string"}},"title":"AssetEmbargo","type":"object"},"AssetEmbargoType":{"enum":["archive","limited","watermark"],"title":"AssetEmbargoType","type":"string"},"AssetModuleCode":{"enum":["BG","BS","IB","WF"],"title":"AssetModuleCode","type":"string"},"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"},"VersionReference":{"properties":{"timeStampCreated":{"format":"date-time","type":"string"},"versionId":{"type":"string"}},"title":"VersionReference","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}":{"get":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Retrieves the asset and all its details. This endpoint is currently only available for the creator of the asset to view the asset. \n\nDuring any point of the upload process, the asset can be retrieved to see the active status and the state of the asset.","operationId":"getApi1AssetAssetsAssetid","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Get asset","tags":["General endpoints"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Retrieve, validate, and manage existing assets and their versions.","name":"General endpoints"}]}}
{"source_url":"https://api.bynder.com/reference/getapi1assetassetsassetidmetaproperties.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"AssetTaxonomy":{"properties":{"assetId":{"type":"string"},"id":{"type":"string"},"metaPropertyOptionGroups":{"items":{"$ref":"#/components/schemas/MetaPropertyOptionGroup"},"type":"array"},"metaPropertyValues":{"items":{"$ref":"#/components/schemas/MetaPropertyValue"},"type":"array"},"metadata":{"items":{"$ref":"#/components/schemas/AssetTaxonomyMetaDataValue"},"type":"array"},"portalId":{"type":"string"},"taxonomyStatus":{"type":"string"},"timeStampModified":{"format":"date-time","type":"string"},"versionId":{"type":"string"}},"title":"AssetTaxonomy","type":"object"},"AssetTaxonomyMetaDataValue":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"AssetTaxonomyMetaDataValue","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"MetaPropertyOptionGroup":{"properties":{"isRemoved":{"type":"boolean"},"metaPropertyId":{"type":"string"},"metaPropertyType":{"$ref":"#/components/schemas/MetaPropertyType"},"values":{"items":{"$ref":"#/components/schemas/ValueReference"},"type":"array"}},"title":"MetaPropertyOptionGroup","type":"object"},"MetaPropertyType":{"enum":["option","tag","autotag"],"title":"MetaPropertyType","type":"string"},"MetaPropertyValue":{"properties":{"isRemoved":{"type":"boolean"},"metaPropertyId":{"type":"string"},"metaPropertyType":{"$ref":"#/components/schemas/MetaPropertyValueType"},"value":{"type":"string"}},"title":"MetaPropertyValue","type":"object"},"MetaPropertyValueType":{"enum":["text","date"],"title":"MetaPropertyValueType","type":"string"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"},"ValueReference":{"properties":{"id":{"type":"string"},"isRemoved":{"type":"boolean"}},"title":"ValueReference","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/metaproperties":{"get":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Retrieve all metaproperty values set on the active asset version. The responses are taxonomy references, not direct labels.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"getApi1AssetAssetsAssetidMetaproperties","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetTaxonomy"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Get asset metaproperties","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/getapi1assetassetsassetidrelations.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRelation":{"properties":{"relatedAssetIds":{"items":{"type":"string"},"type":"array"},"relationId":{"type":"string"}},"title":"AssetRelation","type":"object"},"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"GetAssetRelationsReply":{"properties":{"assetId":{"type":"string"},"portalId":{"type":"string"},"relations":{"items":{"$ref":"#/components/schemas/AssetRelation"},"type":"array"}},"title":"GetAssetRelationsReply","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/relations":{"get":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Retrieves all relations defined on an asset, the response will include all relations per relationId.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"getApi1AssetAssetsAssetidRelations","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAssetRelationsReply"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Get asset relations","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/getapi1assetassetsassetidthumbnails.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"GetVersionThumbnailsReply":{"properties":{"assetId":{"type":"string"},"thumbnails":{"items":{"$ref":"#/components/schemas/ThumbnailReply"},"type":"array"},"versionId":{"type":"string"}},"title":"GetVersionThumbnailsReply","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"ThumbnailReply":{"properties":{"name":{"type":"string"},"thumbnailUrl":{"type":"string"}},"title":"ThumbnailReply","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/thumbnails":{"get":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Retrieve the thumbnails of the active version of an asset. The response includes the signed url for directly using the thumbnails.","operationId":"getApi1AssetAssetsAssetidThumbnails","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetVersionThumbnailsReply"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Get the active asset version thumbnails","tags":["General endpoints"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Retrieve, validate, and manage existing assets and their versions.","name":"General endpoints"}]}}
{"source_url":"https://api.bynder.com/reference/getapi1assetassetsassetidvalidate.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"AssetValidationError":{"properties":{"code":{"type":"string"},"description":{"type":"string"}},"title":"AssetValidationError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"},"ValidateAssetReply":{"properties":{"assetId":{"type":"string"},"validationErrors":{"items":{"$ref":"#/components/schemas/AssetValidationError"},"type":"array"},"versionId":{"type":"string"}},"title":"ValidateAssetReply","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/validate":{"get":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Validate if the asset in its current state is good to be published.","operationId":"getApi1AssetAssetsAssetidValidate","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateAssetReply"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Validate asset","tags":["General endpoints"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Retrieve, validate, and manage existing assets and their versions.","name":"General endpoints"}]}}
{"source_url":"https://api.bynder.com/reference/getapi1assetassetsassetidversionsversionid.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"AssetVersion":{"properties":{"assetId":{"type":"string"},"assetVersionStatus":{"type":"string"},"derivatives":{"items":{"$ref":"#/components/schemas/AssetVersionDerivative"},"type":"array"},"fileObject":{"$ref":"#/components/schemas/FileObject"},"id":{"type":"string"},"portalId":{"type":"string"},"timeStampCreated":{"format":"date-time","type":"string"},"timeStampModified":{"format":"date-time","type":"string"},"userCreatedId":{"type":"string"},"userModifiedId":{"type":"string"}},"title":"AssetVersion","type":"object"},"AssetVersionDerivative":{"properties":{"derivativeReferenceId":{"type":"string"},"derivativeType":{"$ref":"#/components/schemas/DerivativeType"},"file":{"$ref":"#/components/schemas/DerivativeFileObject"},"id":{"type":"string"},"isPublic":{"type":"boolean"},"name":{"type":"string"}},"title":"AssetVersionDerivative","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DerivativeFileObject":{"properties":{"fileName":{"type":"string"},"fileSize":{"format":"int64","type":"integer"},"fileType":{"type":"string"},"id":{"type":"string"}},"title":"DerivativeFileObject","type":"object"},"DerivativeType":{"enum":["additional","intermediate","manual","thumbnail","web"],"title":"DerivativeType","type":"string"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"FileObject":{"properties":{"fileName":{"type":"string"},"fileSize":{"format":"int64","type":"integer"},"fileType":{"type":"string"},"id":{"type":"string"},"md5":{"type":"string"},"metadata":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"}},"title":"FileObject","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/versions/{versionId}":{"get":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Get all details about a given asset version. This does not have to be the active version of the asset. This endpoint is currently only available for the creator of the asset to view the asset.","operationId":"getApi1AssetAssetsAssetidVersionsVersionid","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"versionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetVersion"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Get version","tags":["General endpoints"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Retrieve, validate, and manage existing assets and their versions.","name":"General endpoints"}]}}
{"source_url":"https://api.bynder.com/reference/getapi1automationautomations.md","page_updatedAt":"2026-05-11T06:38:26.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automations API","version":"1.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"paths":{"/api/1/automation/automations":{"get":{"tags":["Automations - New taxonomy API"],"summary":"Retrieve automations","description":"Filter automations by metaproperty actions. Requires a `metaproperty_id`, optionally accepts one or more comma separated `option_ids`.","operationId":"getApi1AutomationAutomations","parameters":[{"name":"x-api-correlation-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of items to return","required":false,"schema":{"type":"integer","format":"int32","default":20,"minimum":1,"maximum":1000}},{"name":"start","in":"query","description":"Starting string for pagination","required":false,"schema":{"type":"string"}},{"name":"actionType","in":"query","description":"Filter automations by action type","required":false,"schema":{"type":"string","enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"]}},{"name":"conditionType","in":"query","description":"Filter automations by condition type","required":false,"schema":{"type":"string","enum":["ALL","ANY","ANY_OPTION"]}},{"name":"actionsOn","in":"query","description":"Filter automations by actions on metaproperty and optionIds. Format: `metapropertyId` or `metapropertyId`;`optionId`,`optionId`. Ensure to add `;` to separate the `metapropertyId` and the `optionId` when using this filter.","required":false,"schema":{"type":"string"}},{"name":"triggersOn","in":"query","description":"Filter automations by triggers on metaproperty and optionIds. Format: `metapropertyId` or `metapropertyId`;`optionId`,`optionId`. Ensure to add `;` to separate the `metapropertyId` and the `optionId` when using this filter.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"automations":{"type":"array","items":{"required":["automationId","actionType","conditionType","triggerType"],"type":"object","properties":{"automationId":{"type":"string"},"actionType":{"type":"string","enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"]},"conditionType":{"type":"string","enum":["ALL","ANY","ANY_OPTION"]},"triggerType":{"type":"string","enum":["SELECTED"]},"actionMetaproperties":{"type":"string"},"actionOptions":{"type":"string"}}}},"metadata":{"required":["nextPage"],"type":"object","properties":{"nextPage":{"type":"string"}}}}},"examples":{"AutomationsExample":{"summary":"An example of a paginated list of automations","value":{"automations":[{"actionMetaproperties":"Asset Sub-Type","actionOptions":"Marketing","actionType":"SHOW_OPTION","automationId":"00000000-0000-0000-0000-000000000000","conditionType":"ANY","triggerType":"SELECTED"}],"metadata":{"nextPage":"/api/1/automation/metaproperties/00000000-0000-0000-0000-000000000000/automations?limit=2&start=00000000-0000-0000-0000-000000000001"}}}}}}},"401":{"description":"","content":{"application/json":{"schema":{"required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}}}}},"404":{"description":"","content":{"application/json":{"schema":{"required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"MetapropertyNotFoundOutput":{"summary":"Response when metaproperty was not found","value":{"errorCode":"metaproperty-not-found","message":"The metaproperty was not found"}}}}}}},"security":[{"httpAuth":[]}]}}},"components":{"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/getapi1automationautomationsautomationid.md","page_updatedAt":"2026-05-11T06:38:26.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automations API","version":"1.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"paths":{"/api/1/automation/automations/{automationId}":{"get":{"tags":["Automations - New taxonomy API"],"summary":"Retrieve automation by id","description":"Retrieve a single automation by its unique id.","operationId":"getApi1AutomationAutomationsAutomationid","parameters":[{"name":"x-api-correlation-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"automationId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"required":["automationId","actionType","conditionType","triggerType"],"type":"object","properties":{"automationId":{"type":"string"},"actionType":{"type":"string","enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"]},"actionsOn":{"type":"array","items":{"type":"object","properties":{"metapropertyId":{"type":"string"},"metapropertyName":{"type":"string"},"metapropertyType":{"type":"string"},"options":{"type":"array","items":{"required":["optionId","optionName"],"type":"object","properties":{"optionId":{"type":"string"},"optionName":{"type":"string"}}}},"value":{"type":"string"}}}},"conditionType":{"type":"string","enum":["ALL","ANY","ANY_OPTION"]},"triggerType":{"type":"string","enum":["SELECTED"]},"triggersOn":{"type":"array","items":{"type":"object","properties":{"metapropertyId":{"type":"string"},"metapropertyName":{"type":"string"},"metapropertyType":{"type":"string"},"options":{"type":"array","items":{"required":["optionId","optionName"],"type":"object","properties":{"optionId":{"type":"string"},"optionName":{"type":"string"}}}},"value":{"type":"string"}}}}}},"examples":{"AutomationExample":{"summary":"An example of an automation response","description":"This automation describes the following: If the 'Image' option from 'Asset' metaproperty is selected, then show the 'Marketing' option from 'Asset Sub-Type' metaproperty.","value":{"actionType":"SHOW_OPTION","actionsOn":[{"metapropertyId":"7bed26c4-e39d-4051-8197-69bed161bda8","metapropertyName":"Asset Sub-Type","metapropertyType":"single-select","options":[{"optionId":"183e852d-a1b0-4f62-bfbd-2a093df03a6a","optionName":"Marketing"}],"value":""}],"automationId":"00000000-0000-0000-0000-000000000000","conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"ccea2875-868c-4a75-9354-53150d2db055","metapropertyName":"Asset","metapropertyType":"single-select","options":[{"optionId":"677c5b4d-1eb2-4e87-9bd8-5f2825522b3a","optionName":"Image"}],"value":""}]}}}}}},"401":{"description":"","content":{"application/json":{"schema":{"required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}}}}},"404":{"description":"","content":{"application/json":{"schema":{"required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"AutomationNotFoundOutput":{"summary":"Response when automation was not found","value":{"errorCode":"automation-not-found","message":"The automation was not found"}}}}}}},"security":[{"httpAuth":[]}]}}},"components":{"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/getapi1taxonomymetaproperties.md","page_updatedAt":"2026-05-11T07:21:24.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty","version":"1.0"},"openapi":"3.1.0","paths":{"/api/1/taxonomy/metaproperties":{"get":{"description":"Returns a paginated list of metaproperties.\n\nThe /api/1 endpoints are for management tasks. Your API token must include the write scope (`meta.assetbank:write`) to use these endpoints, also for read-only operations. These endpoints do not separate read access from write access.","operationId":"getApi1TaxonomyMetaproperties","parameters":[{"in":"query","name":"limit","required":false,"schema":{"default":20,"example":250,"format":"int32","maximum":1000,"type":"integer"}},{"in":"query","name":"page","required":false,"schema":{"default":1,"example":1,"format":"int32","type":"integer"}},{"in":"query","name":"ids","required":false,"schema":{"items":{"format":"uuid","type":"string"},"type":"array"}},{"in":"query","name":"metapropertyTypes","required":false,"schema":{"items":{"enum":["single-select","multi-select","date","text"],"title":"MetapropertyTypeEnum","type":"string"},"type":"array"}},{"in":"query","name":"autocomplete","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"PaginatedMetapropertiesResponse":{"summary":"Response containing a paginated list of metaproperties","value":{"metadata":{"nextPage":"","totalCount":1},"metaproperties":[{"allowDuplicates":false,"autocomplete":false,"createDuringApply":false,"id":"00000000-0000-0000-0000-000000000000","metapropertyType":"single-select","name":"Example Metaproperty"}]}}},"schema":{"properties":{"metadata":{"properties":{"nextPage":{"type":"string"},"totalCount":{"format":"int64","type":"integer"}},"required":["nextPage","totalCount"],"title":"PaginationMetadata","type":"object"},"metaproperties":{"items":{"properties":{"allowDuplicates":{"type":"boolean"},"autocomplete":{"type":"boolean"},"createDuringApply":{"type":"boolean"},"definition":{"type":"string"},"id":{"type":"string"},"metapropertyType":{"enum":["single-select","multi-select","date","text"],"title":"MetapropertyTypeEnum","type":"string"},"name":{"type":"string"}},"required":["id","name","metapropertyType","createDuringApply","autocomplete","allowDuplicates"],"title":"Metaproperty","type":"object"},"type":"array"}},"required":["metadata"],"title":"PaginatedMetapropertiesResponse","type":"object"}}},"description":""}},"summary":"Retrieve metaproperties","tags":["Metaproperties - New API (Preferred)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Metaproperties - New API (Preferred)"}]}}
{"source_url":"https://api.bynder.com/reference/getapi1taxonomymetapropertiesmetapropertyid.md","page_updatedAt":"2026-05-11T07:21:24.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty","version":"1.0"},"openapi":"3.1.0","paths":{"/api/1/taxonomy/metaproperties/{metapropertyId}":{"get":{"description":"Retrieve a single metaproperty by its id.\n\nThe /api/1 endpoints are for management tasks. Your API token must include the write scope (`meta.assetbank:write`) to use these endpoints, also for read-only operations. These endpoints do not separate read access from write access.","operationId":"getApi1TaxonomyMetapropertiesMetapropertyid","parameters":[{"in":"path","name":"metapropertyId","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"Metaproperty":{"summary":"Response containing the requested metaproperty","value":{"allowDuplicates":false,"autocomplete":false,"createDuringApply":false,"id":"00000000-0000-0000-0000-000000000000","metapropertyType":"single-select","name":"Example Metaproperty"}}},"schema":{"properties":{"allowDuplicates":{"type":"boolean"},"autocomplete":{"type":"boolean"},"createDuringApply":{"type":"boolean"},"definition":{"type":"string"},"id":{"type":"string"},"metapropertyType":{"enum":["single-select","multi-select","date","text"],"title":"MetapropertyTypeEnum","type":"string"},"name":{"type":"string"}},"required":["id","name","metapropertyType","createDuringApply","autocomplete","allowDuplicates"],"title":"Metaproperty","type":"object"}}},"description":""},"404":{"content":{"application/json":{"examples":{"MetapropertyNotExisting":{"summary":"Response when the metaproperty does not exist","value":{"errorCode":"metaproperty-not-existing","message":"Metaproperty does not exist"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"title":"MetapropertyNotExistingOutput","type":"object"}}},"description":""}},"summary":"Retrieve Metaproperty","tags":["Metaproperties - New API (Preferred)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Metaproperties - New API (Preferred)"}]}}
{"source_url":"https://api.bynder.com/reference/getapi1taxonomymetapropertiesmetapropertyidoptions.md","page_updatedAt":"2026-05-11T06:38:40.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty options","version":"1.0"},"openapi":"3.1.0","paths":{"/api/1/taxonomy/metaproperties/{metapropertyId}/options":{"get":{"description":"The /api/1 endpoints are for management tasks. Your API token must include the write scope (`meta.assetbank:write`) to use these endpoints, also for read-only operations. These endpoints do not separate read access from write access.","operationId":"getApi1TaxonomyMetapropertiesMetapropertyidOptions","parameters":[{"in":"path","name":"metapropertyId","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"query","name":"start","required":false,"schema":{"type":"string"}},{"in":"query","name":"before","required":false,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"default":20,"format":"int32","maximum":1000,"minimum":1,"type":"integer"}},{"in":"query","name":"externalReference","required":false,"schema":{"default":"","type":"string"}},{"in":"query","name":"ids","required":false,"schema":{"items":{"format":"uuid","type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"examples":{"ListOptionsOutput":{"summary":"Response when listing options","value":{"metadata":{},"options":[{"externalReference":"ext-ref-1","icon":"","id":"00000000-0000-0000-0000-000000000001","name":"Option 1"}]}}},"schema":{"properties":{"metadata":{"properties":{"nextPage":{"type":"string"},"prevPage":{"type":"string"}},"title":"MetadataOutput","type":"object"},"options":{"items":{"properties":{"definition":{"type":"string"},"externalReference":{"type":"string"},"icon":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name","externalReference","icon"],"title":"MetapropertyOption","type":"object"},"type":"array"}},"required":["metadata"],"title":"ListOptionsOutput","type":"object"}}},"description":""},"400":{"content":{"application/json":{"examples":{"OptionListCursorFormatInvalidOutput":{"summary":"Response when the cursor format for listing options is invalid. Expected 'name_optionId'.","value":{"errorCode":"option-list-cursor-format-invalid","message":"Invalid cursor format, expected 'name_optionId'"}},"OptionListCursorParameterInvalidOutput":{"summary":"Response when the cursor parameters for listing options are invalid. 'start' and 'before' cannot be used together.","value":{"errorCode":"option-list-cursor-parameter-invalid","message":"Invalid parameters provided for listing options with cursor pagination, 'start' and 'before' cannot be used together"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"title":"OptionListInvalidOutput","type":"object"}}},"description":""},"404":{"content":{"application/json":{"examples":{"MetapropertyNotExisting":{"summary":"Response when the metaproperty does not exist","value":{"errorCode":"metaproperty-not-existing","message":"Metaproperty does not exist"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"title":"MetapropertyNotExistingOutput","type":"object"}}},"description":""}},"summary":"Retrieve options for a metaproperty","tags":["Options - New API (Preferred)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Options - New API (Preferred)"}]}}
{"source_url":"https://api.bynder.com/reference/getassetpubliclinks.md","page_updatedAt":"2026-01-27T10:29:45.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.0.0","info":{"title":"Adaptive Video Streaming API","description":"API for retrieving public links to HLS and DASH manifests for video assets","version":"1.0.0"},"servers":[{"url":"https://api.example.com","description":"API server"}],"tags":[{"name":"Public links","description":""}],"paths":{"/api/1/assets/{asset_id}/public-links":{"get":{"summary":"Get public links for an asset","description":"This API returns public links to both HLS and DASH manifests for video assets, as well as the Video player HTML embed code to integrate Adaptive Video Streaming links with a supported video player. This endpoint uses the newer, standard UUID format of 8-4-4-4-12, and letters are lowercase. See the example for `asset_id`, and [Note on identifiers](https://api.bynder.com/docs/getting-started#note-on-identifiers) for more information.","tags":["Public links"],"operationId":"getAssetPublicLinks","parameters":[{"name":"asset_id","in":"path","description":"The UUID of the asset","required":true,"schema":{"type":"string","format":"uuid","example":"f4d5881d-9a2b-4e3d-a1f7-29f6771309f9"}}],"responses":{"200":{"description":"Successful response with public links","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicLinks"}}}},"404":{"description":"No adaptive streaming available for given asset","content":{"text/plain":{"schema":{"type":"string","example":"manifest file not found"}}}}}}}},"components":{"schemas":{"PublicLinks":{"type":"object","properties":{"hls":{"type":"string","format":"uri","description":"URL to the HLS manifest","example":"https://your.portal.url/vod-stream/00000000-0000-0000-0000-000000000000/play-hls2.m3u8"},"dash":{"type":"string","format":"uri","description":"URL to the DASH manifest","example":"https://your.portal.url/vod-stream/00000000-0000-0000-0000-000000000000/play-dash.mpd"},"embedCode":{"type":"string","description":"HTML embed code for integrating the video player","example":"<link rel=\"stylesheet\" type=\"text/css\" href=\"https://cdnjs.cloudflare.com/ajax/libs/shaka-player/4.7.11/controls.min.css\"/><div   bvd-manifest-url=\"https://deliver-testmanual.bynder-stage.com/vod-stream/450b9520-b186-48c6-8a51-faec286abc37/play-hls2.m3u8\" bvd-poster=\"https://deliver-testmanual.bynder-stage.com/asset/450b9520-b186-48c6-8a51-faec286abc37/thumbnail/webimage-poster\"></div><script src=\"https://deliver-testmanual.bynder-stage.com/v7/video-delivery/main.js\"></script>"}},"required":["hls","dash","embedCode"]}}}}}
{"source_url":"https://api.bynder.com/reference/getconditions.md","page_updatedAt":"2026-01-27T09:17:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automation Workflow API","version":"1.0.0","description":"\nThis API allows clients to manage automation-workflow rules.\n\n<b>Servers:</b>\n\n1. <b>Local Development:</b>\n   - Base URL: http://localhost:8080/{endpoint}\n\n2. <b>Stage or Production:</b>\n   - Base URL: https://automation-workflow-service.bynder.com/api/1/automation-workflow/{endpoint}\n\nEnsure you're using the correct server depending on the environment you're working in (local or production).\n  "},"servers":[{"url":"https://{your-bynder-domain}/api/1/automation-workflow/"}],"paths":{"/conditions":{"get":{"tags":["Automation Workflow Conditions"],"summary":"Fetches a list of available automation workflow conditions.","description":"\nFetches a list of available automation workflow conditions.\n\nSome conditions accept only specific predefined terms, which are included in the response for reference.\n\n<b>Note:</b> The `Archived` condition requires the `RelativeDate` trigger.\n        ","operationId":"getConditions","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationWorkflowConditionsResponse"},"example":{"conditions":[{"name":"AssetType","operators":["CONTAINS","DOES_NOT_CONTAIN"],"terms":[{"asset_type":"IMAGE"},{"asset_type":"VIDEO"},{"asset_type":"DOCUMENT"},{"asset_type":"AUDIO"},{"asset_type":"3D"}]},{"name":"MetapropertyOption","operators":["CONTAINS","DOES_NOT_CONTAIN","IS_EMPTY","HAS_VALUE","EQUALS"],"terms":[{"metaproperty_id":"00000000-0000-0000-0000-000000000000","metaproperty_option_id":"00000000-0000-0000-0000-000000000000"}]},{"name":"Archived","operators":["STARTS_IN"],"terms":[{"offset_amount":1,"offset_unit":"DAY"},{"offset_amount":2,"offset_unit":"WEEKS"},{"offset_amount":3,"offset_unit":"MONTHS"}]}],"max_conditions_count":5}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}}}},"security":[{},{"httpAuth":[]}]}}},"components":{"schemas":{"ArchiveTerm":{"title":"ArchiveTerm","type":"object","required":["offset_amount","offset_unit"],"properties":{"offset_amount":{"type":"integer","format":"int32"},"offset_unit":{"type":"string"}}},"AssetTypeTerm":{"title":"AssetTypeTerm","type":"object","required":["asset_type"],"properties":{"asset_type":{"type":"string"}}},"AutomationWorkflowCondition":{"title":"AutomationWorkflowCondition","type":"object","required":["name"],"properties":{"name":{"type":"string"},"operators":{"type":"array","items":{"type":"string"}},"terms":{"type":"array","items":{"$ref":"#/components/schemas/Term"}}}},"AutomationWorkflowConditionsResponse":{"title":"AutomationWorkflowConditionsResponse","type":"object","required":["max_conditions_count"],"properties":{"conditions":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowCondition"}},"max_conditions_count":{"type":"integer","format":"int32"}}},"ErrorAuthorizationResponse":{"title":"ErrorAuthorizationResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponse":{"title":"ErrorResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"MetapropertyOptionTerm":{"title":"MetapropertyOptionTerm","type":"object","required":["metaproperty_id"],"properties":{"metaproperty_id":{"type":"string","format":"uuid"},"metaproperty_option_id":{"type":"string","format":"uuid"}}},"Term":{"title":"Term","oneOf":[{"$ref":"#/components/schemas/ArchiveTerm"},{"$ref":"#/components/schemas/AssetTypeTerm"},{"$ref":"#/components/schemas/MetapropertyOptionTerm"}]}},"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/getdocument.md","page_updatedAt":"2026-05-29T16:09:23.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Text Authoring API","description":"Public API for retrieving text content within Bynder.","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://$ACCOUNT.bynder.com/api/1/authoring","description":"The $ACCOUNT should be your assigned subdomain or replace the whole URL if you have a custom domain.","variables":{}}],"paths":{"/documents/{document_uuid}":{"get":{"tags":["Document"],"summary":"Get document","description":"Use this endpoint to retrieve your text content in CXUC. The `$ACCOUNT` is your assigned subdomain, or just replace the URL if you have a custom domain.","operationId":"getDocument","parameters":[{"name":"document_uuid","in":"path","description":"The UUID of the document to be actioned.","required":true,"style":"simple","schema":{"type":"string","contentEncoding":"uuid"}},{"name":"Accept","in":"header","description":"The Accept header must be set to application/vnd.api+json","style":"simple","schema":{"allOf":[{"$ref":"#/components/schemas/Accept"},{"description":"The Accept header must be set to application/vnd.api+json"}]}},{"name":"Authorization","in":"header","description":"The authorization header that is using the JWT token and the Bearer scheme.","required":true,"style":"simple","schema":{"pattern":"Bearer .+","type":"string"}},{"name":"Referer","in":"header","description":"The referer header is required to derive the calling module for permissions functionality.","style":"simple","schema":{"type":"string","examples":["https://account.example.com/guidelines/page/d4822bae-91ac-4cec-b392-9c5c1877f718"]}}],"responses":{"200":{"description":"A DocumentContent response","headers":{},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/DocumentContentBody"}}}},"400":{"description":"Validation Error","headers":{},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorsObject"}}}},"403":{"description":"Permissions Error","headers":{},"content":{"application/vnd.api+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorsObject"},{"examples":[{"errors":[{"id":"req-adcaa568-7082-4cc8-9db9-9d78f1a3d95d","status":403,"code":"FORBIDDEN_ERROR","title":"ForbiddenError","detail":"Something went wrong"}]}]}],"contentMediaType":"application/vnd.api+json"},"examples":{"forbidden":{"summary":"Forbidden error","description":"Example of error properties when the error is a 403 forbidden response","value":{"errors":[{"id":"req-adcaa568-7082-4cc8-9db9-9d78f1a3d95d","status":403,"code":"FORBIDDEN_ERROR","title":"ForbiddenError","detail":"Something went wrong"}]}}}}}},"500":{"description":"Server Error","headers":{},"content":{"application/vnd.api+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorsObject"},{"examples":[{"errors":[{"id":"req-adcaa568-7082-4cc8-9db9-9d78f1a3d95d","status":500,"code":"UNKNOWN_ERROR","title":"UnknownError","detail":"Something went wrong"}]}]}],"contentMediaType":"application/vnd.api+json"},"examples":{"forbidden":{"summary":"Unknown Error","description":"Example of error properties when the error is a 500 error response","value":{"errors":[{"id":"req-adcaa568-7082-4cc8-9db9-9d78f1a3d95d","status":500,"code":"UNKNOWN_ERROR","title":"UnknownError","detail":"Something went wrong"}]}}}}}}},"deprecated":false,"security":[{"bearerAuth":[]}]},"parameters":[]}},"components":{"schemas":{"ErrorCode":{"title":"ErrorCode","enum":["VALIDATION_ERROR","SERIALIZATION_ERROR","UNKNOWN_ERROR","AUTHENTICATION_ERROR","MISSING_ERROR","FORBIDDEN_ERROR","STORAGE_API_ERROR"],"type":"string","description":"Machine readable error code","examples":["VALIDATION_ERROR"]},"ErrorObject":{"title":"ErrorObject","required":["status","code","title","detail"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this _instance_ of the error","examples":["req-adcaa568-7082-4cc8-9db9-9d78f1a3d95d"]},"status":{"type":"number","description":"The HTTP Status Code","examples":["400","500"]},"code":{"allOf":[{"$ref":"#/components/schemas/ErrorCode"},{"description":"Machine readable error code","examples":["VALIDATION_ERROR"]}]},"title":{"type":"string","description":"Human readable error title.","examples":["ValidationError"]},"detail":{"type":"string","description":"Human readable error details.","examples":["body/data/attributes must have required property 'html'"]},"meta":{"description":"An object of any arbitrary data. Record<string, unknown>"}}},"ErrorsObject":{"title":"ErrorsObject","required":["errors"],"type":"object","properties":{"errors":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ErrorObject"},"description":""}}},"DocumentContentBody":{"title":"DocumentContentBody","required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Resourcerepresentingthecontentinadocument1"}}},"Accept":{"title":"Accept","const":"application/vnd.api+json","type":"string"},"Attributes":{"title":"Attributes","type":"object","properties":{"document":{"type":"string","description":"ProseMirror JSON Object (https://prosemirror.net/docs/ref/#model.Document_Structure)","examples":[{"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Hello world."}]}]}]},"html":{"type":"string","description":"HTML string","examples":["<p>Hello world!</p>"]},"documentGroupId":{"type":"string","description":"The group id to which the document belongs. This is used to group documents together.","examples":["group_id_1"]}}},"Resourcerepresentingthecontentinadocument1":{"title":"Resourcerepresentingthecontentinadocument1","required":["id","type","attributes"],"type":"object","properties":{"id":{"type":"string","description":"UUID identifier","contentEncoding":"uuid"},"type":{"const":"document","type":"string","description":"Resource type"},"attributes":{"$ref":"#/components/schemas/Attributes"}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"jwt"}}},"security":[]}}
{"source_url":"https://api.bynder.com/reference/getgroup.md","page_updatedAt":"2026-07-15T15:50:57.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Groups","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Groups (Preferred)"}],"paths":{"/api/1/groups/{groupId}":{"get":{"operationId":"getGroup","summary":"Get group by ID","description":"Returns a single group by its ID, including member count.\n\nRequires the **GROUPMANAGEMENT** security role.\n","tags":["Groups (Preferred)"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"ID of the group (hyphens optional)."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"description":"Validation error (malformed group ID)."}},"security":[{"permanentToken":["GROUPMANAGEMENT"]},{"OAuth2":["GROUPMANAGEMENT"]}]}}},"components":{"responses":{"Unauthorized":{"description":"Missing or invalid authentication. The response body is empty."},"Forbidden":{"description":"The authenticated user does not have the **GROUPMANAGEMENT** security role."},"NotFound":{"description":"Group not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"schemas":{"Group":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":["string","null"]},"user_count":{"type":"integer","description":"Number of members in the group."}},"example":{"id":"0397e4bd-33fe-4b8f-a51d-4c2f1d9b6c1a","name":"Marketing","description":"Everyone in the marketing department","user_count":12}},"NotFoundResponse":{"type":"object","properties":{"detail":{"type":"string","example":"Not Found"}}}},"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups`"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/getgroupbyidapi.md","page_updatedAt":"2026-07-21T16:18:46.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"CXUC","version":"1.0.0","description":"Read-side APIs for Bynder Brand Guidelines (CX UC module).\nServes guide, group and page queries from CXUC.\n\n**Response variants**\n\nEndpoints that accept both user JWTs and Bynder API tokens return different shapes:\n- **User JWT** → classic response (canEdit/canView/shared fields, Cover objects)\n- **Bynder API token** → headless response wrapped in a `*WithMissingAssets` envelope;\n  HTTP 206 when one or more asset enrichment calls failed\n"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Groups","description":"Group endpoints"}],"paths":{"/api/1/cxuc/groups/{id}":{"get":{"summary":"Get group by ID","tags":["Groups"],"operationId":"getGroupByIdApi","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"orderBy","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderType","in":"query","required":false,"schema":{"type":"string"}},{"name":"skipEnrichmentCalls","in":"query","required":false,"description":"When present, skips asset enrichment calls","schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Group.\n- User JWT → classic `Group`\n- Bynder API token → `GroupWithMissingAssets` (headless)\n","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Group"},{"$ref":"#/components/schemas/GroupWithMissingAssets"}]}}}},"206":{"description":"Group with some missing asset enrichments (Bynder API token only)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupWithMissingAssets"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Group not found"}}}}},"components":{"schemas":{"GuideOverview":{"title":"GuideOverview","type":"object","properties":{"id":{"type":"string","format":"uuid"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"version":{"type":"integer"},"ownerId":{"type":"string"},"cover":{"$ref":"#/components/schemas/Cover"},"isFeatured":{"type":"boolean"},"type":{"$ref":"#/components/schemas/GuideType"},"groupId":{"type":"string","format":"uuid"},"canEdit":{"type":"boolean"},"canView":{"type":"boolean"},"shared":{"type":"boolean"},"targetedPagesEnabled":{"type":"boolean"}}},"Visibility":{"title":"Visibility","type":"string","enum":["PRIVATE","SPECIFIC","PORTAL","PUBLIC"]},"Cover":{"title":"Cover","type":"object","properties":{"assetId":{"type":"string"},"assetName":{"type":"string"},"imageUrl":{"type":"string"},"detailUrl":{"type":"string"}}},"GuideType":{"title":"GuideType","type":"string","enum":["MULTI_PAGE","SINGLE_PAGE","HOME_PAGE"]},"GuideOverviewHeadless":{"title":"GuideOverviewHeadless","type":"object","properties":{"id":{"type":"string","format":"uuid"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"version":{"type":"integer"},"ownerId":{"type":"string"},"cover":{"$ref":"#/components/schemas/AssetDto"},"isFeatured":{"type":"boolean"},"type":{"$ref":"#/components/schemas/GuideType"},"groupId":{"type":"string","format":"uuid"},"targetedPagesEnabled":{"type":"boolean"}}},"AssetDto":{"title":"AssetDto","description":"Bynder asset data. Fields are populated when enrichment is available; only id is guaranteed when enrichment was skipped or asset was missing.","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"brandId":{"type":"string"},"idHash":{"type":"string"},"orientation":{"type":"string"},"userCreated":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"datePublished":{"type":"string"},"copyright":{"type":"string"},"original":{"type":"string"},"transformBaseUrl":{"type":"string"},"extension":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"propertyOptions":{"type":"array","items":{"type":"string"}},"videoPreviewURLs":{"type":"array","items":{"type":"string"}},"isPublic":{"type":"boolean"},"archive":{"type":"boolean"},"watermarked":{"type":"boolean"},"limited":{"type":"boolean"},"fileSize":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"},"property_limitedrights":{"type":"string"},"thumbnails":{"type":"object","properties":{"mini":{"type":"string"},"thul":{"type":"string"},"webimage":{"type":"string"}}},"mediaItems":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"publicUrl":{"type":"string"},"type":{"type":"string"}}}}}},"Group":{"title":"Group","type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"description":{"type":"string"},"guideIds":{"type":"array","items":{"type":"string","format":"uuid"}},"guides":{"type":"array","items":{"$ref":"#/components/schemas/GuideOverview"}},"visibility":{"$ref":"#/components/schemas/Visibility"},"ownerId":{"type":"string"},"version":{"type":"integer"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"cover":{"title":"GroupCover","type":"object","properties":{"colorId":{"type":"string"},"assetId":{"type":"string"},"assetName":{"type":"string"},"imageUrl":{"type":"string"},"detailUrl":{"type":"string"}}},"canEdit":{"type":"boolean"},"canView":{"type":"boolean"},"shared":{"type":"boolean"}}},"GroupWithMissingAssets":{"title":"GroupWithMissingAssets","type":"object","properties":{"group":{"title":"GroupHeadless","type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"description":{"type":"string"},"guideIds":{"type":"array","items":{"type":"string","format":"uuid"}},"guides":{"type":"array","items":{"$ref":"#/components/schemas/GuideOverviewHeadless"}},"visibility":{"$ref":"#/components/schemas/Visibility"},"ownerId":{"type":"string"},"version":{"type":"integer"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"cover":{"$ref":"#/components/schemas/AssetDto"}}},"missingAssetIds":{"type":"array","items":{"type":"string"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/getgroupsapi.md","page_updatedAt":"2026-07-21T16:18:46.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"CXUC","version":"1.0.0","description":"Read-side APIs for Bynder Brand Guidelines (CX UC module).\nServes guide, group and page queries from CXUC.\n\n**Response variants**\n\nEndpoints that accept both user JWTs and Bynder API tokens return different shapes:\n- **User JWT** → classic response (canEdit/canView/shared fields, Cover objects)\n- **Bynder API token** → headless response wrapped in a `*WithMissingAssets` envelope;\n  HTTP 206 when one or more asset enrichment calls failed\n"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Groups","description":"Group endpoints"}],"paths":{"/api/1/cxuc/groups":{"get":{"summary":"Get all groups","tags":["Groups"],"operationId":"getGroupsApi","parameters":[{"name":"orderBy","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderType","in":"query","required":false,"schema":{"type":"string"}},{"name":"skipEnrichmentCalls","in":"query","required":false,"description":"When present, skips asset enrichment calls","schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of groups.\n- User JWT → classic `Group` array\n- Bynder API token → `GroupsWithMissingAssets` (headless)\n","content":{"application/json":{"schema":{"oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/Group"}},{"$ref":"#/components/schemas/GroupsWithMissingAssets"}]}}}},"206":{"description":"Groups with some missing asset enrichments (Bynder API token only)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupsWithMissingAssets"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}}},"components":{"schemas":{"GuideOverview":{"title":"GuideOverview","type":"object","properties":{"id":{"type":"string","format":"uuid"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"version":{"type":"integer"},"ownerId":{"type":"string"},"cover":{"$ref":"#/components/schemas/Cover"},"isFeatured":{"type":"boolean"},"type":{"$ref":"#/components/schemas/GuideType"},"groupId":{"type":"string","format":"uuid"},"canEdit":{"type":"boolean"},"canView":{"type":"boolean"},"shared":{"type":"boolean"},"targetedPagesEnabled":{"type":"boolean"}}},"Visibility":{"title":"Visibility","type":"string","enum":["PRIVATE","SPECIFIC","PORTAL","PUBLIC"]},"Cover":{"title":"Cover","type":"object","properties":{"assetId":{"type":"string"},"assetName":{"type":"string"},"imageUrl":{"type":"string"},"detailUrl":{"type":"string"}}},"GuideType":{"title":"GuideType","type":"string","enum":["MULTI_PAGE","SINGLE_PAGE","HOME_PAGE"]},"GuideOverviewHeadless":{"title":"GuideOverviewHeadless","type":"object","properties":{"id":{"type":"string","format":"uuid"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"version":{"type":"integer"},"ownerId":{"type":"string"},"cover":{"$ref":"#/components/schemas/AssetDto"},"isFeatured":{"type":"boolean"},"type":{"$ref":"#/components/schemas/GuideType"},"groupId":{"type":"string","format":"uuid"},"targetedPagesEnabled":{"type":"boolean"}}},"AssetDto":{"title":"AssetDto","description":"Bynder asset data. Fields are populated when enrichment is available; only id is guaranteed when enrichment was skipped or asset was missing.","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"brandId":{"type":"string"},"idHash":{"type":"string"},"orientation":{"type":"string"},"userCreated":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"datePublished":{"type":"string"},"copyright":{"type":"string"},"original":{"type":"string"},"transformBaseUrl":{"type":"string"},"extension":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"propertyOptions":{"type":"array","items":{"type":"string"}},"videoPreviewURLs":{"type":"array","items":{"type":"string"}},"isPublic":{"type":"boolean"},"archive":{"type":"boolean"},"watermarked":{"type":"boolean"},"limited":{"type":"boolean"},"fileSize":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"},"property_limitedrights":{"type":"string"},"thumbnails":{"type":"object","properties":{"mini":{"type":"string"},"thul":{"type":"string"},"webimage":{"type":"string"}}},"mediaItems":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"publicUrl":{"type":"string"},"type":{"type":"string"}}}}}},"Group":{"title":"Group","type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"description":{"type":"string"},"guideIds":{"type":"array","items":{"type":"string","format":"uuid"}},"guides":{"type":"array","items":{"$ref":"#/components/schemas/GuideOverview"}},"visibility":{"$ref":"#/components/schemas/Visibility"},"ownerId":{"type":"string"},"version":{"type":"integer"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"cover":{"title":"GroupCover","type":"object","properties":{"colorId":{"type":"string"},"assetId":{"type":"string"},"assetName":{"type":"string"},"imageUrl":{"type":"string"},"detailUrl":{"type":"string"}}},"canEdit":{"type":"boolean"},"canView":{"type":"boolean"},"shared":{"type":"boolean"}}},"GroupsWithMissingAssets":{"title":"GroupsWithMissingAssets","type":"object","properties":{"groups":{"type":"array","items":{"$ref":"#/components/schemas/GroupHeadless"}},"missingAssetIds":{"type":"array","items":{"type":"string"}}}},"GroupHeadless":{"title":"GroupHeadless","type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"description":{"type":"string"},"guideIds":{"type":"array","items":{"type":"string","format":"uuid"}},"guides":{"type":"array","items":{"$ref":"#/components/schemas/GuideOverviewHeadless"}},"visibility":{"$ref":"#/components/schemas/Visibility"},"ownerId":{"type":"string"},"version":{"type":"integer"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"cover":{"$ref":"#/components/schemas/AssetDto"}}}}}}}
{"source_url":"https://api.bynder.com/reference/getguidebyidapi.md","page_updatedAt":"2026-07-21T16:18:46.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"CXUC","version":"1.0.0","description":"Read-side APIs for Bynder Brand Guidelines (CX UC module).\nServes guide, group and page queries from CXUC.\n\n**Response variants**\n\nEndpoints that accept both user JWTs and Bynder API tokens return different shapes:\n- **User JWT** → classic response (canEdit/canView/shared fields, Cover objects)\n- **Bynder API token** → headless response wrapped in a `*WithMissingAssets` envelope;\n  HTTP 206 when one or more asset enrichment calls failed\n"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Guides","description":"Guide endpoints"}],"paths":{"/api/1/cxuc/guides/{id}":{"get":{"summary":"Get guide by ID","tags":["Guides"],"operationId":"getGuideByIdApi","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"skipEnrichmentCalls","in":"query","required":false,"description":"When present, skips asset enrichment calls","schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Guide.\n- User JWT / service token → classic `Guide`\n- Bynder API token → `GuideWithMissingAssets` (headless)\n","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Guide"},{"$ref":"#/components/schemas/GuideWithMissingAssets"}]}}}},"206":{"description":"Guide with some missing asset enrichments (Bynder API token only)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuideWithMissingAssets"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Guide not found"}}}}},"components":{"schemas":{"Visibility":{"title":"Visibility","type":"string","enum":["PRIVATE","SPECIFIC","PORTAL","PUBLIC"]},"GuideType":{"title":"GuideType","type":"string","enum":["MULTI_PAGE","SINGLE_PAGE","HOME_PAGE"]},"Guide":{"title":"Guide","type":"object","properties":{"id":{"type":"string","format":"uuid"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"title":{"type":"string"},"visibility":{"title":"Visibility","type":"string","enum":["PRIVATE","SPECIFIC","PORTAL","PUBLIC"]},"version":{"type":"integer"},"ownerId":{"type":"string"},"cover":{"title":"Cover","type":"object","properties":{"assetId":{"type":"string"},"assetName":{"type":"string"},"imageUrl":{"type":"string"},"detailUrl":{"type":"string"}}},"isFeatured":{"type":"boolean"},"type":{"title":"GuideType","type":"string","enum":["MULTI_PAGE","SINGLE_PAGE","HOME_PAGE"]},"groupId":{"type":"string","format":"uuid"},"canEdit":{"type":"boolean"},"canView":{"type":"boolean"},"shared":{"type":"boolean"},"targetedPagesEnabled":{"type":"boolean"},"chapters":{"type":"array","items":{"title":"Chapter","type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"pages":{"type":"array","items":{"title":"PageOverview","type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"state":{"$ref":"#/components/schemas/PageState"},"tableOfContents":{"$ref":"#/components/schemas/TableOfContents"},"header":{"$ref":"#/components/schemas/PageHeader"},"canEdit":{"type":"boolean"},"canView":{"type":"boolean"},"shared":{"type":"boolean"},"ownerId":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"}}}},"visibility":{"$ref":"#/components/schemas/Visibility"},"canEdit":{"type":"boolean"},"canView":{"type":"boolean"},"shared":{"type":"boolean"},"ownerId":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"}}}}}},"PageState":{"title":"PageState","type":"string","enum":["DRAFT","PUBLISHED"]},"TableOfContents":{"title":"TableOfContents","type":"object","properties":{"isVisibleInPage":{"type":"boolean"},"isVisibleInGuide":{"type":"boolean"}}},"PageHeader":{"title":"PageHeader","type":"object","properties":{"asset":{"title":"PageHeaderAsset","type":"object","properties":{"assetId":{"type":"string"},"assetName":{"type":"string"},"assetExtension":{"type":"string"},"imageUrl":{"type":"string"},"detailUrl":{"type":"string"}}},"backgroundColor":{"type":"string"},"height":{"type":"string"},"textColorId":{"type":"string"},"isTitleVisible":{"type":"boolean"},"isSubtitleVisible":{"type":"boolean"},"isVisible":{"type":"boolean"}}},"GuideWithMissingAssets":{"title":"GuideWithMissingAssets","type":"object","properties":{"guide":{"title":"GuideHeadless","type":"object","properties":{"id":{"type":"string","format":"uuid"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"version":{"type":"integer"},"ownerId":{"type":"string"},"cover":{"title":"AssetDto","description":"Bynder asset data. Fields are populated when enrichment is available; only id is guaranteed when enrichment was skipped or asset was missing.","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"brandId":{"type":"string"},"idHash":{"type":"string"},"orientation":{"type":"string"},"userCreated":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"datePublished":{"type":"string"},"copyright":{"type":"string"},"original":{"type":"string"},"transformBaseUrl":{"type":"string"},"extension":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"propertyOptions":{"type":"array","items":{"type":"string"}},"videoPreviewURLs":{"type":"array","items":{"type":"string"}},"isPublic":{"type":"boolean"},"archive":{"type":"boolean"},"watermarked":{"type":"boolean"},"limited":{"type":"boolean"},"fileSize":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"},"property_limitedrights":{"type":"string"},"thumbnails":{"type":"object","properties":{"mini":{"type":"string"},"thul":{"type":"string"},"webimage":{"type":"string"}}},"mediaItems":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"publicUrl":{"type":"string"},"type":{"type":"string"}}}}}},"isFeatured":{"type":"boolean"},"type":{"$ref":"#/components/schemas/GuideType"},"groupId":{"type":"string","format":"uuid"},"targetedPagesEnabled":{"type":"boolean"},"chapters":{"type":"array","items":{"title":"ChapterHeadless","type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"ownerId":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"pages":{"type":"array","items":{"title":"PageOverviewHeadless","type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"state":{"$ref":"#/components/schemas/PageState"},"ownerId":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"}}}}}}}}},"missingAssetIds":{"type":"array","items":{"type":"string"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/getguidepagebyidapi.md","page_updatedAt":"2026-07-21T16:18:46.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"CXUC","version":"1.0.0","description":"Read-side APIs for Bynder Brand Guidelines (CX UC module).\nServes guide, group and page queries from CXUC.\n\n**Response variants**\n\nEndpoints that accept both user JWTs and Bynder API tokens return different shapes:\n- **User JWT** → classic response (canEdit/canView/shared fields, Cover objects)\n- **Bynder API token** → headless response wrapped in a `*WithMissingAssets` envelope;\n  HTTP 206 when one or more asset enrichment calls failed\n"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Guides","description":"Guide endpoints"}],"paths":{"/api/1/cxuc/guides/{guideId}/pages/{pageId}":{"get":{"summary":"Get page of a guide by ID","tags":["Guides"],"operationId":"getGuidePageByIdApi","parameters":[{"name":"guideId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"pageId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"skipEnrichmentCalls","in":"query","required":false,"description":"When present, skips asset enrichment calls","schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Page.\n- User JWT → classic `Page`\n- Bynder API token → `PageWithMissingReferences` (headless)\n","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Page"},{"$ref":"#/components/schemas/PageWithMissingReferences"}]}}}},"206":{"description":"Page with some missing asset/collection enrichments (Bynder API token only)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageWithMissingReferences"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Guide or page not found"}}}}},"components":{"schemas":{"Visibility":{"title":"Visibility","type":"string","enum":["PRIVATE","SPECIFIC","PORTAL","PUBLIC"]},"AssetDto":{"title":"AssetDto","description":"Bynder asset data. Fields are populated when enrichment is available; only id is guaranteed when enrichment was skipped or asset was missing.","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"brandId":{"type":"string"},"idHash":{"type":"string"},"orientation":{"type":"string"},"userCreated":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"datePublished":{"type":"string"},"copyright":{"type":"string"},"original":{"type":"string"},"transformBaseUrl":{"type":"string"},"extension":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"propertyOptions":{"type":"array","items":{"type":"string"}},"videoPreviewURLs":{"type":"array","items":{"type":"string"}},"isPublic":{"type":"boolean"},"archive":{"type":"boolean"},"watermarked":{"type":"boolean"},"limited":{"type":"boolean"},"fileSize":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"},"property_limitedrights":{"type":"string"},"thumbnails":{"type":"object","properties":{"mini":{"type":"string"},"thul":{"type":"string"},"webimage":{"type":"string"}}},"mediaItems":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"publicUrl":{"type":"string"},"type":{"type":"string"}}}}}},"PageState":{"title":"PageState","type":"string","enum":["DRAFT","PUBLISHED"]},"Page":{"title":"Page","type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"sections":{"type":"array","items":{"title":"Section","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"columns":{"type":"array","items":{"title":"Column","type":"object","properties":{"_id":{"type":"string"},"widgets":{"type":"array","items":{"title":"Widget","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","enum":["audio","button","card","collection","color","figma","image","spacing","tea","video","storybook","vimeo","youtube","table","text","title"]}},"oneOf":[{"title":"AudioWidget","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"audio"},"assetId":{"type":"string"},"assetName":{"type":"string"},"audioUrl":{"type":"string"},"detailUrl":{"type":"string"},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}}},"required":["id","type","assetId","assetName","audioUrl","detailUrl"]},{"title":"ButtonWidget","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"button"},"title":{"type":"string"},"isLegacy":{"type":"boolean"},"name":{"type":"object","properties":{"text":{"type":"string"}}},"link":{"type":"object","properties":{"url":{"type":"string"},"openNewTab":{"type":"boolean"}}},"buttons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"object","properties":{"text":{"type":"string"}}},"link":{"type":"object","properties":{"url":{"type":"string"},"openNewTab":{"type":"boolean"}}},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}}}}},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}}},"required":["id","type"]},{"title":"CardWidget","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"card"},"cards":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"headline":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"link":{"type":"object","properties":{"url":{"type":"string"},"openNewTab":{"type":"boolean"}}},"asset":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"imageUrl":{"type":"string"},"detailUrl":{"type":"string"}}}}}},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"},"size":{"type":"integer"},"alignment":{"type":"string"}}}},"required":["id","type"]},{"title":"CollectionWidget","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"collection"},"collectionId":{"type":"string"},"collectionAssetCount":{"type":"integer"},"collectionAssetsShown":{"type":"integer"},"collectionName":{"type":"string"},"collectionPublicUrl":{"type":"string"},"collectionUrl":{"type":"string"},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}},"collectionSettings":{"type":"object","properties":{"layout":{"type":"string"},"showAssetTitle":{"type":"boolean"},"showAssetType":{"type":"boolean"},"showAssetDownload":{"type":"boolean"},"showCollectionDownload":{"type":"boolean"},"allowAssetRedirection":{"type":"boolean"},"allowCollectionRedirection":{"type":"boolean"},"assetsShown":{"type":"integer"},"showOpenAssetInAssetBank":{"type":"boolean"}}},"collectionPreviews":{"type":"array","items":{"type":"object","properties":{"assetDetailUrl":{"type":"string"},"assetExtension":{"type":"string"},"assetId":{"type":"string"},"assetImageUrl":{"type":"string"},"assetName":{"type":"string"}}}}},"required":["id","type"]},{"title":"ColorPaletteWidget","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"color"},"colors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"colorCodes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}},"defaultColorCodes":{"type":"object","properties":{"hex":{"type":"boolean"},"rgb":{"type":"boolean"},"cmyk":{"type":"boolean"}}},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}}},"required":["id","type"]},{"title":"ImageWidget","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"image"},"assetId":{"type":"string"},"assetName":{"type":"string"},"assetExtension":{"type":"string"},"imageUrl":{"type":"string"},"detailUrl":{"type":"string"},"imageAction":{"type":"object","properties":{"type":{"type":"string","enum":["LINK_TO_URL","OPEN_PREVIEW"]},"openNewTab":{"type":"boolean"},"url":{"type":"string"}}},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}}},"required":["id","type"]},{"title":"SpacingWidget","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"spacing"},"height":{"type":"number"},"divider":{"type":"string"},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}}},"required":["id","type"]},{"title":"TeaWidget","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"tea"},"document":{"type":"string"},"html":{"type":"string"}},"required":["id","type"]},{"title":"VideoWidget","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"video"},"assetId":{"type":"string"},"assetName":{"type":"string"},"videoUrl":{"type":"string"},"detailUrl":{"type":"string"},"coverUrl":{"type":"string"},"autoplay":{"type":"boolean"},"loop":{"type":"boolean"},"muted":{"type":"boolean"},"controls":{"type":"boolean"},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}}},"required":["id","type"]},{"title":"FigmaWidget","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"figma"},"sourceId":{"type":"string"},"settings":{"type":"object","properties":{"footer":{"type":"boolean"},"controls":{"type":"boolean"},"theme":{"type":"string"}}},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}}},"required":["id","type"]},{"title":"StorybookWidget","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"storybook"},"source":{"type":"object","properties":{"resourcePath":{"type":"string"},"sourceId":{"type":"string"},"fileType":{"type":"string"},"globals":{"type":"string"},"args":{"type":"string"}}},"settings":{"type":"object","properties":{"showToolbar":{"type":"boolean"},"showSidebar":{"type":"boolean"},"linkToSource":{"type":"boolean"}}},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}}},"required":["id","type"]},{"title":"VimeoWidget","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"vimeo"},"sourceId":{"type":"string"},"settings":{"type":"object","properties":{"loop":{"type":"boolean"},"autoplay":{"type":"boolean"},"detailsShown":{"type":"boolean"}}},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}}},"required":["id","type"]},{"title":"YoutubeWidget","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"youtube"},"sourceId":{"type":"string"},"settings":{"type":"object","properties":{"autoplay":{"type":"boolean"},"loop":{"type":"boolean"},"controls":{"type":"boolean"}}},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}}},"required":["id","type"]},{"title":"TableWidget","description":"Deprecated widget type.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"table"},"table":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"cells":{"type":"array","items":{"type":"object","properties":{"content":{"oneOf":[{"type":"string"},{"type":"object","description":"DraftJS rich content object","properties":{"blocks":{"type":"array"},"entityMap":{"type":"object"}}}]},"properties":{"type":"object","properties":{"numRows":{"type":"integer"},"numColumns":{"type":"integer"}}}}}}}}},"properties":{"type":"object","properties":{"numRows":{"type":"integer"},"numColumns":{"type":"integer"}}}}}},"required":["id","type"]},{"title":"TextWidget","description":"Deprecated widget type.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"text"},"text":{"oneOf":[{"type":"string"},{"type":"object","description":"DraftJS rich content object","properties":{"blocks":{"type":"array"},"entityMap":{"type":"object"}}}]}},"required":["id","type"]},{"title":"TitleWidget","description":"Deprecated widget type.","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"title"},"title":{"oneOf":[{"type":"string"},{"type":"object","description":"DraftJS rich content object","properties":{"blocks":{"type":"array"},"entityMap":{"type":"object"}}}]}},"required":["id","type"]}]}}}}},"sectionLayout":{"type":"string","enum":["SINGLE","DOUBLE_50_50","DOUBLE_66_33","DOUBLE_33_66","TRIPLE_33_33_33"]},"backgroundColorId":{"type":"string"},"sectionWidth":{"type":"integer"},"appearance":{"type":"object","properties":{"width":{"type":"integer"},"height":{"type":"integer"},"contentAlignment":{"type":"string"},"contentSpacing":{"type":"integer"},"columnSpacing":{"type":"integer"},"paddingTop":{"type":"integer"},"paddingBottom":{"type":"integer"},"paddingLeft":{"type":"integer"},"paddingRight":{"type":"integer"}}},"asset":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"imageUrl":{"type":"string"},"detailUrl":{"type":"string"}}},"style":{"type":"object","properties":{"stylesheet":{"type":"string"},"language":{"type":"string"},"version":{"type":"integer"}}}}}},"visibility":{"$ref":"#/components/schemas/Visibility"},"state":{"title":"PageState","type":"string","enum":["DRAFT","PUBLISHED"]},"tableOfContents":{"title":"TableOfContents","type":"object","properties":{"isVisibleInPage":{"type":"boolean"},"isVisibleInGuide":{"type":"boolean"}}},"header":{"title":"PageHeader","type":"object","properties":{"asset":{"title":"PageHeaderAsset","type":"object","properties":{"assetId":{"type":"string"},"assetName":{"type":"string"},"assetExtension":{"type":"string"},"imageUrl":{"type":"string"},"detailUrl":{"type":"string"}}},"backgroundColor":{"type":"string"},"height":{"type":"string"},"textColorId":{"type":"string"},"isTitleVisible":{"type":"boolean"},"isSubtitleVisible":{"type":"boolean"},"isVisible":{"type":"boolean"}}},"canEdit":{"type":"boolean"},"canView":{"type":"boolean"},"shared":{"type":"boolean"},"ownerId":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"}}},"PageWithMissingReferences":{"title":"PageWithMissingReferences","type":"object","properties":{"page":{"title":"PageHeadless","type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"state":{"$ref":"#/components/schemas/PageState"},"ownerId":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"page"},"header":{"title":"PageHeaderHeadless","type":"object","properties":{"asset":{"$ref":"#/components/schemas/AssetDto"}}},"sections":{"type":"array","items":{"title":"SectionHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"sectionLayout":{"type":"string","enum":["SINGLE","DOUBLE_50_50","DOUBLE_66_33","DOUBLE_33_66","TRIPLE_33_33_33"]},"asset":{"$ref":"#/components/schemas/AssetDto"},"columns":{"type":"array","items":{"title":"ColumnHeadless","type":"object","properties":{"id":{"type":"string"},"widgets":{"type":"array","items":{"title":"WidgetHeadless","description":"Widget in headless (Bynder API token) response. Deprecated text/title/table widgets and tea widgets all serialize as type 'text'.","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","enum":["audio","button","card","collection","color","figma","image","spacing","text","video","storybook","vimeo","youtube"]}},"oneOf":[{"title":"AudioWidgetHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"audio"},"asset":{"type":"object","description":"Bynder asset. All fields optional except id.","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"brandId":{"type":"string"},"idHash":{"type":"string"},"orientation":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"datePublished":{"type":"string"},"copyright":{"type":"string"},"original":{"type":"string"},"transformBaseUrl":{"type":"string"},"extension":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"isPublic":{"type":"boolean"},"archive":{"type":"boolean"},"watermarked":{"type":"boolean"},"fileSize":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"},"thumbnails":{"type":"object","properties":{"mini":{"type":"string"},"thul":{"type":"string"},"webimage":{"type":"string"}}},"mediaItems":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"publicUrl":{"type":"string"},"type":{"type":"string"}}}}},"required":["id"]}},"required":["id","type"]},{"title":"ButtonWidgetHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"button"},"isLegacy":{"type":"boolean"},"buttons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"object","properties":{"text":{"type":"string"}}},"link":{"type":"object","properties":{"url":{"type":"string"},"openNewTab":{"type":"boolean"}}}}}}},"required":["id","type"]},{"title":"CardWidgetHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"card"},"cards":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"headline":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}},"link":{"type":"object","properties":{"url":{"type":"string"},"openNewTab":{"type":"boolean"}}},"asset":{"type":"object","description":"Bynder asset. All fields optional except id.","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"brandId":{"type":"string"},"idHash":{"type":"string"},"orientation":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"datePublished":{"type":"string"},"copyright":{"type":"string"},"original":{"type":"string"},"transformBaseUrl":{"type":"string"},"extension":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"isPublic":{"type":"boolean"},"archive":{"type":"boolean"},"watermarked":{"type":"boolean"},"fileSize":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"},"thumbnails":{"type":"object","properties":{"mini":{"type":"string"},"thul":{"type":"string"},"webimage":{"type":"string"}}},"mediaItems":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"publicUrl":{"type":"string"},"type":{"type":"string"}}}}},"required":["id"]}}}}},"required":["id","type"]},{"title":"CollectionWidgetHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"collection"},"collection":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"filename":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"IsPublic":{"type":"boolean"},"collectionCount":{"type":"integer"},"userId":{"type":"string"},"cover":{"type":"object","properties":{"thumbnail":{"type":"string"},"thumbnails":{"type":"array","items":{"type":"string"}},"large":{"type":"string"}}},"user":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}},"required":["id","type"]},{"title":"ColorPaletteWidgetHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"color"},"colors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"colorCodes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}}},"required":["id","type"]},{"title":"ImageWidgetHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"image"},"asset":{"type":"object","description":"Bynder asset. All fields optional except id.","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"brandId":{"type":"string"},"idHash":{"type":"string"},"orientation":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"datePublished":{"type":"string"},"copyright":{"type":"string"},"original":{"type":"string"},"transformBaseUrl":{"type":"string"},"extension":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"isPublic":{"type":"boolean"},"archive":{"type":"boolean"},"watermarked":{"type":"boolean"},"fileSize":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"},"thumbnails":{"type":"object","properties":{"mini":{"type":"string"},"thul":{"type":"string"},"webimage":{"type":"string"}}},"mediaItems":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"publicUrl":{"type":"string"},"type":{"type":"string"}}}}},"required":["id"]}},"required":["id","type"]},{"title":"SpacingWidgetHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"spacing"}},"required":["id","type"]},{"title":"TextWidgetHeadless","description":"Deprecated. Covers text, title, table, and tea widget types in headless responses. All four serialize as type 'text' with rendered HTML content.","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"text"},"html":{"type":"string","description":"Rendered HTML content."}},"required":["id","type"]},{"title":"VideoWidgetHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"video"},"asset":{"type":"object","description":"Bynder asset. All fields optional except id.","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"brandId":{"type":"string"},"idHash":{"type":"string"},"orientation":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"datePublished":{"type":"string"},"copyright":{"type":"string"},"original":{"type":"string"},"transformBaseUrl":{"type":"string"},"extension":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"isPublic":{"type":"boolean"},"archive":{"type":"boolean"},"watermarked":{"type":"boolean"},"fileSize":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"},"thumbnails":{"type":"object","properties":{"mini":{"type":"string"},"thul":{"type":"string"},"webimage":{"type":"string"}}},"mediaItems":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"publicUrl":{"type":"string"},"type":{"type":"string"}}}}},"required":["id"]}},"required":["id","type"]},{"title":"FigmaWidgetHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"figma"},"sourceId":{"type":"string"}},"required":["id","type"]},{"title":"StorybookWidgetHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"storybook"},"source":{"type":"object","properties":{"resourcePath":{"type":"string"},"sourceId":{"type":"string"},"fileType":{"type":"string"},"globals":{"type":"string"},"args":{"type":"string"}}}},"required":["id","type"]},{"title":"VimeoWidgetHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"vimeo"},"sourceId":{"type":"string"}},"required":["id","type"]},{"title":"YoutubeWidgetHeadless","type":"object","properties":{"id":{"type":"string"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"type":{"type":"string","const":"youtube"},"sourceId":{"type":"string"}},"required":["id","type"]}]}}}}}}}}}},"missingAssetIds":{"type":"array","items":{"type":"string"}},"missingCollectionIds":{"type":"array","items":{"type":"string"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/getguidesapi.md","page_updatedAt":"2026-07-21T16:18:46.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"CXUC","version":"1.0.0","description":"Read-side APIs for Bynder Brand Guidelines (CX UC module).\nServes guide, group and page queries from CXUC.\n\n**Response variants**\n\nEndpoints that accept both user JWTs and Bynder API tokens return different shapes:\n- **User JWT** → classic response (canEdit/canView/shared fields, Cover objects)\n- **Bynder API token** → headless response wrapped in a `*WithMissingAssets` envelope;\n  HTTP 206 when one or more asset enrichment calls failed\n"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Guides","description":"Guide endpoints"}],"paths":{"/api/1/cxuc/guides":{"get":{"summary":"Get all guides","tags":["Guides"],"operationId":"getGuidesApi","parameters":[{"name":"orderBy","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderType","in":"query","required":false,"schema":{"type":"string"}},{"name":"searchTerm","in":"query","required":false,"schema":{"type":"string"}},{"name":"skipEnrichmentCalls","in":"query","required":false,"description":"When present, skips asset enrichment calls","schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of guides.\n- User JWT → classic `Guides` response\n- Bynder API token → `GuidesWithMissingAssets` (headless)\n","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Guides"},{"$ref":"#/components/schemas/GuidesWithMissingAssets"}]}}}},"206":{"description":"Guides with some missing asset enrichments (Bynder API token only)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuidesWithMissingAssets"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}}},"components":{"schemas":{"Guides":{"title":"Guides","type":"object","properties":{"featuredGuides":{"type":"array","items":{"$ref":"#/components/schemas/GuideOverview"}},"allGuides":{"type":"array","items":{"title":"GuideOverview","type":"object","properties":{"id":{"type":"string","format":"uuid"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"version":{"type":"integer"},"ownerId":{"type":"string"},"cover":{"$ref":"#/components/schemas/Cover"},"isFeatured":{"type":"boolean"},"type":{"$ref":"#/components/schemas/GuideType"},"groupId":{"type":"string","format":"uuid"},"canEdit":{"type":"boolean"},"canView":{"type":"boolean"},"shared":{"type":"boolean"},"targetedPagesEnabled":{"type":"boolean"}}}}}},"GuideOverview":{"title":"GuideOverview","type":"object","properties":{"id":{"type":"string","format":"uuid"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"version":{"type":"integer"},"ownerId":{"type":"string"},"cover":{"$ref":"#/components/schemas/Cover"},"isFeatured":{"type":"boolean"},"type":{"$ref":"#/components/schemas/GuideType"},"groupId":{"type":"string","format":"uuid"},"canEdit":{"type":"boolean"},"canView":{"type":"boolean"},"shared":{"type":"boolean"},"targetedPagesEnabled":{"type":"boolean"}}},"Visibility":{"title":"Visibility","type":"string","enum":["PRIVATE","SPECIFIC","PORTAL","PUBLIC"]},"Cover":{"title":"Cover","type":"object","properties":{"assetId":{"type":"string"},"assetName":{"type":"string"},"imageUrl":{"type":"string"},"detailUrl":{"type":"string"}}},"GuideType":{"title":"GuideType","type":"string","enum":["MULTI_PAGE","SINGLE_PAGE","HOME_PAGE"]},"GuidesWithMissingAssets":{"title":"GuidesWithMissingAssets","type":"object","properties":{"guides":{"title":"GuidesHeadless","type":"object","properties":{"featuredGuides":{"type":"array","items":{"$ref":"#/components/schemas/GuideOverviewHeadless"}},"allGuides":{"type":"array","items":{"title":"GuideOverviewHeadless","type":"object","properties":{"id":{"type":"string","format":"uuid"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"version":{"type":"integer"},"ownerId":{"type":"string"},"cover":{"$ref":"#/components/schemas/AssetDto"},"isFeatured":{"type":"boolean"},"type":{"$ref":"#/components/schemas/GuideType"},"groupId":{"type":"string","format":"uuid"},"targetedPagesEnabled":{"type":"boolean"}}}}}},"missingAssetIds":{"type":"array","items":{"type":"string"}}}},"GuideOverviewHeadless":{"title":"GuideOverviewHeadless","type":"object","properties":{"id":{"type":"string","format":"uuid"},"creationTime":{"type":"string"},"lastModifiedTime":{"type":"string"},"title":{"type":"string"},"visibility":{"$ref":"#/components/schemas/Visibility"},"version":{"type":"integer"},"ownerId":{"type":"string"},"cover":{"$ref":"#/components/schemas/AssetDto"},"isFeatured":{"type":"boolean"},"type":{"$ref":"#/components/schemas/GuideType"},"groupId":{"type":"string","format":"uuid"},"targetedPagesEnabled":{"type":"boolean"}}},"AssetDto":{"title":"AssetDto","description":"Bynder asset data. Fields are populated when enrichment is available; only id is guaranteed when enrichment was skipped or asset was missing.","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"brandId":{"type":"string"},"idHash":{"type":"string"},"orientation":{"type":"string"},"userCreated":{"type":"string"},"dateCreated":{"type":"string"},"dateModified":{"type":"string"},"datePublished":{"type":"string"},"copyright":{"type":"string"},"original":{"type":"string"},"transformBaseUrl":{"type":"string"},"extension":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"propertyOptions":{"type":"array","items":{"type":"string"}},"videoPreviewURLs":{"type":"array","items":{"type":"string"}},"isPublic":{"type":"boolean"},"archive":{"type":"boolean"},"watermarked":{"type":"boolean"},"limited":{"type":"boolean"},"fileSize":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"},"property_limitedrights":{"type":"string"},"thumbnails":{"type":"object","properties":{"mini":{"type":"string"},"thul":{"type":"string"},"webimage":{"type":"string"}}},"mediaItems":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"publicUrl":{"type":"string"},"type":{"type":"string"}}}}}}}}}}
{"source_url":"https://api.bynder.com/reference/getrules.md","page_updatedAt":"2026-01-27T09:17:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automation Workflow API","version":"1.0.0","description":"\nThis API allows clients to manage automation-workflow rules.\n\n<b>Servers:</b>\n\n1. <b>Local Development:</b>\n   - Base URL: http://localhost:8080/{endpoint}\n\n2. <b>Stage or Production:</b>\n   - Base URL: https://automation-workflow-service.bynder.com/api/1/automation-workflow/{endpoint}\n\nEnsure you're using the correct server depending on the environment you're working in (local or production).\n  "},"servers":[{"url":"https://{your-bynder-domain}/api/1/automation-workflow/"}],"paths":{"/rules":{"get":{"tags":["Automation Workflow Rules"],"summary":"Fetches all automation workflow rules.","description":"Fetches all automation workflow rules within an account in descending order of creation, with optional pagination (start and limit).","operationId":"getRules","parameters":[{"name":"start","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAutomationWorkflowRulesResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}}}},"security":[{},{"httpAuth":[]}]}}},"components":{"schemas":{"AndCondition":{"title":"AndCondition","type":"object","properties":{"and":{"type":"array","items":{"$ref":"#/components/schemas/LeafCondition"}}}},"ArchiveTerm":{"title":"ArchiveTerm","type":"object","required":["offset_amount","offset_unit"],"properties":{"offset_amount":{"type":"integer","format":"int32"},"offset_unit":{"type":"string"}}},"AssetTypeTerm":{"title":"AssetTypeTerm","type":"object","required":["asset_type"],"properties":{"asset_type":{"type":"string"}}},"AutomationWorkflowResponse":{"title":"AutomationWorkflowResponse","type":"object","required":["id","status","name","created_by_id","date_created","is_valid"],"properties":{"id":{"type":"string"},"status":{"type":"string"},"name":{"type":"string"},"created_by_id":{"type":"string"},"date_created":{"type":"string"},"triggers":{"type":"array","items":{"type":"string"}},"steps":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowStep"}},"is_valid":{"type":"boolean"}}},"AutomationWorkflowStep":{"title":"AutomationWorkflowStep","type":"object","properties":{"step_triggers":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowStepActionBase"}},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/AndCondition"}}}},"AutomationWorkflowStepActionAgent":{"title":"AutomationWorkflowStepActionAgent","type":"object","required":["action_type","data"],"properties":{"action_type":{"type":"string"},"data":{"$ref":"#/components/schemas/StepActionAgentData"},"is_valid":{"type":"boolean"}}},"AutomationWorkflowStepActionBase":{"title":"AutomationWorkflowStepActionBase","oneOf":[{"$ref":"#/components/schemas/AutomationWorkflowStepActionAgent"},{"$ref":"#/components/schemas/AutomationWorkflowStepAddToCollectionAction"}]},"AutomationWorkflowStepAddToCollectionAction":{"title":"AutomationWorkflowStepAddToCollectionAction","type":"object","required":["action_type","data"],"properties":{"action_type":{"type":"string"},"data":{"$ref":"#/components/schemas/StepAddToCollectionActionData"},"is_valid":{"type":"boolean"}}},"ErrorAuthorizationResponse":{"title":"ErrorAuthorizationResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponse":{"title":"ErrorResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ExpressionCondition":{"title":"ExpressionCondition","type":"object","required":["operator"],"properties":{"term":{"type":"array","items":{"$ref":"#/components/schemas/Term"}},"operator":{"type":"string"}}},"LeafCondition":{"title":"LeafCondition","type":"object","required":["condition_type","expression"],"properties":{"condition_type":{"type":"string"},"expression":{"$ref":"#/components/schemas/ExpressionCondition"},"is_valid":{"type":"boolean"}}},"ListAutomationWorkflowRulesResponse":{"title":"ListAutomationWorkflowRulesResponse","type":"object","required":["metadata"],"properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowResponse"}},"metadata":{"$ref":"#/components/schemas/MetadataOutput"}}},"MetadataOutput":{"title":"MetadataOutput","type":"object","properties":{"previous_page":{"type":"string"},"next_page":{"type":"string"}}},"MetapropertyOptionTerm":{"title":"MetapropertyOptionTerm","type":"object","required":["metaproperty_id"],"properties":{"metaproperty_id":{"type":"string","format":"uuid"},"metaproperty_option_id":{"type":"string","format":"uuid"}}},"StepActionAgentData":{"title":"StepActionAgentData","type":"object","required":["agent_id"],"properties":{"agent_id":{"type":"string"},"run_name":{"type":"string"}}},"StepAddToCollectionActionData":{"title":"StepAddToCollectionActionData","type":"object","required":["collection_id"],"properties":{"collection_id":{"type":"string"}}},"Term":{"title":"Term","oneOf":[{"$ref":"#/components/schemas/ArchiveTerm"},{"$ref":"#/components/schemas/AssetTypeTerm"},{"$ref":"#/components/schemas/MetapropertyOptionTerm"}]}},"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/getrulesruleid.md","page_updatedAt":"2026-01-27T09:17:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automation Workflow API","version":"1.0.0","description":"\nThis API allows clients to manage automation-workflow rules.\n\n<b>Servers:</b>\n\n1. <b>Local Development:</b>\n   - Base URL: http://localhost:8080/{endpoint}\n\n2. <b>Stage or Production:</b>\n   - Base URL: https://automation-workflow-service.bynder.com/api/1/automation-workflow/{endpoint}\n\nEnsure you're using the correct server depending on the environment you're working in (local or production).\n  "},"servers":[{"url":"https://{your-bynder-domain}/api/1/automation-workflow/"}],"paths":{"/rules/{ruleId}":{"get":{"tags":["Automation Workflow Rules"],"summary":"Fetches a specific automation workflow rule.","description":"Fetches a specific automation workflow rule.","operationId":"getRulesRuleid","parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleRuleAutomationWorkflowResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseNotFound"}}}}},"security":[{},{"httpAuth":[]}]}}},"components":{"schemas":{"AndCondition":{"title":"AndCondition","type":"object","properties":{"and":{"type":"array","items":{"$ref":"#/components/schemas/LeafCondition"}}}},"ArchiveTerm":{"title":"ArchiveTerm","type":"object","required":["offset_amount","offset_unit"],"properties":{"offset_amount":{"type":"integer","format":"int32"},"offset_unit":{"type":"string"}}},"AssetTypeTerm":{"title":"AssetTypeTerm","type":"object","required":["asset_type"],"properties":{"asset_type":{"type":"string"}}},"AutomationWorkflowStep":{"title":"AutomationWorkflowStep","type":"object","properties":{"step_triggers":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowStepActionBase"}},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/AndCondition"}}}},"AutomationWorkflowStepActionAgent":{"title":"AutomationWorkflowStepActionAgent","type":"object","required":["action_type","data"],"properties":{"action_type":{"type":"string"},"data":{"$ref":"#/components/schemas/StepActionAgentData"},"is_valid":{"type":"boolean"}}},"AutomationWorkflowStepActionBase":{"title":"AutomationWorkflowStepActionBase","oneOf":[{"$ref":"#/components/schemas/AutomationWorkflowStepActionAgent"},{"$ref":"#/components/schemas/AutomationWorkflowStepAddToCollectionAction"}]},"AutomationWorkflowStepAddToCollectionAction":{"title":"AutomationWorkflowStepAddToCollectionAction","type":"object","required":["action_type","data"],"properties":{"action_type":{"type":"string"},"data":{"$ref":"#/components/schemas/StepAddToCollectionActionData"},"is_valid":{"type":"boolean"}}},"ErrorAuthorizationResponse":{"title":"ErrorAuthorizationResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponse":{"title":"ErrorResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponseNotFound":{"title":"ErrorResponseNotFound","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ExpressionCondition":{"title":"ExpressionCondition","type":"object","required":["operator"],"properties":{"term":{"type":"array","items":{"$ref":"#/components/schemas/Term"}},"operator":{"type":"string"}}},"LeafCondition":{"title":"LeafCondition","type":"object","required":["condition_type","expression"],"properties":{"condition_type":{"type":"string"},"expression":{"$ref":"#/components/schemas/ExpressionCondition"},"is_valid":{"type":"boolean"}}},"MetapropertyOptionTerm":{"title":"MetapropertyOptionTerm","type":"object","required":["metaproperty_id"],"properties":{"metaproperty_id":{"type":"string","format":"uuid"},"metaproperty_option_id":{"type":"string","format":"uuid"}}},"SingleRuleAutomationWorkflowResponse":{"title":"SingleRuleAutomationWorkflowResponse","type":"object","required":["id","status","name","date_created","created_by_id","date_modified","is_valid"],"properties":{"id":{"type":"string"},"status":{"type":"string"},"name":{"type":"string"},"date_created":{"type":"string"},"created_by_id":{"type":"string"},"date_modified":{"type":"string"},"edited_by_id":{"type":"string"},"date_removed":{"type":"string"},"triggers":{"type":"array","items":{"type":"string"}},"steps":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowStep"}},"is_valid":{"type":"boolean"}}},"StepActionAgentData":{"title":"StepActionAgentData","type":"object","required":["agent_id"],"properties":{"agent_id":{"type":"string"},"run_name":{"type":"string"}}},"StepAddToCollectionActionData":{"title":"StepAddToCollectionActionData","type":"object","required":["collection_id"],"properties":{"collection_id":{"type":"string"}}},"Term":{"title":"Term","oneOf":[{"$ref":"#/components/schemas/ArchiveTerm"},{"$ref":"#/components/schemas/AssetTypeTerm"},{"$ref":"#/components/schemas/MetapropertyOptionTerm"}]}},"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/gettriggers.md","page_updatedAt":"2026-01-27T09:17:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automation Workflow API","version":"1.0.0","description":"\nThis API allows clients to manage automation-workflow rules.\n\n<b>Servers:</b>\n\n1. <b>Local Development:</b>\n   - Base URL: http://localhost:8080/{endpoint}\n\n2. <b>Stage or Production:</b>\n   - Base URL: https://automation-workflow-service.bynder.com/api/1/automation-workflow/{endpoint}\n\nEnsure you're using the correct server depending on the environment you're working in (local or production).\n  "},"servers":[{"url":"https://{your-bynder-domain}/api/1/automation-workflow/"}],"paths":{"/triggers":{"get":{"tags":["Automation Workflow Triggers"],"summary":"Fetches a list of available automation workflow triggers.","description":"\nFetches a list of available automation workflow triggers.\n\n<b>Note:</b> The `RelativeDate` trigger must be used with the `Archived` condition.\n","operationId":"getTriggers","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationWorkflowTriggersResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}}}},"security":[{},{"httpAuth":[]}]}}},"components":{"schemas":{"AutomationWorkflowTrigger":{"title":"AutomationWorkflowTrigger","type":"object","required":["name"],"properties":{"name":{"type":"string"}}},"AutomationWorkflowTriggersResponse":{"title":"AutomationWorkflowTriggersResponse","type":"object","properties":{"triggers":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowTrigger"}}}},"ErrorAuthorizationResponse":{"title":"ErrorAuthorizationResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponse":{"title":"ErrorResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}},"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/getwebhookconfigurations.md","page_updatedAt":"2026-08-03T15:19:51.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Webhooks API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}}],"tags":[{"name":"Configurations","description":""}],"paths":{"/v7/webhooks/public/api/subscriptions":{"get":{"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"antivirusEnabled":true,"configs":[{"configId":"cf2493be-c808-41da-bcc2-cfb31f38b457","confirmed":1,"endpoint":"example@example.com","events":["asset_bank.media.archived","asset_bank.media.pre_archived","asset_bank.media.deleted","asset_bank.media.updated","asset_bank.media.meta_updated","asset_bank.media.create","workflow.job.create","antivirus.scan.failed"],"is_legacy":false,"migratedSubscriptions":"[]","name":"example-webhook-name","preArchivedNotificationDays":1,"protocol":"email","status":1}],"message":"","success":true}}},"schema":{"example":{"antivirusEnabled":true,"configs":[{"configId":"cf2493be-c808-41da-bcc2-cfb31f38b457","confirmed":1,"endpoint":"example@example.com","events":["asset_bank.media.archived","asset_bank.media.pre_archived","asset_bank.media.deleted","asset_bank.media.updated","asset_bank.media.meta_updated","asset_bank.media.create","workflow.job.create","antivirus.scan.failed"],"is_legacy":false,"migratedSubscriptions":"[]","name":"example-webhook-name","preArchivedNotificationDays":1,"protocol":"email","status":1}],"message":"","success":true},"properties":{"antivirusEnabled":{"type":"boolean"},"configs":{"items":{"properties":{"configId":{"type":"string"},"confirmed":{"type":"number"},"endpoint":{"type":"string"},"events":{"items":{"type":"string"},"type":"array"},"is_legacy":{"type":"boolean"},"migratedSubscriptions":{"type":"string"},"name":{"type":"string"},"preArchivedNotificationDays":{"type":"number"},"protocol":{"type":"string"},"status":{"type":"number"}},"type":"object"},"type":"array"},"message":{"type":"string"},"success":{"type":"boolean"}},"type":"object"}}},"description":"OK","headers":{}},"400":{"content":{"application/json":{"examples":{"response":{"value":{"message":"Error while getting subscription for portal id {portal ID}: Error","success":false}}},"schema":{"example":{"message":"Error while getting subscription for portal id {portal ID}: Error","success":false},"properties":{"message":{"type":"string"},"success":{"type":"boolean"}},"type":"object"}}},"description":"Bad Request","headers":{}}},"tags":["Configurations"],"description":"Please be aware that using this endpoint requires either the `View Webhooks configurations` or `Manage Webhooks configurations` security role.","operationId":"getWebhookConfigurations","summary":"Retrieve Webhooks configurations"}}}}}
{"source_url":"https://api.bynder.com/reference/initialiseupload-1.md","page_updatedAt":"2026-07-21T13:27:24.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Upload Assets API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://bynder-public-us-east-1.s3.amazonaws.com/","variables":{}}],"paths":{"/api/upload/init":{"post":{"tags":["Step 2 Initialise upload"],"summary":"Initialise upload","description":"Initialise an upload.","operationId":"initialiseUpload","parameters":[{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"$ref":"#/components/schemas/Content-Type"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"type":"object","properties":{"filename":{"type":"string","examples":["image.jpeg"]}},"contentMediaType":"application/x-www-form-urlencoded"}}},"required":false},"responses":{"200":{"description":"Successful response","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiUploadInitResponse"}}}},"400":{"description":"Invalid input","headers":{},"content":{"text/plain":{"schema":{"type":"string","examples":[{"filename":"'image' is not a valid filename"}],"contentMediaType":"text/plain"},"example":{"filename":"'image' is not a valid filename"}}}}},"deprecated":false,"security":[{"OAuth2":["MEDIAUPLOAD","MEDIAUPLOADFORAPPROVAL"]},{"permanentToken":["MEDIAUPLOAD","MEDIAUPLOADFORAPPROVAL"]}]},"parameters":[]}},"components":{"schemas":{"ApiUploadInitResponse":{"title":"ApiUploadInitResponse","type":"object","properties":{"s3file":{"$ref":"#/components/schemas/S3file"},"s3_filename":{"type":"string","examples":["pluploads/api/00000000-0000-0000-0000-000000000000/image.jpeg"]},"target_key":{"type":"string","examples":["pluploads/api/00000000-0000-0000-0000-000000000000/image.jpeg"]},"multipart_params":{"$ref":"#/components/schemas/MultipartParams"}}},"S3file":{"title":"S3file","type":"object","properties":{"uploadid":{"type":"string","examples":["UPLOAD_ID"]},"targetid":{"type":"string","examples":["final/00000000-0000-0000-0000-000000000000/image.jpeg"]}}},"MultipartParams":{"title":"MultipartParams","type":"object","properties":{"acl":{"type":"string","examples":["private"]},"success_action_status":{"type":"string","examples":["201"]},"Content-Type":{"type":"string","examples":["image/*"]},"key":{"type":"string","examples":["pluploads/api/00000000-0000-0000-0000-000000000000/image.jpeg"]},"Policy":{"type":"string","examples":["AWS_S3_POLICY"]},"X-Amz-Signature":{"type":"string","examples":["AWS_S3_SIGNATURE"]},"x-amz-credential":{"type":"string","examples":["AWS_S3_AUTH"]},"x-amz-algorithm":{"type":"string","examples":["AWS4-HMAC-SHA256"]},"x-amz-date":{"type":"string","examples":["20160216T100755Z"]}}},"Content-Type":{"title":"Content-Type","const":"application/x-www-form-urlencoded","type":"string"}},"securitySchemes":{"permanentToken":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://your-bynder-domainDefaultValue/token","scopes":{"MEDIAUPLOAD":"","MEDIAUPLOADFORAPPROVAL":""}},"authorizationCode":{"authorizationUrl":"https://your-bynder-domainDefaultValue/","tokenUrl":"https://your-bynder-domainDefaultValue/token","scopes":{"MEDIAUPLOAD":"","MEDIAUPLOADFORAPPROVAL":""}}}}}},"security":[],"tags":[{"name":"Step 2 Initialise upload","description":"This endpoint prepares the upload of a file in chunks. It returns a file ID that will be used in subsequent steps to upload the file chunks and finalize the upload.\n"}]}}
{"source_url":"https://api.bynder.com/reference/listgroups.md","page_updatedAt":"2026-07-15T15:50:57.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Groups","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Groups (Preferred)"}],"paths":{"/api/1/groups":{"get":{"operationId":"listGroups","summary":"List groups","description":"Returns a paginated list of groups with member count.\n\nRequires the **GROUPMANAGEMENT** security role.\n","tags":["Groups (Preferred)"],"parameters":[{"name":"search_term","in":"query","required":false,"schema":{"type":"string"},"description":"Filter groups by matching name."},{"name":"ids[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}},"description":"Filter by specific group IDs (hyphens in the UUIDs are optional)."},{"name":"sort","in":"query","required":false,"schema":{"type":"string","default":"name","enum":["name","description","-name","-description"]},"description":"Sort field and direction. Prefix with `-` for descending order (e.g. `-name`)."},{"name":"start","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1},"description":"Page number (1-based)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":20,"minimum":1,"maximum":1000},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"metadata":{"type":"object","properties":{"prevPage":{"type":["string","null"],"description":"Relative URL of the previous page, or null if on the first page."},"nextPage":{"type":["string","null"],"description":"Relative URL of the next page, or null if on the last page."}}}}}}}},"400":{"description":"Unsupported `sort` value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"422":{"description":"Validation error (e.g. `start` less than 1, `limit` outside 1–1000, malformed group ID in `ids[]`)."}},"security":[{"permanentToken":["GROUPMANAGEMENT"]},{"OAuth2":["GROUPMANAGEMENT"]}]}}},"components":{"responses":{"Unauthorized":{"description":"Missing or invalid authentication. The response body is empty."},"Forbidden":{"description":"The authenticated user does not have the **GROUPMANAGEMENT** security role."}},"schemas":{"Group":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":["string","null"]},"user_count":{"type":"integer","description":"Number of members in the group."}},"example":{"id":"0397e4bd-33fe-4b8f-a51d-4c2f1d9b6c1a","name":"Marketing","description":"Everyone in the marketing department","user_count":12}},"ErrorResponse":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable description of the error."}}}}}},"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups`"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/patch_api-store-orderproducts-id.md","page_updatedAt":"2026-01-09T14:05:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Brandstore API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Orders","description":""}],"paths":{"/api/store/orderproducts/{id}":{"patch":{"summary":"Modify orderline","tags":["Orders"],"security":[{"permanentToken":["brandstore.orderadmin.edit"]},{"OAuth2":["brandstore.orderadmin.edit"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["approved","rejected"],"example":"approved"},"customerReference":{"type":"string","example":"000000000000"}}}}}},"responses":{"201":{"description":"Orderline modified","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Created"},"status_code":{"type":"integer","example":201}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"brandstore.orderadmin.view":"","brandstore.orderadmin.edit":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"brandstore.orderadmin.view":"","brandstore.orderadmin.edit":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/patch_api-workflow-jobs-id-finish.md","page_updatedAt":"2026-05-15T13:16:00.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Jobs API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Finish","description":""}],"paths":{"/api/workflow/jobs/{id}/finish":{"patch":{"summary":"Finish job","description":"Requires the JOBAPPROVE security role.","tags":["Finish"],"security":[{"permanentToken":["JOBAPPROVE"]},{"OAuth2":["JOBAPPROVE"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"00000000-0000-0000-0000-000000000000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"Finished"},"job_id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}},"responses":{"200":{"description":"Ok: Job finished successfully\n","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"Finished"},"job_id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}},"examples":{"example-1":{"value":{"status":"Finished","job_id":"00000000-0000-0000-0000-000000000000"}}}}}},"403":{"description":"Forbidden: The user does not have the required permissions for this operation.\n","content":{"application/json":{"schema":{"type":"object"},"examples":{"example-1":{"value":{}}}}}},"409":{"description":"Conflict: The job is not open (has been finished), the activeStage.status is Approved. Or the job is not on the last stage.\n","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"Job already finished."},"message":{"type":"string","example":"Re-open the job to finish again."}}},"examples":{"example-1":{"value":{"status":"Job already finished.","message":"Re-open the job to finish again."}},"example-2":{"value":{"status":"Job not on last stage.","message":"Advance the job 00000000-0000-0000-0000-000000000000 to the last stage to finish."}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/patchapi1assetassetsassetid.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AdvancedRights":{"properties":{"isDownloadable":{"type":"boolean"},"isPublic":{"type":"boolean"}},"title":"AdvancedRights","type":"object"},"Asset":{"properties":{"activeVersion":{"$ref":"#/components/schemas/VersionReference"},"advancedRights":{"$ref":"#/components/schemas/AdvancedRights"},"assetId":{"type":"string"},"assetStatus":{"type":"string"},"copyright":{"type":"string"},"description":{"type":"string"},"embargos":{"items":{"$ref":"#/components/schemas/AssetEmbargo"},"type":"array"},"moduleCode":{"$ref":"#/components/schemas/AssetModuleCode"},"name":{"type":"string"},"origin":{"type":"string"},"portalId":{"type":"string"},"timeStampCreated":{"format":"date-time","type":"string"},"timeStampModified":{"format":"date-time","type":"string"},"timeStampPublished":{"format":"date-time","type":"string"},"userCreatedId":{"type":"string"},"userModifiedId":{"type":"string"}},"title":"Asset","type":"object"},"AssetEmbargo":{"properties":{"embargoId":{"type":"string"},"embargoType":{"$ref":"#/components/schemas/AssetEmbargoType"},"timestampEnd":{"format":"date-time","type":"string"},"timestampStart":{"format":"date-time","type":"string"}},"title":"AssetEmbargo","type":"object"},"AssetEmbargoType":{"enum":["archive","limited","watermark"],"title":"AssetEmbargoType","type":"string"},"AssetModuleCode":{"enum":["BG","BS","IB","WF"],"title":"AssetModuleCode","type":"string"},"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditAssetInput":{"properties":{"copyright":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"timeStampPublished":{"type":"string"}},"title":"EditAssetInput","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"},"VersionReference":{"properties":{"timeStampCreated":{"format":"date-time","type":"string"},"versionId":{"type":"string"}},"title":"VersionReference","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}":{"patch":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Edit the core properties of an asset. Each property can individually be updated, without needing to send the rest.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"patchApi1AssetAssetsAssetid","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditAssetInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Edit asset","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/patchapi1assetassetsassetidadvanced-rights.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AdvanceRightsInput":{"properties":{"isDownloadable":{"type":"boolean"},"isPublic":{"type":"boolean"}},"title":"AdvanceRightsInput","type":"object"},"AdvancedRights":{"properties":{"isDownloadable":{"type":"boolean"},"isPublic":{"type":"boolean"}},"title":"AdvancedRights","type":"object"},"Asset":{"properties":{"activeVersion":{"$ref":"#/components/schemas/VersionReference"},"advancedRights":{"$ref":"#/components/schemas/AdvancedRights"},"assetId":{"type":"string"},"assetStatus":{"type":"string"},"copyright":{"type":"string"},"description":{"type":"string"},"embargos":{"items":{"$ref":"#/components/schemas/AssetEmbargo"},"type":"array"},"moduleCode":{"$ref":"#/components/schemas/AssetModuleCode"},"name":{"type":"string"},"origin":{"type":"string"},"portalId":{"type":"string"},"timeStampCreated":{"format":"date-time","type":"string"},"timeStampModified":{"format":"date-time","type":"string"},"timeStampPublished":{"format":"date-time","type":"string"},"userCreatedId":{"type":"string"},"userModifiedId":{"type":"string"}},"title":"Asset","type":"object"},"AssetEmbargo":{"properties":{"embargoId":{"type":"string"},"embargoType":{"$ref":"#/components/schemas/AssetEmbargoType"},"timestampEnd":{"format":"date-time","type":"string"},"timestampStart":{"format":"date-time","type":"string"}},"title":"AssetEmbargo","type":"object"},"AssetEmbargoType":{"enum":["archive","limited","watermark"],"title":"AssetEmbargoType","type":"string"},"AssetModuleCode":{"enum":["BG","BS","IB","WF"],"title":"AssetModuleCode","type":"string"},"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"},"VersionReference":{"properties":{"timeStampCreated":{"format":"date-time","type":"string"},"versionId":{"type":"string"}},"title":"VersionReference","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/advanced-rights":{"patch":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Update the value of the asset advanced rights (downloadable, or isPublic). These properties have to be carefully considered when changing, with their potential security implications. Either property can be updated individually.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"patchApi1AssetAssetsAssetidAdvanced-rights","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvanceRightsInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Update advanced right","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/patchapi1taxonomymetapropertiesmetapropertyid.md","page_updatedAt":"2026-05-11T07:21:24.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty","version":"1.0"},"openapi":"3.1.0","paths":{"/api/1/taxonomy/metaproperties/{metapropertyId}":{"patch":{"description":"Modify a metaproperty by id","operationId":"patchApi1TaxonomyMetapropertiesMetapropertyid","parameters":[{"in":"path","name":"metapropertyId","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allowDuplicates":{"type":"boolean"},"autocomplete":{"type":"boolean"},"createDuringApply":{"type":"boolean"},"definition":{"type":"string"},"metapropertyType":{"enum":["single-select","multi-select","date","text"],"title":"MetapropertyTypeEnum","type":"string"},"name":{"type":"string"}},"title":"MetapropertyUpdateInput","type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"examples":{"MetapropertyUpdated":{"summary":"Response when the metaproperty is updated","value":{"message":"Metaproperty has been updated"}}},"schema":{"properties":{"message":{"type":"string"}},"required":["message"],"title":"MetapropertyUpdatedOutput","type":"object"}}},"description":""},"400":{"content":{"application/json":{"examples":{"NameAlreadyRegistered":{"summary":"Response when the name is already used","value":{"errorCode":"name-already-registered","message":"Name was already registered"}}},"schema":{"properties":{"errorCode":{"type":"string"},"errors":{"items":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"title":"ErrorMessage","type":"object"},"type":"array"},"message":{"type":"string"}},"title":"MetapropertyUpdateInvalidOutput","type":"object"}}},"description":""},"404":{"content":{"application/json":{"examples":{"MetapropertyNotExisting":{"summary":"Response when the metaproperty does not exist","value":{"errorCode":"metaproperty-not-existing","message":"Metaproperty does not exist"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"title":"MetapropertyUpdateNotFoundOutput","type":"object"}}},"description":""}},"summary":"Modify metaproperty","tags":["Metaproperties - New API (Preferred)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Metaproperties - New API (Preferred)"}]}}
{"source_url":"https://api.bynder.com/reference/patchapi1taxonomymetapropertiesmetapropertyidoptionsoptionid.md","page_updatedAt":"2026-05-11T06:38:40.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty options","version":"1.0"},"openapi":"3.1.0","paths":{"/api/1/taxonomy/metaproperties/{metapropertyId}/options/{optionId}":{"patch":{"description":"Modify an option by id","operationId":"patchApi1TaxonomyMetapropertiesMetapropertyidOptionsOptionid","parameters":[{"in":"path","name":"metapropertyId","required":true,"schema":{"format":"uuid","type":"string"}},{"in":"path","name":"optionId","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"definition":{"type":"string"},"externalReference":{"type":"string"},"icon":{"type":"string"},"name":{"type":"string"}},"title":"MetapropertyOptionUpdateInput","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"OptionUpdated":{"summary":"Response when the option is updated","value":{"message":"Option has been updated"}}},"schema":{"properties":{"message":{"type":"string"}},"required":["message"],"title":"OptionUpdatedOutput","type":"object"}}},"description":""},"400":{"content":{"application/json":{"examples":{"NameAlreadyRegistered":{"summary":"Response when the name is already used","value":{"errorCode":"name-already-registered","message":"Name was already registered"}}},"schema":{"properties":{"errorCode":{"type":"string"},"errors":{"items":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"title":"ErrorMessage","type":"object"},"type":"array"},"message":{"type":"string"}},"title":"OptionUpdateInvalidOutput","type":"object"}}},"description":""},"404":{"content":{"application/json":{"examples":{"MetapropertyNotExisting":{"summary":"Response when the metaproperty does not exist","value":{"errorCode":"metaproperty-not-existing","message":"Metaproperty does not exist"}},"OptionNotExisting":{"summary":"Response when the option does not exist","value":{"errorCode":"option-not-existing","message":"Option does not exist"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"title":"OptionUpdateNotFoundOutput","type":"object"}}},"description":""}},"summary":"Modify option","tags":["Options - New API (Preferred)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Options - New API (Preferred)"}]}}
{"source_url":"https://api.bynder.com/reference/patchawebhookconfiguration.md","page_updatedAt":"2026-08-03T15:12:29.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Webhooks API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}}],"tags":[{"name":"Configurations","description":""}],"paths":{"/v7/webhooks/public/api/subscriptions/{id}":{"patch":{"summary":"Patch a Webhook Configuration","description":"Please be aware that using this endpoint requires the `Manage Webhooks configurations` security role.","tags":["Configurations"],"operationId":"PatchaWebhookConfiguration","parameters":[{"name":"id","in":"path","description":"Webhook configuration ID.","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiV7WebhooksPublicApiSubscriptionsRequest2"}}},"required":true},"responses":{"200":{"description":"Webhook patched successfully","headers":{},"content":{}}},"deprecated":false},"parameters":[]}},"components":{"schemas":{"ApiV7WebhooksPublicApiSubscriptionsRequest2":{"title":"ApiV7WebhooksPublicApiSubscriptionsRequest2","type":"object","properties":{"name":{"type":"string","examples":["Updated name via API"]},"status":{"type":"integer","contentEncoding":"int32","examples":[1]}}}}}}}
{"source_url":"https://api.bynder.com/reference/patchrulesruleidstatus.md","page_updatedAt":"2026-01-27T09:17:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automation Workflow API","version":"1.0.0","description":"\nThis API allows clients to manage automation-workflow rules.\n\n<b>Servers:</b>\n\n1. <b>Local Development:</b>\n   - Base URL: http://localhost:8080/{endpoint}\n\n2. <b>Stage or Production:</b>\n   - Base URL: https://automation-workflow-service.bynder.com/api/1/automation-workflow/{endpoint}\n\nEnsure you're using the correct server depending on the environment you're working in (local or production).\n  "},"servers":[{"url":"https://{your-bynder-domain}/api/1/automation-workflow/"}],"paths":{"/rules/{ruleId}/status":{"patch":{"tags":["Automation Workflow Rules"],"summary":"Updates the status of an existing automation workflow rule.","description":"Updates the status of an existing automation workflow rule. The status must be one of the following: `PUBLISHED` or `PAUSED`.","operationId":"patchRulesRuleidStatus","parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStatusAutomationWorkflowRuleBody"}}},"required":true},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseNotFound"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseRuleAlreadyPaused"}}}}},"security":[{},{"httpAuth":[]}]}}},"components":{"schemas":{"ErrorAuthorizationResponse":{"title":"ErrorAuthorizationResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponse":{"title":"ErrorResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponseNotFound":{"title":"ErrorResponseNotFound","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponseRuleAlreadyPaused":{"title":"ErrorResponseRuleAlreadyPaused","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"UpdateStatusAutomationWorkflowRuleBody":{"title":"UpdateStatusAutomationWorkflowRuleBody","type":"object","required":["status"],"properties":{"status":{"type":"string"}}}},"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/patchuploadfilechunks.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/":{"patch":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n The request target is the `Location` response header returned by **Upload file initialization**. Carry the relevant header information across calls as shown below. After the last chunk is uploaded, the file is automatically finalized. \n> The `Location Header Value` URL is a placeholder for the `Location` header from the previous call.","operationId":"patchUploadFileChunks","parameters":[{"in":"header","name":"tus-resumable","required":true,"schema":{"default":"1.0.0","type":"string"}},{"description":"The combined length of the previously uploaded chunks. This value can be taken from the Upload-Offset response header of each preceding chunk request.","in":"header","name":"upload-offset","required":true,"schema":{"type":"string"}},{"in":"header","name":"content-type","required":true,"schema":{"default":"application/offset+octet-stream","type":"string"}},{"in":"header","name":"fileid","required":true,"schema":{"type":"string"}},{"in":"header","name":"filename","required":true,"schema":{"type":"string"}},{"in":"header","name":"reason","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/offset+octet-stream":{"schema":{"format":"binary","type":"string"}}},"required":true},"responses":{"200":{"description":"Chunk accepted.","headers":{"Upload-Offset":{"description":"New offset after this chunk; use it for the next chunk request.","schema":{"type":"integer"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""}},"security":[{"httpAuth":[]}],"servers":[{"description":"Dynamic Tus upload server returned in the previous step.","url":"{Location Header Value}","variables":{"baseUploadUrl":{"default":"{Location Header Value}"}}}],"summary":"Upload file chunks","tags":["Asset ingestion"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Create an asset, upload its file in resumable chunks, and publish it. After the file is uploaded you can **enrich the asset** - see the *Asset enrichment* section - before publishing. Retrieval of the asset during ingestion uses **Get asset** in the *General endpoints* section.","name":"Asset ingestion"}]}}
{"source_url":"https://api.bynder.com/reference/post_api-1-assets-similarity-search.md","page_updatedAt":"2026-05-01T13:29:12.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.0.0","info":{"title":"Bynder Asset Similarity Search API","version":"1.0.0","description":"API for searching similar assets in Bynder using AI-powered similarity search."},"servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"example.com","description":"Your Bynder domain."}}}],"paths":{"/api/1/assets/similarity-search/":{"post":{"summary":"Search for similar assets","description":"Perform a similarity search for assets based on asset IDs, image URL, image data, or text query. <br><br>This endpoint uses the newer, standard UUID format of 8-4-4-4-12, and letters are lowercase. See the example for `assetIds`, and [Note on identifiers](https://api.bynder.com/docs/getting-started#note-on-identifiers) for more information. Additionally, only one of the search parameters (`assetIds`, `imageUrl`, `imageData`, `textQuery`) should be provided per request. Providing multiple parameters will result in a `400` Bad request response. Only OAuth2 authentication is supported for this endpoint, and permanent tokens are not accepted.","tags":["Similarity Search"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assetIds":{"type":"array","items":{"type":"string"},"description":"List of asset IDs to search similar assets for.","example":["eff9f6c7-ae77-4614-911b-fd238df5bac3","5af81baa-ee0b-4611-bfa6-fd023c7989b8"]},"imageUrl":{"type":"string","description":"URL of the image to find similar assets.","example":"https://d2csxpduxe849s.cloudfront.net/media/A7148429-45E9-45C9-98BABD031228C0E2/0A1C48A2-2523-440C-81DD9DFA221D28FC/webimage-5FE11596-1C5D-4FC1-9C216A240BA53979.png"},"imageData":{"type":"string","description":"Base64 encoded image data for similarity search.","example":"data:image/jpeg;base64,..."},"textQuery":{"type":"string","description":"A text query describing the image for the search.","example":"Image of a sunset"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"assets":{"type":"array","items":{"type":"object","properties":{"assetId":{"type":"string","example":"e0664bc4-4d64-4776-a010-a19d337f7ee9"},"similarityScore":{"type":"number","format":"float","example":0.98}}}}}},"example":{"assets":[{"assetId":"e0664bc4-4d64-4776-a010-a19d337f7ee9","similarityScore":0.98},{"assetId":"0e870dbc-c6a4-414a-8467-75fac70c84d9","similarityScore":0.95}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Multiple search parameters provided. Please provide only one of the following parameters: assetIds, imageUrl, imageData, textQuery."},"reason":{"type":"string","example":"MULTIPLE_SEARCH_PARAMETERS"}}},"example":{"message":"Multiple search parameters provided. Please provide only one of the following parameters: assetIds, imageUrl, imageData, textQuery.","reason":"MULTIPLE_SEARCH_PARAMETERS"}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"OAuth2"}}},"security":[{"bearerAuth":[]}],"tags":[{"name":"Similarity Search","description":"Endpoints for performing AI-powered similarity searches on assets"}]}}
{"source_url":"https://api.bynder.com/reference/post_api-media-options.md","page_updatedAt":"2026-05-15T13:36:18.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"ARCHIVEDOWNLOAD":"","ARCHIVEMEDIA":"","EMARGOMEDIA":"","KEYVISUALDOWNLOAD":"","MARKPUBLIC":"","MEDIAEDIT":"","MEDIAREMOVE":"","STATISTICS":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"ARCHIVEDOWNLOAD":"","ARCHIVEMEDIA":"","EMARGOMEDIA":"","KEYVISUALDOWNLOAD":"","MARKPUBLIC":"","MEDIAEDIT":"","MEDIAREMOVE":"","STATISTICS":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Asset Management API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/media/options":{"post":{"description":"These calls allow you to change the metaproperty options attached to an asset.\n\n**Note that this is an append operation; the options you add here will be appended to the existing option on the asset, it does not overwrite them.**","requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"asset_id":"00000000-0000-0000-0000000000000000","metaproperty_id":"00000000-0000-0000-0000000000000000","metaproperty_option_ids":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000001"]}}},"schema":{"properties":{"asset_id":{"example":"00000000-0000-0000-0000000000000000","type":"string"},"metaproperty_id":{"example":"00000000-0000-0000-0000000000000000","type":"string"},"metaproperty_option_ids":{"items":{"example":"00000000-0000-0000-0000000000000000","type":"string"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Created","type":"string"},"statuscode":{"example":201,"type":"integer"}},"type":"object"}}},"description":"Created"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Access denied","type":"string"},"statuscode":{"example":403,"type":"integer"}},"type":"object"}}},"description":"Access denied"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Not Found","type":"string"},"statuscode":{"example":404,"type":"integer"}},"type":"object"}}},"description":"Not Found"}},"security":[{"permanentToken":["MEDIAEDIT"]},{"OAuth2":["MEDIAEDIT"]}],"summary":"Add metaproperty options","tags":["Media options"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"","name":"Media options"}]}}
{"source_url":"https://api.bynder.com/reference/post_api-media-usage-sync.md","page_updatedAt":"2025-06-04T05:23:29.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Asset Usage API","version":"1.0.0","description":"These calls allow you to keep track of assets being exported from Bynder and imported into a third party application. In order to get started or find an existing integration id you should check out this [Bynder support](https://help.bynder.com/en/216226-track-asset-usage.html#UUID-5db586ff-9502-8e5b-4355-ca3630fceee3_N1579707153615_body) article. If you want to register a new third party application please contact us at [support@bynder.com](mailto:support@bynder.com).\n"},"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["STATISTICS"]},{"permanentToken":["STATISTICS"]}],"tags":[{"name":"Asset Usage Sync","description":"This alternative API call allows you to sync all your usage from a single integration.\n* A usage will be created when there is no existing usage on the specified asset\n* A usage will be updated when adding additional info\n* A usage will be deleted when specifying a URI but not using that URI in a usage\n\n__Warning:__ Requires the STATISTICS security role.\n"}],"paths":{"/api/media/usage/sync":{"post":{"summary":"Sync asset usage","description":"Sync all usage from a single integration.","tags":["Asset Usage Sync"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"integration_id":{"type":"string","description":"Integration id."},"uris":{"type":"array","items":{"type":"string"},"description":"An array of URIs that are part of your integration."},"usages":{"type":"array","items":{"type":"object","properties":{"asset_id":{"type":"string"},"uri":{"type":"string"},"additional":{"type":"string"}}}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"accepted":{"type":"array","items":{"type":"object","properties":{"additional":{"type":"string"},"asset_id":{"type":"string"},"uri":{"type":"string"}}}},"new":{"type":"array","items":{"type":"object","properties":{"additional":{"type":"string"},"asset_id":{"type":"string"},"id":{"type":"string"},"integration":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"},"uri":{"type":"string"}}}},"rejected":{"type":"array","items":{"type":"object","properties":{"asset_id":{"type":"string"},"reason":{"type":"string"},"uri":{"type":"string"}}}},"removed":{"type":"array","items":{"type":"object","properties":{"asset_id":{"type":"string"},"uri":{"type":"string"}}}}}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"integration_id":{"type":"string"},"asset_id":{"type":"string"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"STATISTICS":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"STATISTICS":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-media-usage.md","page_updatedAt":"2026-01-29T09:49:04.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Asset Usage API","version":"1.0.0","description":"These calls allow you to keep track of assets being exported from Bynder and imported into a third party application. In order to get started or find an existing integration id you should check out this [Bynder support](https://help.bynder.com/en/216226-track-asset-usage.html#UUID-5db586ff-9502-8e5b-4355-ca3630fceee3_N1579707153615_body) article. If you want to register a new third party application please contact us at [support@bynder.com](mailto:support@bynder.com).\n"},"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["STATISTICS"]},{"permanentToken":["STATISTICS"]}],"tags":[{"name":"Asset Usage","description":"These calls allow you to keep track of assets being exported from Bynder and imported into a third party application. In order to get started or find an existing integration id you should check out this Bynder support article. If you want to register a new third party application please contact us at [support@bynder.com](mailto:support@bynder.com).\n\n__Warning:__ Requires the STATISTICS security role.\n"}],"paths":{"/api/media/usage":{"post":{"summary":"Create asset usage","description":"Create a new asset usage entry.","tags":["Asset Usage"],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"integration_id":{"type":"string","description":"Integration id."},"asset_id":{"type":"string","description":"Asset id."},"timestamp":{"type":"string","format":"date-time","description":"Datetime in ISO8601 format yyyy-mm-ddThh:mm:ssZ."},"uri":{"type":"string","description":"Location."},"additional":{"type":"string","description":"Additional information."}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"uri":{"type":"string"},"additional":{"type":"string"},"asset_id":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"integration":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"}}}}}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"integration_id":{"type":"string"},"asset_id":{"type":"string"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"STATISTICS":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"STATISTICS":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-store-order-id-products.md","page_updatedAt":"2026-01-09T14:05:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Brandstore API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Orders","description":""}],"paths":{"/api/store/order/{id}/products":{"post":{"summary":"Modify order","tags":["Orders"],"security":[{"permanentToken":["brandstore.orderadmin.edit"]},{"OAuth2":["brandstore.orderadmin.edit"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["IN_PROGRESS","CANCELED","FAILED","WAITING_FOR_PAYMENT","FOR_ORDER","IN_PRODUCTION","PRODUCTION_SUSPENDED","OUT_FOR_DELIVERY","FINISHED"],"example":"IN_PROGRESS"},"message":{"type":"string","example":"Order has been delivered"},"trackingnumber":{"type":"string","example":"trackingnumber"}}}}}},"responses":{"201":{"description":"Order modified","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Created"},"status_code":{"type":"integer","example":201}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"brandstore.orderadmin.view":"","brandstore.orderadmin.edit":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"brandstore.orderadmin.view":"","brandstore.orderadmin.edit":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-collections-id-media.md","page_updatedAt":"2026-01-07T13:31:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Collections API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Collections assets","description":""}],"paths":{"/api/v4/collections/{id}/media":{"post":{"summary":"Add assets to a collection","description":"Add assets to a specific collection by ID.","tags":["Collections assets"],"security":[{"OAuth2":["COLLECTIONS"]},{"permanentToken":["COLLECTIONS"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"data":{"type":"string","example":"[\"00000000-0000-0000-0000000000000000\"]"}}}}}},"responses":{"202":{"description":"Assets added to collection.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Accepted"},"statuscode":{"type":"integer","example":202}}}}}},"403":{"description":"Access denied.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Access denied"},"statuscode":{"type":"integer","example":403}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-collections-id-share.md","page_updatedAt":"2026-01-07T13:31:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Collections API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Share collection","description":""}],"paths":{"/api/v4/collections/{id}/share":{"post":{"summary":"Share collection","description":"Share a specific collection by ID.","tags":["Share collection"],"security":[{"OAuth2":["SHARECOLLECTION","SHARING"]},{"permanentToken":["SHARECOLLETION","SHARING"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"recipients":{"type":"string","example":"user1@bynder.com,user2@bynder.com"},"groups":{"type":"string","example":"00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000"},"profiles":{"type":"string","example":"00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000"},"collectionOptions":{"type":"string","enum":["readOnly","view","readAccess","edit"],"example":"view"},"loginRequired":{"type":"boolean","example":true},"dateStart":{"type":"string","example":"2014-08-12T08:07:24Z"},"dateEnd":{"type":"string","example":"2015-08-12T08:07:24Z"},"sendMail":{"type":"boolean","example":true},"message":{"type":"string","example":"Your message goes here"}}}}}},"responses":{"202":{"description":"Collection shared.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"accepted"},"statuscode":{"type":"integer","example":202}}}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Recipients, groups or profiles must contain at least one entry"},"statuscode":{"type":"integer","example":400}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-collections-id.md","page_updatedAt":"2026-01-07T13:31:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Collections API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Collections ID","description":""}],"paths":{"/api/v4/collections/{id}":{"post":{"summary":"Modify collection","description":"Modify a specific collection by ID.","tags":["Collections ID"],"security":[{"OAuth2":["COLLECTIONS","PUBLISHCOLLECTIONS"]},{"permanentToken":["COLLECTIONS","PUBLISHCOLLECTIONS"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Featured collection"},"description":{"type":"string","example":"Collection of featured assets"},"isPublic":{"type":"boolean","example":true},"thumbnailAssetId":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}}}}},"responses":{"201":{"description":"Collection modified.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Created"},"statuscode":{"type":"integer","example":201}}}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Collection name can't be empty"},"statuscode":{"type":"integer","example":400}}}}}},"403":{"description":"Access denied.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Access denied"},"statuscode":{"type":"integer","example":403}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-collections.md","page_updatedAt":"2026-01-07T13:31:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Collections API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Collections","description":""}],"paths":{"/api/v4/collections":{"post":{"summary":"Create collection","description":"Create a new collection.","tags":["Collections"],"security":[{"OAuth2":["COLLECTIONS"]},{"permanentToken":["COLLECTIONS"]}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Collection name","example":"Featured collection"},"description":{"type":"string","description":"Collection description","example":"Collection of featured assets"}}}}}},"responses":{"201":{"description":"Created","headers":{"Location":{"description":"URL to the created collection","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Created"},"statuscode":{"type":"integer","example":201}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Collection name can't be empty"},"statuscode":{"type":"integer","example":400}}}}}},"403":{"description":"Access denied","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Access denied"},"statuscode":{"type":"integer","example":403}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"collection.public.view":"To retrieve public collections","INBOXPUBLIC":"To retrieve collections other users shared/received","OUTBOXPUBLIC":"To retrieve collections other users shared/received","PUBLICCOLLECTIONS":"To retrieve collections other users created","COLLECTIONS":"","PUBLISHCOLLECTIONS":"","SHARECOLLECTION":"","SHARING":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-media-id.md","page_updatedAt":"2026-05-15T13:36:18.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"ARCHIVEDOWNLOAD":"","ARCHIVEMEDIA":"","EMARGOMEDIA":"","KEYVISUALDOWNLOAD":"","MARKPUBLIC":"","MEDIAEDIT":"","MEDIAREMOVE":"","STATISTICS":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"ARCHIVEDOWNLOAD":"","ARCHIVEMEDIA":"","EMARGOMEDIA":"","KEYVISUALDOWNLOAD":"","MARKPUBLIC":"","MEDIAEDIT":"","MEDIAREMOVE":"","STATISTICS":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Asset Management API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/v4/media/{id}":{"post":{"description":"Requires the **MEDIAEDIT** security role. Requires the **MARKPUBLIC** security role in order to change an asset's isPublic state.\n\n**Custom thumbnails**\n\nTo set a custom thumbnail, first upload the thumbnail image using the [Modern Stack File Upload](https://api.bynder.com/reference/modern-stack-file-upload) flow, then call this endpoint with the returned file id as `customThumbnailFileId`. To remove an existing custom thumbnail and revert to the automatically generated one, call this endpoint with `removeCustomThumbnail=true`. The two fields are mutually exclusive.","parameters":[{"description":"Asset id.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"examples":{"real example":{"summary":"Update an asset via x-www-form-urlencoded with metaproperty values","value":{"customThumbnailFileId":"7d3015f1-fadf-4fca-b49e-e6d08a29f9bb","description":"Updated title and metadata from Postman form-data example","id":"8EC04DC8-F7FE-4D2D-BE2F2789A632393D","metaproperty.C53BC6FD-21A0-4DF1-AE80F0A329D7":"Option 1,Option 2","metaproperty.C74B9496-16E8-41AA-80D83D8549C8":"B7F3232E-D2A9-40CF-8551-DA2B1FF4E97D,C5215523-AEBD-4A72-92F8-5D8C5E0F2E11","metaproperty.E1202866-306B-43A5-ADE20BDAB6D1":"This is the alt text","metaproperty.E8D9B6EF-F969-49B1-BDB95982F05D":"551CB615-965F-4643-A2A7-A4974AA0B128","name":"Spring campaign hero image","tags":"spring,hero,campaign-2026"}}},"schema":{"properties":{"archive":{"description":"Indicating the archived state of the asset.","type":"boolean"},"archiveDate":{"description":"Archive datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.\n","format":"date-time","type":"string"},"brandId":{"description":"Id of the brand to save the asset to.","type":"string"},"copyright":{"description":"Copyright information of the asset.","type":"string"},"customThumbnailFileId":{"description":"The file id of the custom thumbnail to be set for the asset. Custom thumbnails must first be uploaded by following the steps described in the [Modern Stack File Upload](https://api.bynder.com/reference/modern-stack-file-upload) documentation; use the `fileId` returned by that flow. Cannot be combined with `removeCustomThumbnail`.","example":"00000000-0000-0000-0000-000000000000","type":"string"},"datePublished":{"description":"Publication datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.\n","format":"date-time","type":"string"},"description":{"description":"Asset description.","type":"string"},"id":{"description":"Asset id.","type":"string"},"isPublic":{"description":"Indicating the public state of the asset. Warning irreversible, once changed to true it cannot be changed back.","type":"boolean"},"limited":{"description":"Indicating the limit state of the asset.","type":"boolean"},"limitedDate":{"description":"Limit datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.\n","format":"date-time","type":"string"},"metaproperty":{"additionalProperties":{"type":"string"},"description":"Mapping of metaproperty UUIDs to the option value(s) to set on the asset. Each value may be provided as option label, option DB name, or option UUID. For multi-select metaproperties, pass multiple values as a comma-separated string. <br><br>In x-www-form-urlencoded requests, fields are sent as `metaproperty.<metaproperty_uuid>=<value1>,<value2>`.","example":{"02509778-CEE3-43D5-9E96-9A60B1E78314":"option_id1,option_id2","EF122F1F-9BA0-4772-80F1-BF05588B1A59":"option_id3"},"type":"object"},"name":{"description":"Name of the asset, beware the asset will have no name when this is empty.","type":"string"},"removeCustomThumbnail":{"description":"Remove the current custom thumbnail from the asset, reverting to the automatically generated thumbnail. Cannot be combined with `customThumbnailFileId`.","example":true,"type":"boolean"},"tags":{"description":"Comma-separated tags. Tags will overwrite the current tags list.","type":"string"},"watermarkDate":{"description":"Watermark datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.\n","format":"date-time","type":"string"}},"type":"object"}}}},"responses":{"202":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"statuscode":{"type":"integer"}},"type":"object"}}},"description":"Accepted"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"statuscode":{"type":"string"}},"type":"object"}}},"description":"Access denied"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"},"statuscode":{"type":"string"}},"type":"object"}}},"description":"Media not found"}},"security":[{"permanentToken":["","MEDIAEDIT","MARKPUBLIC"]},{"OAuth2":["","MEDIAEDIT","MARKPUBLIC"]}],"summary":"Modify asset","tags":["Media ID"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"","name":"Media ID"}]}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-metaproperties-id-options-optionid-dependencies-dependencyid.md","page_updatedAt":"2026-05-11T06:38:49.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Dependencies for Metaproperties and Options","version":"1.0.0"},"tags":[{"name":"Option dependency (Please use new Automations API if possible)"}],"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"paths":{"/api/v4/metaproperties/{id}/options/{optionId}/dependencies/{dependencyId}":{"post":{"summary":"Add a dependency","description":"Manage metaproperty option dependencies","tags":["Option dependency (Please use new Automations API if possible)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"dependencyId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"examples":{"example-201":{"value":{"message":"Created","statuscode":201}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example-unknown-metaproperty":{"value":{"message":"Unknown metaproperty","statuscode":404}},"example-unknown-metaproperty-option":{"value":{"message":"Unknown metaproperty option","statuscode":404}},"example-unknown-dependency-option":{"value":{"message":"Unknown dependency option","statuscode":404}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-metaproperties-id-options-optionid-dependencies-group-groupid-dependencyid.md","page_updatedAt":"2026-05-11T06:38:49.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Dependencies for Metaproperties and Options","version":"1.0.0"},"tags":[{"name":"Option dependency group (Please use new Automations API if possible)"}],"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"paths":{"/api/v4/metaproperties/{id}/options/{optionId}/dependencies/group/{groupId}/{dependencyId}":{"post":{"summary":"Add a dependency option to a group","description":"Add a dependency option to a specific dependency group for a metaproperty option.","tags":["Option dependency group (Please use new Automations API if possible)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"dependencyId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the metaproperty the (metaproperty) option belongs to.","example":"00000000-0000-0000-0000000000000000"},"optionId":{"type":"string","description":"The id of the (metaproperty) option the dependency group belongs to.","example":"00000000-0000-0000-0000000000000000"},"groupId":{"type":"string","description":"The id of the dependency group you’d like to add a dependency to.","example":"00000000-0000-0000-0000000000000000"},"dependencyId":{"type":"string","description":"The id of the dependency (metaproperty option) you’d like to add to the dependency group.","example":"00000000-0000-0000-0000000000000000"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"examples":{"example-201":{"value":{"message":"Created","statuscode":201}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example-unknown-metaproperty":{"value":{"message":"Unknown metaproperty","statuscode":"404"}},"example-unknown-metaproperty-option":{"value":{"message":"Unknown metaproperty option","statuscode":"404"}},"example-unknown-group":{"value":{"message":"Unknown group","statuscode":"404"}},"example-unknown-dependency-option":{"value":{"message":"Unknown dependency option","statuscode":"404"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-metaproperties-id-options-optionid-dependencies-group-groupid.md","page_updatedAt":"2026-05-11T06:38:49.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Dependencies for Metaproperties and Options","version":"1.0.0"},"tags":[{"name":"Option dependency group (Please use new Automations API if possible)"}],"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"paths":{"/api/v4/metaproperties/{id}/options/{optionId}/dependencies/group/{groupId}":{"post":{"summary":"Modify dependency group","description":"Modify a dependency group for a metaproperty option.","tags":["Option dependency group (Please use new Automations API if possible)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"groupId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the metaproperty the (metaproperty) option belongs to.","example":"00000000-0000-0000-0000000000000000"},"optionId":{"type":"string","description":"The id of the (metaproperty) option the dependency group belongs to.","example":"00000000-0000-0000-0000000000000000"},"groupId":{"type":"string","description":"The id of the dependency group you’d like to modify.","example":"00000000-0000-0000-0000000000000000"},"data":{"type":"array","items":{"type":"string"},"description":"JSON-serialised string of dependency (metaproperty option) ids.","example":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000000"]}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"examples":{"example-201":{"value":{"message":"Created","statuscode":201}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example-unknown-metaproperty-option":{"value":{"message":"Unknown metaproperty option","statuscode":"404"}},"example-unknown-group":{"value":{"message":"Unknown group","statuscode":"404"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-metaproperties-id-options-optionid-dependencies-group.md","page_updatedAt":"2026-05-11T06:38:49.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Dependencies for Metaproperties and Options","version":"1.0.0"},"tags":[{"name":"Option dependency group (Please use new Automations API if possible)"}],"servers":[{"url":"https://{your-bynder-domain}/"}],"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"paths":{"/api/v4/metaproperties/{id}/options/{optionId}/dependencies/group":{"post":{"summary":"Create dependency group","description":"Create a dependency group for a metaproperty option.","tags":["Option dependency group (Please use new Automations API if possible)"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}},{"name":"optionId","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"},"description":"JSON-serialised list of dependency option ids.","example":["00000000-0000-0000-0000000000000000","00000000-0000-0000-0000000000000000"]}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"examples":{"example-201":{"value":{"message":"Created","statuscode":201,"id":"00000000-0000-0000-0000000000000000"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"example-invalid-metaproperty-id":{"value":{"message":"Invalid metaproperty ID","statuscode":"400"}},"example-unknown-metaproperty-option-id":{"value":{"message":"Unknown metaproperty option id","statuscode":"400"}},"example-no-data-sent":{"value":{"message":"No data sent","statuscode":"400"}},"example-data-cannot-be-empty":{"value":{"message":"Data cannot be empty","statuscode":"400"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example-unknown-dependency-option":{"value":{"message":"Unknown dependency option","statuscode":"404"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"METAPROPERTYMANAGEMENT":"","METAMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-metaproperties-id-options-optionid.md","page_updatedAt":"2026-05-11T06:38:40.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty options","version":"1.0"},"openapi":"3.1.0","paths":{"/api/v4/metaproperties/{id}/options/{optionId}":{"post":{"description":"Modify a specific option.","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}},{"in":"path","name":"optionId","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"data":{"description":"JSON-serialised string","example":"{\"label\": \"Blue\", \"externalReference\": \"Reference number 1\", \"labels\": {\"fr_FR\": \"foo\", \"en_US\": \"foo\"}, \"zindex\": 4, \"isSelectable\": true, \"parentId\": \"00000000-0000-0000-0000000000000000\"}","type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Created","type":"string"},"statuscode":{"example":201,"type":"integer"}},"type":"object"}}},"description":"Created"},"400":{"content":{"application/json":{"examples":{"invalidName":{"value":{"message":"Editing meta property option name not allowed","statuscode":"400"}}},"schema":{"properties":{"message":{"example":"Editing meta property option name not allowed","type":"string"},"statuscode":{"example":"400","type":"string"}},"type":"object"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"examples":{"notFound":{"value":{"message":"Meta property option not found","statuscode":"404"}}},"schema":{"properties":{"message":{"example":"Meta property option not found","type":"string"},"statuscode":{"example":"404","type":"string"}},"type":"object"}}},"description":"Not Found"}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"summary":"Modify option","tags":["Options - Old API (Please use new API if possible)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Options - Old API (Please use new API if possible)"}]}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-metaproperties-id-options.md","page_updatedAt":"2026-05-11T06:38:40.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty options","version":"1.0"},"openapi":"3.1.0","paths":{"/api/v4/metaproperties/{id}/options":{"post":{"description":"Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.\n\nNote: when the `name` you provide differs from the option's label, Bynder automatically assigns that `name` value as the option's `externalReference`. Explicitly setting `externalReference` to `null` or an empty string does not prevent this. To store a specific external reference, pass the desired value in the `externalReference` field.","parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"data":{"description":"JSON-serialised string","example":"{\"name\": \"BlueType\", \"externalReference\": \"Reference number 1\", \"label\": \"Blue\", \"labels\": {\"fr_FR\": \"foo\", \"en_US\": \"foo\"}, \"zindex\": 4, \"isSelectable\": true, \"parentId\": \"00000000-0000-0000-0000000000000000\", \"options\": [{\"name\": \"BlueType\", \"label\": \"Blue\", \"labels\": {\"fr_FR\": \"foo\", \"en_US\": \"foo\"}, \"zindex\": 4, \"isSelectable\": true, \"parentId\": \"00000000-0000-0000-0000000000000000\"}]}","type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"example":"00000000-0000-0000-0000000000000000","type":"string"},"message":{"example":"Created","type":"string"},"statuscode":{"example":201,"type":"integer"}},"type":"object"}}},"description":"Created"},"400":{"content":{"application/json":{"examples":{"existingOption":{"value":{"existingUUID":"00000000-0000-0000-0000000000000000","message":"Meta property option with this name already exists","statuscode":"400"}},"invalidId":{"value":{"message":"Invalid metaproperty ID","statuscode":"400"}},"invalidJson":{"value":{"message":"Invalid JSON","statuscode":"400"}},"nameRequired":{"value":{"message":"Meta property option name is required","statuscode":"400"}},"noData":{"value":{"message":"No data sent","statuscode":"400"}}},"schema":{"properties":{"message":{"example":"Invalid metaproperty ID","type":"string"},"statuscode":{"example":"400","type":"string"}},"type":"object"}}},"description":"Bad Request"},"404":{"content":{"application/json":{"examples":{"notFound":{"value":{"message":"Metaproperty not found","statuscode":"404"}}},"schema":{"properties":{"message":{"example":"Metaproperty not found","type":"string"},"statuscode":{"example":"404","type":"string"}},"type":"object"}}},"description":"Metaproperty not found"}},"summary":"Create option","tags":["Options - Old API (Please use new API if possible)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Options - Old API (Please use new API if possible)"}]}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-metaproperties-id.md","page_updatedAt":"2026-05-11T07:21:24.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty","version":"1.0"},"openapi":"3.1.0","paths":{"/api/v4/metaproperties/{id}":{"post":{"description":"Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.","parameters":[{"description":"Metaproperty id.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"data":{"description":"JSON-serialised string","example":"{\n  \"type\": \"select\",\n  \"label\": \"Colour\",\n  \"labels\": {\"fr_FR\": \"foo\", \"en_US\": \"foo\"},\n  \"zindex\": 4,\n  \"isEditable\": true,\n  \"isFilterable\": true,\n  \"isMainfilter\": true,\n  \"isMultiselect\": true,\n  \"isRequired\": true,\n  \"isMultifilter\": true,\n  \"isDrilldown\": true,\n  \"isDisplayField\": true,\n  \"isApiField\": true\n}\n","type":"string"},"id":{"description":"Metaproperty id.","example":"00000000-0000-0000-0000000000000000","type":"string"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"example-1":{"value":{"message":"Created","statuscode":201}}}}},"description":"Created"},"400":{"content":{"application/json":{"examples":{"example-1":{"value":{"message":"Invalid metaproperty type","statuscode":400}}}}},"description":"Invalid metaproperty type"},"404":{"content":{"application/json":{"examples":{"example-1":{"value":{"message":"Metaproperty not found","statuscode":404}}}}},"description":"Metaproperty not found"}},"summary":"Modify metaproperty","tags":["Metaproperties - Old API (Please use new API if possible)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Metaproperties - Old API (Please use new API if possible)"}]}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-metaproperties.md","page_updatedAt":"2026-05-11T07:21:24.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty","version":"1.0"},"openapi":"3.1.0","paths":{"/api/v4/metaproperties":{"post":{"description":"Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.","requestBody":{"content":{"application/x-www-form-urlencoded":{"examples":{"example-1":{"value":{"data":"{\"name\": \"ColourMeta\", \"type\": \"select\", \"label\": \"Colour\", \"labels\": {\"fr_FR\": \"foo\", \"en_US\": \"foo\"}, \"zindex\": 4, \"isEditable\": true, \"isFilterable\": true, \"isMainfilter\": true, \"isMultiselect\": true, \"isRequired\": true, \"isMultifilter\": true, \"isDrilldown\": true, \"isDisplayField\": true, \"isApiField\": true}"}}},"schema":{"properties":{"data":{"description":"JSON-serialised string","example":"{\n  \"name\": \"ColourMeta\",\n  \"type\": \"select\",\n  \"label\": \"Colour\",\n  \"labels\": {\"fr_FR\": \"foo\", \"en_US\": \"foo\"},\n  \"zindex\": 4,\n  \"isEditable\": true,\n  \"isFilterable\": true,\n  \"isMainfilter\": true,\n  \"isMultiselect\": true,\n  \"isRequired\": true,\n  \"isMultifilter\": true,\n  \"isDrilldown\": true,\n  \"isDisplayField\": true,\n  \"isApiField\": true\n}\n","type":"string"}},"type":"object"}}}},"responses":{"201":{"content":{"application/json":{"examples":{"example-1":{"value":{"id":"00000000-0000-0000-0000000000000000","message":"Created","statuscode":201}}}}},"description":"Created"},"400":{"content":{"application/json":{"examples":{"example-1":{"value":{"message":"Invalid metaproperty type","statuscode":400}}}}},"description":"Invalid metaproperty type"}},"summary":"Create metaproperty","tags":["Metaproperties - Old API (Please use new API if possible)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Metaproperties - Old API (Please use new API if possible)"}]}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-tags-id-media.md","page_updatedAt":"2026-01-07T10:53:22.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Tags API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Tags","description":""}],"paths":{"/api/v4/tags/{id}/media":{"post":{"summary":"Add tag to assets","description":"Add a tag to a list of assets.","tags":["Tags"],"security":[{"OAuth2":["MEDIAEDIT","MEDIAAUDIT"]},{"permanentToken":["MEDIAEDIT","MEDIAAUDIT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000000000000000"}}}}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Accepted"},"statuscode":{"type":"integer","example":202}}}}}},"404":{"description":"Media not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Media 00000000-0000-0000-0000000000000000 not found"},"statuscode":{"type":"integer","example":404}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"MEDIAEDIT":"","MEDIAAUDIT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"MEDIAEDIT":"","MEDIAAUDIT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-users-id.md","page_updatedAt":"2026-01-06T13:41:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Users","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Users ID","description":"Manage specific users by their ID. This includes retrieving, updating, and deleting user information based on the user ID.\n"}],"paths":{"/api/v4/users/{id}":{"post":{"summary":"Modify user","tags":["Users ID"],"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"The id of the user you’d like to modify."}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"},"email":{"type":"string"},"profileId":{"type":"string"},"active":{"type":"integer","enum":[1,0],"default":1},"isSSOOnly":{"type":"boolean","default":false},"language":{"type":"string"},"firstname":{"type":"string"},"infix":{"type":"string"},"lastname":{"type":"string"},"groupIds":{"type":"string"},"phoneNumber":{"type":"string"},"companyName":{"type":"string"},"department":{"type":"string"},"job":{"type":"string"},"costCenter":{"type":"string"},"termsAccepted":{"type":"boolean"}}}}}},"responses":{"202":{"description":"User modified","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"Grants permission to manage users"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"Grants permission to manage users"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-v4-users.md","page_updatedAt":"2026-01-06T13:41:54.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Users","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Users","description":"Manage users within your Bynder account. You can create, retrieve, update, and delete users as needed.\n"}],"paths":{"/api/v4/users/":{"post":{"summary":"Create user","tags":["Users"],"security":[{"permanentToken":["USERMANAGEMENT"]},{"OAuth2":["USERMANAGEMENT"]}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/User"}}}},"responses":{"201":{"description":"User created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"}}}}}}}}}},"components":{"schemas":{"User":{"properties":{"username":{"type":"string"},"password":{"type":"string"},"email":{"type":"string"},"profileId":{"type":"string"},"active":{"type":"integer","enum":[1,0],"default":1},"isSSOOnly":{"type":"boolean","default":false},"language":{"type":"string"},"firstname":{"type":"string"},"infix":{"type":"string"},"lastname":{"type":"string"},"groupIds":{"type":"string"},"phoneNumber":{"type":"string"},"companyName":{"type":"string"},"department":{"type":"string"},"job":{"type":"string"},"costCenter":{"type":"string"}},"required":["password","email","profileId","firstname","lastname"]}},"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"Grants permission to manage users"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"Grants permission to manage users"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-workflow-campaigns.md","page_updatedAt":"2026-01-07T16:02:10.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Campaigns API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Campaigns","description":""}],"paths":{"/api/workflow/campaigns":{"post":{"summary":"Create campaign","description":"Requires the CAMPAIGNADD security role.","tags":["Campaigns"],"security":[{"OAuth2":["CAMPAIGNADD"]},{"permanentToken":["CAMPAIGNADD"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Example campaign"},"key":{"type":"string","example":"excp"},"description":{"type":"string","example":"Campaign example"},"dateStart":{"type":"string","format":"date","example":"2015-01-01T00:00:00"},"deadline":{"type":"string","format":"date","example":"2015-09-04T00:00:00"},"closed":{"type":"boolean","example":false},"responsibleID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"campaignMetaproperties":{"type":"object","additionalProperties":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}},"responses":{"201":{"description":"Campaign created successfully","headers":{"Location":{"description":"URL of the created campaign","schema":{"type":"string","example":"https://your-bynder-domain/api/workflow/campaigns/00000000-0000-0000-0000-000000000000/"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"00000000000000000000000000000000"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"CAMPAIGNOVERVIEW":"","CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"CAMPAIGNOVERVIEW":"","CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-workflow-groups.md","page_updatedAt":"2026-01-07T15:22:03.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Users and Groups API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Groups","description":""}],"paths":{"/api/workflow/groups/":{"post":{"summary":"Create group","tags":["Groups"],"security":[{"permanentToken":["GROUPOVERVIEW","WORKFLOWADMIN"]},{"OAuth2":["GROUPOVERVIEW","WORKFLOWADMIN"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"new name"},"user_ids":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}},"responses":{"200":{"description":"Group created","content":{"application/json":{"schema":{"type":"object"}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-workflow-jobs-id-upload.md","page_updatedAt":"2026-05-15T13:17:34.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Jobs API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"File upload","description":""}],"paths":{"/api/workflow-jobs/{id}/upload":{"post":{"summary":"Upload a file to a workflow job","description":"To upload a file to a workflow job it needs to be uploaded via the Upload file endpoint for modern stack. After completing the various steps described in the Upload file endpoint, the `fileId` retrieved from those steps is needed in this request to reference the file to the job. This file will be attached to the job only.\n**Warning:** Requires the **JOBEDIT** security role.\n**Warning:** Is only available for Files-Service portals.\n","tags":["File upload"],"parameters":[{"name":"id","in":"path","required":true,"description":"The id of a Job.","schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileId":{"type":"string","description":"Id of the file to be saved to the job (to be retrieved from Upload file endpoint)","example":"00000000-0000-0000-0000-000000000001"},"name":{"type":"string","description":"Value to be used as filename","example":"example-name.jpg"},"fileSize":{"type":"number","description":"Size of the file in bytes","example":50000},"assetId":{"type":"string","description":"Id of the parent asset if this file is a new version of an asset","example":"00000000-0000-0000-0000-000000000002"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"mediaId":{"type":"string","description":"Media ID of the uploaded file","example":"00000000000000000000000000000000"}}}}}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_api-workflow-jobs.md","page_updatedAt":"2026-05-15T13:16:00.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Jobs API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Jobs","description":""}],"paths":{"/api/workflow/jobs":{"post":{"summary":"Create job","description":"Requires the JOBADD security role.","tags":["Jobs"],"security":[{"permanentToken":["JOBADD"]},{"OAuth2":["JOBADD"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the job","example":"Job Example"},"description":{"type":"string","description":"Description of the job","example":"Job Description"},"deadline":{"type":"string","description":"Date of when the job ends","example":"2018-09-29"},"campaignID":{"type":"string","description":"Id of the campaign the job is part of","example":"00000000-0000-0000-0000-000000000000"},"accountableID":{"type":"string","description":"Id of the user responsible for the job","example":"00000000-0000-0000-0000-000000000000"},"presetID":{"type":"string","description":"Id of the preset the job should be created from","example":"00000000-0000-0000-0000-000000000000"},"jobMetaproperties":{"type":"object","description":"ID and metaproperty values","additionalProperties":{"type":"string"},"example":{"00000000-0000-0000-0000-000000000000":"00000000-0000-0000-0000-000000000000"}},"stages":{"type":"array","items":{"type":"object","properties":{"preset_stage_id":{"type":"string","description":"Id of the preset stage","example":"00000000-0000-0000-0000-000000000000"},"name":{"type":"string","description":"Name of the stage","example":"Review"},"description":{"type":"string","description":"Description of the stage","example":"Awesome description"},"responsibleGroupID":{"type":"string","description":"Id of responsible group for the stage","example":"00000000-0000-0000-0000-000000000000"},"responsibleID":{"type":"string","description":"Id of the stage responsible","example":"00000000-0000-0000-0000-000000000000"},"deadline":{"type":"string","description":"Deadline date of stage","example":"2018-09-29"}}}}}}}}},"responses":{"201":{"description":"Job created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"Created"},"job_id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}},"examples":{"example-1":{"value":{"status":"Created","job_id":"00000000-0000-0000-0000-000000000000"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_v6-authentication-oauth2-token-authorization.md","page_updatedAt":"2026-03-05T14:32:48.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"OAuth 2.0","version":"1.0.0"},"tags":[{"name":"Token endpoint","description":"Use the token endpoint to retrieve a access token which can be used to authorize API\nrequests. Depending on the type of grant, different fields are required which are\noutlined per request.\n\n_The token endpoint requires authorization either in the body or by\nsending the Authorization header._\n"}],"paths":{"/v6/authentication/oauth2/token{authorization}":{"post":{"summary":"Using an authorization code","description":"Use the token endpoint to retrieve an access token which can be used to authorize API\nrequests. This endpoint supports the Authorization Code grant, the Refresh Token grant and the Client Credentials grant.\n","tags":["Token endpoint"],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"client_id":{"type":"string","description":"Application client ID.","example":"00000000-0000-0000-0000-000000000000"},"client_secret":{"type":"string","description":"Application client secret.","example":"00000000-0000-0000-0000-000000000000"},"grant_type":{"type":"string","description":"Identifies the grant type being used. For Authorization Code grant use **authorization_code**.","example":["authorization_code","refresh_token","client_credentials"]},"redirect_uri":{"type":"string","description":"The URL specified in the Authorize application request, the values must match.","example":"https://localhost/callback"},"code":{"type":"string","description":"The Authorization Code returned from the Authorize application request.","example":"6440327e7ddb660435e377a17a5463ba"},"scope":{"type":"string","description":"List of scopes to request to be granted to the access token. Can only be a subset of the scopes requested in the Authorize application request. When not passed, all the scopes will be requested.","example":"offline asset:read"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"refresh_token":{"type":"string","example":"c12e...b5dc"},"token_type":{"type":"string","example":"bearer"},"expires_in":{"type":"integer","example":3600},"access_token":{"type":"string","example":"eyJh...NDcw"},"scope":{"type":"string","example":"offline asset:read"}}},"examples":{"example-1":{"value":{"token_type":"bearer","expires_in":3600,"access_token":"eyJh...NDcw","scope":"offline asset:read"}}}}}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_v6-authentication-oauth2-token-client-credentials.md","page_updatedAt":"2026-03-05T14:33:18.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"OAuth 2.0","version":"1.0.0"},"tags":[{"name":"Token endpoint","description":"Use the token endpoint to retrieve a access token which can be used to authorize API\nrequests. Depending on the type of grant, different fields are required which are\noutlined per request.\n\n_The token endpoint requires authorization either in the body or by\nsending the Authorization header._\n"}],"paths":{"/v6/authentication/oauth2/token{client_credentials}":{"post":{"summary":"Using client credentials","description":"Use the token endpoint to retrieve an access token which can be used to authorize API\nrequests. This endpoint supports the Authorization Code grant, the Refresh Token grant and the Client Credentials grant.\n","tags":["Token endpoint"],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"client_id":{"type":"string","description":"Application client ID.","example":"00000000-0000-0000-0000-000000000000"},"client_secret":{"type":"string","description":"Application client secret.","example":"00000000-0000-0000-0000-000000000000"},"grant_type":{"type":"string","description":"Identifies the grant type being used. For Authorization Code grant use **authorization_code**.","example":["authorization_code","refresh_token","client_credentials"]},"scope":{"type":"string","description":"List of scopes to request to be granted to the access token. Can only be a subset of the scopes requested in the Authorize application request. When not passed, all the scopes will be requested.","example":"offline asset:read"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"refresh_token":{"type":"string","example":"c12e...b5dc"},"token_type":{"type":"string","example":"bearer"},"expires_in":{"type":"integer","example":3600},"access_token":{"type":"string","example":"eyJh...NDcw"},"scope":{"type":"string","example":"offline asset:read"}}},"examples":{"example-1":{"value":{"token_type":"bearer","expires_in":3600,"access_token":"eyJh...NDcw","scope":"offline asset:read"}}}}}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_v6-authentication-oauth2-token-refresh.md","page_updatedAt":"2026-03-05T14:29:50.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"OAuth 2.0","version":"1.0.0"},"tags":[{"name":"Token endpoint","description":"Use the token endpoint to retrieve a access token which can be used to authorize API\nrequests. Depending on the type of grant, different fields are required which are\noutlined per request.\n\n_The token endpoint requires authorization either in the body or by\nsending the Authorization header._\n"}],"paths":{"/v6/authentication/oauth2/token{refresh}":{"post":{"summary":"Using a refresh token","description":"Use the token endpoint to retrieve an access token which can be used to authorize API\nrequests. This endpoint supports the Authorization Code grant, the Refresh Token grant and the Client Credentials grant.\n","tags":["Token endpoint"],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"client_id":{"type":"string","description":"Application client ID.","example":"00000000-0000-0000-0000-000000000000"},"client_secret":{"type":"string","description":"Application client secret.","example":"00000000-0000-0000-0000-000000000000"},"grant_type":{"type":"string","description":"Identifies the grant type being used. For Authorization Code grant use **authorization_code**.","example":["authorization_code","refresh_token","client_credentials"]},"refresh_token":{"type":"string","description":"Refresh token returned from the Retrieve token request.","example":"c11e...b5bc"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"refresh_token":{"type":"string","example":"c12e...b5dc"},"token_type":{"type":"string","example":"bearer"},"expires_in":{"type":"integer","example":3600},"access_token":{"type":"string","example":"eyJh...NDcw"},"scope":{"type":"string","example":"offline asset:read"}}},"examples":{"example-1":{"value":{"token_type":"bearer","expires_in":3600,"access_token":"eyJh...NDcw","scope":"offline asset:read"}}}}}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_v7-file-cmds-upload-file-id-chunk-chunk-number.md","page_updatedAt":"2026-05-11T07:29:16.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Modern Stack File Upload","version":"1.0.0"},"tags":[{"name":"Step 2","description":"This endpoint uploads a chunk of the file. You need to provide the file ID obtained from the prepare upload step and the chunk number (starting from 0). The request body should contain the binary data of the chunk being uploaded.\n"}],"servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"example.com","description":"Your Bynder domain."}}}],"security":[{"permanentToken":[]},{"OAuth2":[]}],"paths":{"/v7/file_cmds/upload/{file_id}/chunk/{chunk_number}":{"post":{"summary":"Upload a file chunk","description":"Upload a chunk of the file.","tags":["Step 2"],"parameters":[{"name":"file_id","in":"path","required":true,"description":"The file ID retrieved from the prepare upload step.","schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}},{"name":"chunk_number","in":"path","required":true,"description":"The number of the chunk being uploaded. The first chunk is 0.","schema":{"type":"integer","example":0}},{"name":"Content-Type","in":"header","required":true,"schema":{"type":"enum","enum":["application/octet-stream"]}},{"name":"Content-SHA256","in":"header","description":"(calculated checksum of the file/ chunk)","required":true,"schema":{"type":"string","example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"}}],"requestBody":{"required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"201":{"description":"Chunk uploaded successfully"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_v7-file-cmds-upload-file-id-finalise-api.md","page_updatedAt":"2026-05-11T07:29:16.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Modern Stack File Upload","version":"1.0.0"},"tags":[{"name":"Step 3","description":"This endpoint finalizes the upload after all chunks have been uploaded. You need to provide the file ID and details about the file, including its name, size, and the number of chunks it was split into.\n"}],"servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"example.com","description":"Your Bynder domain."}}}],"security":[{"permanentToken":[]},{"OAuth2":[]}],"paths":{"/v7/file_cmds/upload/{file_id}/finalise_api":{"post":{"summary":"Finalize the upload","description":"Finalize the upload after all chunks have been uploaded.","tags":["Step 3"],"parameters":[{"name":"file_id","in":"path","required":true,"description":"The file ID retrieved from the prepare upload step.","schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"fileName":{"type":"string","description":"Filename of the file.","example":"image.jpeg"},"fileSize":{"type":"integer","description":"Size of the file in bytes.","example":63973541},"chunksCount":{"type":"integer","description":"Number of chunks the file was split into.","example":1}}}}}},"responses":{"201":{"description":"Upload finalized successfully"},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_v7-file-cmds-upload-prepare.md","page_updatedAt":"2026-05-11T07:29:16.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Modern Stack File Upload","version":"1.0.0"},"tags":[{"name":"Step 1","description":"This endpoint prepares the upload of a file in chunks. It returns a file ID that will be used in subsequent steps to upload the file chunks and finalize the upload.\n"}],"servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"example.com","description":"Your Bynder domain."}}}],"security":[{"permanentToken":[]},{"OAuth2":[]}],"paths":{"/v7/file_cmds/upload/prepare":{"post":{"summary":"Prepare the upload","description":"Prepare the upload of a file in chunks.","tags":["Step 1"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"file_id":{"type":"string","description":"File ID to be used in subsequent upload steps.","example":"00000000-0000-0000-0000-000000000000"}}}}}},"400":{"description":"Bad request"}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{}}}}}}}}
{"source_url":"https://api.bynder.com/reference/post_v7-quarantine-v1-antivirus-audit.md","page_updatedAt":"2026-01-09T13:57:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Antivirus API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Quarantine","description":""}],"paths":{"/v7/quarantine/v1/antivirus-audit":{"post":{"summary":"Update review status by list of asset Ids","tags":["Quarantine"],"security":[{"OAuth2":["Audit quarantined assets"]},{"permanentToken":["Audit quarantined assets"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"antivirus_asset_ids":{"type":"array","items":{"type":"string","example":"ac93e443-e4d5-442f-966b-b6f24c025c71"}},"review_status":{"type":"string","enum":["APPROVED","DENIED"],"example":"DENIED"}}}}}}}},"responses":{"200":{"description":"Review status updated","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object"}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"Audit quarantined assets":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"Audit quarantined assets":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/postapi1assetassets.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AdvancedRights":{"properties":{"isDownloadable":{"type":"boolean"},"isPublic":{"type":"boolean"}},"title":"AdvancedRights","type":"object"},"Asset":{"properties":{"activeVersion":{"$ref":"#/components/schemas/VersionReference"},"advancedRights":{"$ref":"#/components/schemas/AdvancedRights"},"assetId":{"type":"string"},"assetStatus":{"type":"string"},"copyright":{"type":"string"},"description":{"type":"string"},"embargos":{"items":{"$ref":"#/components/schemas/AssetEmbargo"},"type":"array"},"moduleCode":{"$ref":"#/components/schemas/AssetModuleCode"},"name":{"type":"string"},"origin":{"type":"string"},"portalId":{"type":"string"},"timeStampCreated":{"format":"date-time","type":"string"},"timeStampModified":{"format":"date-time","type":"string"},"timeStampPublished":{"format":"date-time","type":"string"},"userCreatedId":{"type":"string"},"userModifiedId":{"type":"string"}},"title":"Asset","type":"object"},"AssetEmbargo":{"properties":{"embargoId":{"type":"string"},"embargoType":{"$ref":"#/components/schemas/AssetEmbargoType"},"timestampEnd":{"format":"date-time","type":"string"},"timestampStart":{"format":"date-time","type":"string"}},"title":"AssetEmbargo","type":"object"},"AssetEmbargoType":{"enum":["archive","limited","watermark"],"title":"AssetEmbargoType","type":"string"},"AssetModuleCode":{"enum":["BG","BS","IB","WF"],"title":"AssetModuleCode","type":"string"},"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateAssetInput":{"properties":{"copyright":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"origin":{"type":"string"},"timeStampPublished":{"format":"date-time","type":"string"}},"title":"CreateAssetInput","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"},"VersionReference":{"properties":{"timeStampCreated":{"format":"date-time","type":"string"},"versionId":{"type":"string"}},"title":"VersionReference","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets":{"post":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Creates an empty container, this is the first step to start the file upload and any asset enrichment.","operationId":"postApi1AssetAssets","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssetInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Create asset","tags":["Asset ingestion"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Create an asset, upload its file in resumable chunks, and publish it. After the file is uploaded you can **enrich the asset** - see the *Asset enrichment* section - before publishing. Retrieval of the asset during ingestion uses **Get asset** in the *General endpoints* section.","name":"Asset ingestion"}]}}
{"source_url":"https://api.bynder.com/reference/postapi1assetassetsassetidembargos.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetEmbargo":{"properties":{"embargoId":{"type":"string"},"embargoType":{"$ref":"#/components/schemas/AssetEmbargoType"},"timestampEnd":{"format":"date-time","type":"string"},"timestampStart":{"format":"date-time","type":"string"}},"title":"AssetEmbargo","type":"object"},"AssetEmbargoType":{"enum":["archive","limited","watermark"],"title":"AssetEmbargoType","type":"string"},"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateAssetEmbargoInput":{"properties":{"embargoTimeStamp":{"format":"date-time","type":"string"},"embargoType":{"$ref":"#/components/schemas/AssetEmbargoType"}},"required":["embargoType"],"title":"CreateAssetEmbargoInput","type":"object"},"CreateAssetEmbargoReply":{"properties":{"assetId":{"type":"string"},"embargo":{"$ref":"#/components/schemas/AssetEmbargo"}},"title":"CreateAssetEmbargoReply","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/embargos":{"post":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Create a new current or future embargo on the asset. There are 3 types of embargo available, 'archive', 'watermark', 'limited'. Of which only 1 can be active at the same time.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"postApi1AssetAssetsAssetidEmbargos","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssetEmbargoInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssetEmbargoReply"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Create embargo","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/postapi1assetassetsassetidpublish.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AdvancedRights":{"properties":{"isDownloadable":{"type":"boolean"},"isPublic":{"type":"boolean"}},"title":"AdvancedRights","type":"object"},"Asset":{"properties":{"activeVersion":{"$ref":"#/components/schemas/VersionReference"},"advancedRights":{"$ref":"#/components/schemas/AdvancedRights"},"assetId":{"type":"string"},"assetStatus":{"type":"string"},"copyright":{"type":"string"},"description":{"type":"string"},"embargos":{"items":{"$ref":"#/components/schemas/AssetEmbargo"},"type":"array"},"moduleCode":{"$ref":"#/components/schemas/AssetModuleCode"},"name":{"type":"string"},"origin":{"type":"string"},"portalId":{"type":"string"},"timeStampCreated":{"format":"date-time","type":"string"},"timeStampModified":{"format":"date-time","type":"string"},"timeStampPublished":{"format":"date-time","type":"string"},"userCreatedId":{"type":"string"},"userModifiedId":{"type":"string"}},"title":"Asset","type":"object"},"AssetEmbargo":{"properties":{"embargoId":{"type":"string"},"embargoType":{"$ref":"#/components/schemas/AssetEmbargoType"},"timestampEnd":{"format":"date-time","type":"string"},"timestampStart":{"format":"date-time","type":"string"}},"title":"AssetEmbargo","type":"object"},"AssetEmbargoType":{"enum":["archive","limited","watermark"],"title":"AssetEmbargoType","type":"string"},"AssetModuleCode":{"enum":["BG","BS","IB","WF"],"title":"AssetModuleCode","type":"string"},"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"PublishAssetInput":{"properties":{"forcePublish":{"default":false,"description":"When true, forces publication of the asset even if non-blocking validation warnings are present. Defaults to false.","type":"boolean"}},"title":"PublishAssetInput","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"},"VersionReference":{"properties":{"timeStampCreated":{"format":"date-time","type":"string"},"versionId":{"type":"string"}},"title":"VersionReference","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/publish":{"post":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Once the file is fully enriched and ready it can be published. Depending on the profile permissions of the user, the asset will go directly to the asset bank (upload assets) or to the waiting room (upload assets with mandatory approval)","operationId":"postApi1AssetAssetsAssetidPublish","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishAssetInput"}}},"description":"Optional publish options. If omitted, the asset is published with default settings (forcePublish = false).","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Asset"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Publish","tags":["Asset ingestion"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Create an asset, upload its file in resumable chunks, and publish it. After the file is uploaded you can **enrich the asset** - see the *Asset enrichment* section - before publishing. Retrieval of the asset during ingestion uses **Get asset** in the *General endpoints* section.","name":"Asset ingestion"}]}}
{"source_url":"https://api.bynder.com/reference/postapi1assetassetsassetidrelationsrelationid.md","page_updatedAt":"2026-08-13T14:57:10.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AddAssetRelationInput":{"properties":{"relatedAssetIds":{"items":{"type":"string"},"type":"array"}},"title":"AddAssetRelationInput","type":"object"},"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateAssetRelationReply":{"properties":{"assetId":{"type":"string"},"portalId":{"type":"string"},"relatedAssetIds":{"items":{"type":"string"},"type":"array"},"relationId":{"type":"string"}},"title":"UpdateAssetRelationReply","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/relations/{relationId}":{"post":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Add one or more assets to the set of assets the given asset is related to. The result is a bidirectional relation between the given asset and the assets given as input Note: the recommended maximum amount of Ids to relate is 100 maximum.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"postApi1AssetAssetsAssetidRelationsRelationid","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"relationId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAssetRelationInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetRelationReply"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Add asset relations","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/postapi1assetassetsassetidupload-url.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrl":{"properties":{"storageObjectId":{"type":"string"},"uploadUrl":{"type":"string"}},"title":"UploadUrl","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/upload-url":{"post":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n To start uploading a file as an asset, a signed upload url has to be created, which can be used to start uploading the file. Take the generated assetId from the previous {create Asset} as input in the path.","operationId":"postApi1AssetAssetsAssetidUpload-url","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadUrl"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Create upload url","tags":["Asset ingestion"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Create an asset, upload its file in resumable chunks, and publish it. After the file is uploaded you can **enrich the asset** - see the *Asset enrichment* section - before publishing. Retrieval of the asset during ingestion uses **Get asset** in the *General endpoints* section.","name":"Asset ingestion"}]}}
{"source_url":"https://api.bynder.com/reference/postapi1automationautomations.md","page_updatedAt":"2026-05-11T06:38:26.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automations API","version":"1.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"paths":{"/api/1/automation/automations":{"post":{"tags":["Automations - New taxonomy API"],"summary":"Create automation","description":"Create a new automation. Make sure to use one of the supported bodies listed in the cURL request examples. E.g. ShowOptionAll, DenyDownloads, etc.","operationId":"postApi1AutomationAutomations","parameters":[{"name":"x-api-correlation-id","in":"header","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["actionType","conditionType","actionsOn","triggersOn"],"type":"object","properties":{"actionType":{"type":"string","enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"]},"actionsOn":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"metapropertyId":{"type":"string","format":"uuid"},"optionIds":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"conditionType":{"type":"string","enum":["ALL","ANY","ANY_OPTION"]},"triggerType":{"type":"string","enum":["SELECTED"]},"triggersOn":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"metapropertyId":{"type":"string","format":"uuid"},"optionIds":{"type":"array","items":{"type":"string","format":"uuid"}}}}}}},"examples":{"ShowMetapropertyAnyOption":{"summary":"Show metaproperty based on any trigger options","description":"Show metaproperty based on any option selection. Triggers when any option from the specified trigger metaproperty is selected.","value":{"actionType":"SHOW_METAPROPERTY","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}],"conditionType":"ANY_OPTION","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}]}},"ShowMetapropertySpecificOptions":{"summary":"Show metaproperty based on specific trigger options","description":"Show metaproperty based on specific option selection. Triggers when any of the specified options from the trigger metaproperty are selected.","value":{"actionType":"SHOW_METAPROPERTY","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ShowOptionAny":{"summary":"Show options with any specific options","description":"Show specific options based on trigger option selection. Automation will apply if any of the triggering options is selected.","value":{"actionType":"SHOW_OPTION","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ShowOptionAll":{"summary":"Show options with ALL condition","description":"Show specific options based on multiple trigger option selection. Automation will apply if all the triggering options are selected.","value":{"actionType":"SHOW_OPTION","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}],"conditionType":"ALL","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000001","optionIds":["00000000-0000-0000-0000-000000000001"]},{"metapropertyId":"00000000-0000-0000-0000-000000000002","optionIds":["00000000-0000-0000-0000-000000000002"]}]}},"PrefillMetaproperty":{"summary":"Prefill text metaproperty automation","description":"Automatically fills a text or date metaproperty with a predefined value when specific options are selected. This type of automation can only be used with Text and Date metaproperties. Furthermore, the value must be in the correct format - free text for Text metaproperties and DD/MM/YYYY for Date metaproperties.","value":{"actionType":"PREFILL","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","value":"text_that_should_be_prefilled"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"EmptyMetaproperty":{"summary":"Empty metaproperty automation","description":"Automatically clears the value of a text or date metaproperty when specific conditions are met. This type of automation can only be used with Text and Date metaproperties.","value":{"actionType":"EMPTY","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ApplyWatermark":{"summary":"Apply watermark automation","description":"Automatically apply watermark to assets when specific metaproperty options are selected.","value":{"actionType":"SELECT","actionsOn":[{"value":"watermark"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"DenyDownloads":{"summary":"Deny asset downloads automation","description":"Automatically deny downloading of assets when specific metaproperty options are selected.","value":{"actionType":"DESELECT","actionsOn":[{"value":"watermark"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"MarkAsLimitedUsage":{"summary":"Mark assets as limited usage automation","description":"Automatically mark assets as limited usage when specific metaproperty options are selected.","value":{"actionType":"SELECT","actionsOn":[{"value":"limited"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ArchiveAssets":{"summary":"Archive assets automation","description":"Automatically archive assets when specific metaproperty options are selected.","value":{"actionType":"SELECT","actionsOn":[{"value":"archive"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}}}}},"required":true},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"required":["automationId","message"],"type":"object","properties":{"automationId":{"type":"string","format":"uuid"},"message":{"type":"string"}}},"examples":{"AutomationCreatedOutput":{"summary":"Response when automation was successfully created","value":{"automationId":"00000000-0000-0000-0000-000000000000","message":"The automation has been created"}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}}}}},"examples":{"InvalidAutomationOutput":{"summary":"Response when the input automation is invalid","value":{"errorCode":"validation-failure","errors":[],"message":"The input is invalid"}},"DuplicateAutomationOutput":{"summary":"Response when the automation already exists","value":{"errorCode":"duplicate","message":"The automation already exists"}},"TaxonomyErrorOutput":{"summary":"Response when an error occurred while checking the taxonomy","value":{"errorCode":"taxonomy-error","errors":[],"message":"Errors occurred while checking the taxonomy"}},"ConflictingAllConditionOutput":{"summary":"Response when there will be a conflict if creating an automation with an \"all\" condition","description":"This occurs when an existing automation with an \"any\" condition overlaps with the new automation's triggers.","value":{"errorCode":"condition-all-conflict","message":"Creating an automation with condition \"all\" will create a conflict"}},"ConflictingAnyConditionOutput":{"summary":"Response when there will be a conflict if creating an automation with an \"any\" condition","description":"This occurs when an existing automation with an \"all\" condition overlaps with the new automation's triggers.","value":{"errorCode":"condition-any-conflict","message":"Creating an automation with condition \"any\" will create a conflict"}}}}}},"401":{"description":"","content":{"application/json":{"schema":{"required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}}}}}},"security":[{"httpAuth":[]}]}}},"components":{"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/postapi1taxonomymetaproperties.md","page_updatedAt":"2026-05-11T07:21:24.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty","version":"1.0"},"openapi":"3.1.0","paths":{"/api/1/taxonomy/metaproperties":{"post":{"description":"Create a new metaproperty","operationId":"postApi1TaxonomyMetaproperties","requestBody":{"content":{"application/json":{"schema":{"properties":{"allowDuplicates":{"type":"boolean"},"autocomplete":{"type":"boolean"},"createDuringApply":{"type":"boolean"},"definition":{"type":"string"},"metapropertyType":{"enum":["single-select","multi-select","date","text"],"title":"MetapropertyTypeEnum","type":"string"},"name":{"type":"string"}},"required":["name","metapropertyType"],"title":"MetapropertyInput","type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"CreatedMetaproperty":{"summary":"Response when a metaproperty is successfully created","value":{"allowDuplicates":false,"autocomplete":false,"createDuringApply":false,"id":"00000000-0000-0000-0000-000000000000","metapropertyType":"single-select","name":"Example Metaproperty","status":"created"}}},"schema":{"properties":{"allowDuplicates":{"type":"boolean"},"autocomplete":{"type":"boolean"},"createDuringApply":{"type":"boolean"},"definition":{"type":"string"},"id":{"format":"uuid","type":"string"},"metapropertyType":{"enum":["single-select","multi-select","date","text"],"title":"MetapropertyTypeEnum","type":"string"},"name":{"type":"string"},"status":{"type":"string"}},"title":"MetapropertyCreateOutput","type":"object"}}},"description":""},"400":{"content":{"application/json":{"examples":{"ExistingMetaproperty":{"summary":"Response when a metaproperty with that name already exists","value":{"errorCode":"name-already-registered","message":"Name was already registered for mp: 00000000-0000-0000-0000-000000000000"}},"InvalidMetaproperty":{"summary":"Response when the input is invalid","value":{"errorCode":"validation-errors","errors":[],"message":"Issues found while validating the request"}}},"schema":{"properties":{"errorCode":{"type":"string"},"errors":{"items":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"title":"ErrorMessage","type":"object"},"type":"array"},"message":{"type":"string"}},"title":"MetapropertyCreateInvalidOutput","type":"object"}}},"description":""},"404":{"content":{"application/json":{"examples":{"ConfigurationNotExisting":{"summary":"Response when no default configuration exists","value":{"errorCode":"configuration-not-existing","message":"Configuration does not exist"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"title":"MetapropertyCreateNotFoundOutput","type":"object"}}},"description":""}},"summary":"Create metaproperty","tags":["Metaproperties - New API (Preferred)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Metaproperties - New API (Preferred)"}]}}
{"source_url":"https://api.bynder.com/reference/postapi1taxonomymetapropertiesmetapropertyidoptions.md","page_updatedAt":"2026-05-11T06:38:40.000Z","fetched":"2026-09-30","openapi":{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"METAMANAGEMENT":"","METAPROPERTYMANAGEMENT":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Metaproperty options","version":"1.0"},"openapi":"3.1.0","paths":{"/api/1/taxonomy/metaproperties/{metapropertyId}/options":{"post":{"description":"Create a new option","operationId":"postApi1TaxonomyMetapropertiesMetapropertyidOptions","parameters":[{"in":"path","name":"metapropertyId","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"definition":{"type":"string"},"externalReference":{"type":"string"},"icon":{"type":"string"},"name":{"type":"string"}},"required":["name"],"title":"MetapropertyOptionInput","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"ExistingOptionStreamOutput":{"summary":"Response when the option already exists","value":{"icon":"","id":"00000000-0000-0000-0000-000000000001","name":"Option 1","status":"existing"}}},"schema":{"properties":{"definition":{"type":"string"},"icon":{"type":"string"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"status":{"type":"string"}},"required":["id","name","status","icon"],"title":"ExistingOptionStreamOutput","type":"object"}}},"description":""},"201":{"content":{"application/json":{"examples":{"CreatedOptionStreamOutput":{"summary":"Response when the option is newly created","value":{"externalReference":"ext-ref-1","icon":"","id":"00000000-0000-0000-0000-000000000001","name":"Option 1","status":"created"}}},"schema":{"properties":{"definition":{"type":"string"},"externalReference":{"type":"string"},"icon":{"type":"string"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"status":{"type":"string"}},"required":["externalReference","id","name","status","icon"],"title":"CreatedOptionStreamOutput","type":"object"}}},"description":""},"400":{"content":{"application/json":{"examples":{"CannotCreateOptionOutput":{"summary":"Response when the option cannot be created because of the metaproperty type","value":{"errorCode":"cannot-create-options","message":"Cannot create options for this metaproperty type"}},"InvalidOptionOutput":{"summary":"Response when the option is invalid","value":{"errorCode":"validation-errors","errors":[],"message":"Issues found while validating the request"}}},"schema":{"properties":{"errorCode":{"type":"string"},"errors":{"items":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"title":"ErrorMessage","type":"object"},"type":"array"},"message":{"type":"string"}},"title":"OptionCreateInvalidOutput","type":"object"}}},"description":""},"404":{"content":{"application/json":{"examples":{"MetapropertyNotExisting":{"summary":"Response when the metaproperty does not exist","value":{"errorCode":"metaproperty-not-existing","message":"Metaproperty does not exist"}}},"schema":{"properties":{"errorCode":{"type":"string"},"message":{"type":"string"}},"required":["errorCode","message"],"title":"MetapropertyNotExistingOutput","type":"object"}}},"description":""}},"summary":"Create option","tags":["Options - New API (Preferred)"]}}},"security":[{"OAuth2":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]},{"permanentToken":["METAPROPERTYMANAGEMENT","METAMANAGEMENT"]}],"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Options - New API (Preferred)"}]}}
{"source_url":"https://api.bynder.com/reference/postrules.md","page_updatedAt":"2026-01-27T09:17:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automation Workflow API","version":"1.0.0","description":"\nThis API allows clients to manage automation-workflow rules.\n\n<b>Servers:</b>\n\n1. <b>Local Development:</b>\n   - Base URL: http://localhost:8080/{endpoint}\n\n2. <b>Stage or Production:</b>\n   - Base URL: https://automation-workflow-service.bynder.com/api/1/automation-workflow/{endpoint}\n\nEnsure you're using the correct server depending on the environment you're working in (local or production).\n  "},"servers":[{"url":"https://{your-bynder-domain}/api/1/automation-workflow/"}],"paths":{"/rules":{"post":{"tags":["Automation Workflow Rules"],"summary":"Creates a new automation workflow rule.","description":"\nCreates a new automation workflow rule. Ensure that you check the available triggers, conditions, and actions to use valid options.\n\nUse the following endpoints to check which options are available before creating a rule:\n- `/triggers` – lists available triggers\n- `/conditions` – lists available conditions\n- `/actions` – lists available actions\n        ","operationId":"postRules","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationWorkflowRuleBody"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAutomationWorkflowRuleResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}}}},"security":[{},{"httpAuth":[]}]}}},"components":{"schemas":{"AndCondition":{"title":"AndCondition","type":"object","properties":{"and":{"type":"array","items":{"$ref":"#/components/schemas/LeafCondition"}}}},"ArchiveTerm":{"title":"ArchiveTerm","type":"object","required":["offset_amount","offset_unit"],"properties":{"offset_amount":{"type":"integer","format":"int32"},"offset_unit":{"type":"string"}}},"AssetTypeTerm":{"title":"AssetTypeTerm","type":"object","required":["asset_type"],"properties":{"asset_type":{"type":"string"}}},"AutomationWorkflowRuleBody":{"title":"AutomationWorkflowRuleBody","type":"object","required":["name"],"properties":{"name":{"type":"string"},"triggers":{"type":"array","items":{"type":"string"}},"steps":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowStep"}}}},"AutomationWorkflowStep":{"title":"AutomationWorkflowStep","type":"object","properties":{"step_triggers":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowStepActionBase"}},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/AndCondition"}}}},"AutomationWorkflowStepActionAgent":{"title":"AutomationWorkflowStepActionAgent","type":"object","required":["action_type","data"],"properties":{"action_type":{"type":"string"},"data":{"$ref":"#/components/schemas/StepActionAgentData"},"is_valid":{"type":"boolean"}}},"AutomationWorkflowStepActionBase":{"title":"AutomationWorkflowStepActionBase","oneOf":[{"$ref":"#/components/schemas/AutomationWorkflowStepActionAgent"},{"$ref":"#/components/schemas/AutomationWorkflowStepAddToCollectionAction"}]},"AutomationWorkflowStepAddToCollectionAction":{"title":"AutomationWorkflowStepAddToCollectionAction","type":"object","required":["action_type","data"],"properties":{"action_type":{"type":"string"},"data":{"$ref":"#/components/schemas/StepAddToCollectionActionData"},"is_valid":{"type":"boolean"}}},"CreateAutomationWorkflowRuleResponse":{"title":"CreateAutomationWorkflowRuleResponse","type":"object","required":["id","status","name","account_id","created_by_id","date_created","date_modified"],"properties":{"id":{"type":"string"},"status":{"type":"string"},"name":{"type":"string"},"account_id":{"type":"string"},"created_by_id":{"type":"string"},"edited_by_id":{"type":"string"},"date_created":{"type":"string"},"date_modified":{"type":"string"}}},"ErrorAuthorizationResponse":{"title":"ErrorAuthorizationResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponse":{"title":"ErrorResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ExpressionCondition":{"title":"ExpressionCondition","type":"object","required":["operator"],"properties":{"term":{"type":"array","items":{"$ref":"#/components/schemas/Term"}},"operator":{"type":"string"}}},"LeafCondition":{"title":"LeafCondition","type":"object","required":["condition_type","expression"],"properties":{"condition_type":{"type":"string"},"expression":{"$ref":"#/components/schemas/ExpressionCondition"},"is_valid":{"type":"boolean"}}},"MetapropertyOptionTerm":{"title":"MetapropertyOptionTerm","type":"object","required":["metaproperty_id"],"properties":{"metaproperty_id":{"type":"string","format":"uuid"},"metaproperty_option_id":{"type":"string","format":"uuid"}}},"StepActionAgentData":{"title":"StepActionAgentData","type":"object","required":["agent_id"],"properties":{"agent_id":{"type":"string"},"run_name":{"type":"string"}}},"StepAddToCollectionActionData":{"title":"StepAddToCollectionActionData","type":"object","required":["collection_id"],"properties":{"collection_id":{"type":"string"}}},"Term":{"title":"Term","oneOf":[{"$ref":"#/components/schemas/ArchiveTerm"},{"$ref":"#/components/schemas/AssetTypeTerm"},{"$ref":"#/components/schemas/MetapropertyOptionTerm"}]}},"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/postuploadurlinitialization.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/":{"post":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n This step actually starts uploading the file. Send this request to the signed `uploadUrl` returned by **Create upload url**. This initializes a resumable (tus) upload. Any file namings have to be base64 encoded/decoded. \nThe response headers - in particular the `Location` header - are required for the next call, **Upload file chunks**. \n> The `{uploadUrl}` path parameter is a placeholder for the signed URL from the previous step.","operationId":"postUploadUrlInitialization","parameters":[{"in":"header","name":"tus-resumable","required":true,"schema":{"default":"1.0.0","type":"string"}},{"description":"Total size of the file to upload, in bytes.","in":"header","name":"upload-length","required":true,"schema":{"type":"string"}},{"description":"Comma-separated `key <base64-value>` pairs, e.g. `filename ZXhhbXBsZS5wbmc=`.","in":"header","name":"upload-metadata","required":true,"schema":{"contentEncoding":"base64","type":"string"}},{"in":"header","name":"fileid","required":true,"schema":{"type":"string"}},{"in":"header","name":"filename","required":true,"schema":{"type":"string"}},{"in":"header","name":"authorization","required":true,"schema":{"type":"string"}},{"in":"header","name":"content-length","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Upload initialized. Use the returned Location header for the chunk uploads.","headers":{"Content-Length":{"schema":{"type":"integer"}},"Tus-Resumable":{"schema":{"type":"string"}},"Upload-Chunk-Size":{"schema":{"type":"integer"}},"X-Content-Type-Options":{"schema":{"type":"string"}},"location":{"description":"URL to send the file chunks to (used by Upload file chunks).","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""}},"security":[{"httpAuth":[]}],"servers":[{"description":"Dynamic Tus upload server returned in the previous step.","url":"{uploadUrl}","variables":{"baseUploadUrl":{"default":"{your-dynamic-upload-url}"}}}],"summary":"Upload file initialization","tags":["Asset ingestion"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Create an asset, upload its file in resumable chunks, and publish it. After the file is uploaded you can **enrich the asset** - see the *Asset enrichment* section - before publishing. Retrieval of the asset during ingestion uses **Get asset** in the *General endpoints* section.","name":"Asset ingestion"}]}}
{"source_url":"https://api.bynder.com/reference/put_api-1-content-access-options-optionid-visibility.md","page_updatedAt":"2026-07-13T13:25:20.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Access Rights and Options API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}}],"paths":{"/api/1/content-access/options/{optionId}/visibility":{"put":{"summary":"Modify Option Default Visibility","tags":["Options"],"parameters":[{"name":"optionId","in":"path","required":true,"schema":{"type":"string"},"description":"Option ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"defaultVisibility":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"defaultVisibility":{"type":"boolean"}}}}}},"403":{"description":"Forbidden"}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://DefaultParameterValue/","tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}}}}}},"security":[{"OAuth2":[]},{"permanentToken":[]}],"tags":[{"name":"Options","description":""}]}}
{"source_url":"https://api.bynder.com/reference/put_api-1-content-access-options-optionid.md","page_updatedAt":"2026-01-21T16:37:01.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Access Rights and Options API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}}],"paths":{"/api/1/content-access/options/{optionId}":{"put":{"summary":"Modify Option Access Rights","tags":["Options"],"parameters":[{"name":"optionId","in":"path","required":true,"schema":{"type":"string"},"description":"Option ID"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesResponse1"}}}}},"403":{"description":"Forbidden"}}}}},"components":{"schemas":{"ApiContentAccessMetapropertiesRequest":{"title":"ApiContentAccessMetapropertiesRequest","type":"object","properties":{"principals":{"type":"array","items":{"$ref":"#/components/schemas/Principal"},"description":""},"level":{"$ref":"#/components/schemas/Level"}}},"Principal":{"title":"Principal","type":"object","properties":{"principalId":{"type":"string","examples":["00000000-0000-0000-0000000000000000"]},"principalType":{"$ref":"#/components/schemas/PrincipalType"}}},"PrincipalType":{"title":"PrincipalType","enum":["user","group","profile"],"type":"string","examples":["user"]},"Level":{"title":"Level","const":"metaproperty.hide","type":"string","examples":["metaproperty.hide"]},"ApiContentAccessMetapropertiesResponse1":{"title":"ApiContentAccessMetapropertiesResponse1","type":"object","properties":{"principalId":{"type":"string","examples":["00000000-0000-0000-0000-000000000000"]},"principalType":{"type":"string","examples":["user"]}}}},"securitySchemes":{"permanentToken":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://DefaultParameterValue/","tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}}}}}},"security":[{"OAuth2":[]},{"permanentToken":[]}],"tags":[{"name":"Options","description":""}]}}
{"source_url":"https://api.bynder.com/reference/put_api-pim-metapropertyoptions-id.md","page_updatedAt":"2026-01-07T16:10:48.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Product Layer Metaproperties API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Options","description":""}],"paths":{"/api/pim/metapropertyoptions/{id}":{"put":{"summary":"Modify metaproperty option","description":"Edit the children of a metaproperty option.","tags":["Options"],"security":[{"OAuth2":[]},{"permanentToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-0000000000000000"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"children":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}},"responses":{"204":{"description":"Metaproperty option modified successfully"}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"metaproperty.view":"","METAPROPERTYMANAGEMENT":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"metaproperty.view":"","METAPROPERTYMANAGEMENT":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/put_api-workflow-campaigns-id.md","page_updatedAt":"2026-01-07T16:02:10.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Campaigns API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Campaigns","description":""}],"paths":{"/api/workflow/campaigns/{id}":{"put":{"summary":"Modify campaign","description":"Requires the CAMPAIGNEDIT security role.","tags":["Campaigns"],"security":[{"OAuth2":["CAMPAIGNEDIT"]},{"permanentToken":["CAMPAIGNEDIT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Example campaign"},"key":{"type":"string","example":"excp"},"description":{"type":"string","example":"Campaign for managing examples"},"dateStart":{"type":"string","format":"date","example":"2015-01-01T00:00:00"},"deadline":{"type":"string","format":"date","example":"2015-09-04T00:00:00"},"closed":{"type":"boolean","example":false},"responsibleID":{"type":"string","example":"00000000-0000-0000-0000-000000000000"},"campaignMetaproperties":{"type":"object","additionalProperties":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}},"responses":{"201":{"description":"Campaign modified successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"00000000000000000000000000000000"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"CAMPAIGNOVERVIEW":"","CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"CAMPAIGNOVERVIEW":"","CAMPAIGNADD":"","CAMPAIGNEDIT":"","CAMPAIGNREMOVE":"","CAMPAIGNWRITE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/put_api-workflow-groups-id.md","page_updatedAt":"2026-01-07T15:22:03.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Users and Groups API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Groups","description":""}],"paths":{"/api/workflow/groups/{id}":{"put":{"summary":"Modify group","tags":["Groups"],"security":[{"permanentToken":["GROUPOVERVIEW","WORKFLOWADMIN"]},{"OAuth2":["GROUPOVERVIEW","WORKFLOWADMIN"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"new name"},"user_ids":{"type":"array","items":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}}}}}},"responses":{"200":{"description":"Group modified","content":{"application/json":{"schema":{"type":"object"}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"USERMANAGEMENT":"","GROUPOVERVIEW":"","WORKFLOWADMIN":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/put_api-workflow-jobs-id.md","page_updatedAt":"2026-05-15T13:16:00.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Jobs API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Jobs","description":""}],"paths":{"/api/workflow/jobs/{id}":{"put":{"summary":"Modify job","description":"Requires the JOBEDIT security role. Note: `responsibleID` and `responsibleGroupID` cannot be set on `previousStage`, `activeStage`, or `nextStage` through this endpoint. To update a stage's responsible user or group, use `PUT /api/workflow/stages/{id}`.","tags":["Jobs"],"security":[{"permanentToken":["JOBEDIT"]},{"OAuth2":["JOBEDIT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"00000000-0000-0000-0000-000000000000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the job","example":"Job Example"},"description":{"type":"string","description":"Description of the job","example":"Job Description"},"deadline":{"type":"string","description":"Date of when the job ends","example":"2018-09-29"},"campaignID":{"type":"string","description":"Id of the campaign the job is part of","example":"00000000-0000-0000-0000-000000000000"},"accountableID":{"type":"string","description":"Id of the user accountable for the job (displayed as Reporter in the UI). This does not update a stage's responsible user or group; use PUT /api/workflow/stages/{id} for that.","example":"00000000-0000-0000-0000-000000000000"},"jobMetaproperties":{"type":"object","description":"ID and metaproperty values","additionalProperties":{"type":"string"},"example":{"00000000-0000-0000-0000-000000000000":"00000000-0000-0000-0000-000000000000"}},"activeStage":{"type":"object","description":"The new active stage of the job","properties":{"id":{"type":"string","description":"ID of the new active stage","example":"00000000-0000-0000-0000-000000000002"},"deadline":{"type":"string","description":"Date of when the active stage ends","example":"2024-08-31T00:00:00+00:00"},"status":{"type":"string","description":"Status of the new active stage","enum":["Idle","Active","Cancelled","Approved","NeedsChanges"],"example":"Active"}}},"nextStage":{"type":"object","description":"The new next stage of the job","properties":{"id":{"type":"string","description":"ID of the new next stage","example":"00000000-0000-0000-0000-000000000003"},"deadline":{"type":"string","description":"Date of when the next stage ends","example":"2024-08-31T00:00:00+00:00"},"status":{"type":"string","description":"Status of the new next stage","enum":["Idle","Active","Cancelled","Approved","NeedsChanges"],"example":"Idle"}}},"previousStage":{"type":"object","description":"The new previous stage of the job","properties":{"id":{"type":"string","description":"ID of the new previous stage","example":"00000000-0000-0000-0000-000000000001"},"deadline":{"type":"string","description":"Date of when the previous stage ends","example":null},"status":{"type":"string","description":"Status of the new previous stage","enum":["Idle","Active","Cancelled","Approved","NeedsChanges"],"example":"Approved"}}}}},"examples":{"example-1":{"value":{"name":"Job Example","description":"Job Description","deadline":"2018-09-29","campaignID":"00000000-0000-0000-0000-000000000000","accountableID":"00000000-0000-0000-0000-000000000000","jobMetaproperties":{"00000000-0000-0000-0000-000000000000":"00000000-0000-0000-0000-000000000000"},"nextStage":{"status":"Idle","id":"00000000-0000-0000-0000-000000000003","deadline":"2024-08-31T00:00:00+00:00"},"activeStage":{"status":"Active","id":"00000000-0000-0000-0000-000000000002"},"previousStage":{"status":"Approved","id":"00000000-0000-0000-0000-000000000001","deadline":null}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"Updated"},"job_id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}},"examples":{"example-1":{"value":{"status":"Updated","job_id":"00000000-0000-0000-0000-000000000000"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/put_api-workflow-stages-id.md","page_updatedAt":"2026-07-20T09:43:51.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Workflow Jobs API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Stages","description":""}],"paths":{"/api/workflow/stages/{id}":{"put":{"summary":"Update stage","description":"Requires the JOBEDIT security role. Updates a workflow stage, including the user or group responsible for it (displayed as Responsible in the UI).","tags":["Stages"],"security":[{"permanentToken":["JOBEDIT"]},{"OAuth2":["JOBEDIT"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"example":"00000000-0000-0000-0000-000000000000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the stage","example":"Stage Example"},"description":{"type":"string","description":"Description of the stage","example":"Stage Description"},"deadline":{"type":"string","description":"Date of when the stage ends. Send null to clear it.","example":"2018-09-29"},"responsible":{"type":"object","description":"The user or group responsible for the stage (displayed as Responsible in the UI).","properties":{"id":{"type":"string","description":"Id of the responsible user or group","example":"00000000-0000-0000-0000-000000000000"},"type":{"type":"string","description":"Whether the id refers to a user or a group","enum":["user","group"],"example":"user"}}}}},"examples":{"example-body":{"value":{"name":"Stage Example","description":"Stage Description","deadline":"2018-09-29","responsible":{"id":"00000000-0000-0000-0000-000000000000","type":"user"}}}}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"Updated"},"stage_id":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}},"examples":{"example-1":{"value":{"status":"Updated","stage_id":"00000000-0000-0000-0000-000000000000"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid responsible user"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"PRESETOVERVIEW":"","JOBOVERVIEW":"","CAMPAIGNOVERVIEW":"","JOBADD":"","JOBEDIT":"","JOBAPPROVE":"","JOBREMOVE":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/put_v7-quarantine-v1-assets-asset-id.md","page_updatedAt":"2026-01-09T13:57:02.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Antivirus API","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"name":"Quarantine","description":""}],"paths":{"/v7/quarantine/v1/assets/{asset_id}":{"put":{"summary":"Update review status by id","tags":["Quarantine"],"security":[{"OAuth2":["Audit quarantined assets"]},{"permanentToken":["Audit quarantined assets"]}],"parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","example":"00000000-0000-0000-0000-000000000000"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"review_status":{"type":"string","enum":["APPROVED","DENIED"],"example":"DENIED"}}}}}}}},"responses":{"200":{"description":"Review status updated","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Asset not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Asset not found"}}}}}}}}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"Audit quarantined assets":""}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"Audit quarantined assets":""}}}}}}}}
{"source_url":"https://api.bynder.com/reference/putapi1assetassetsassetidautotags.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAssetVersionAutoTagsInput":{"properties":{"autoTags":{"items":{"type":"string"},"type":"array"}},"title":"SetAssetVersionAutoTagsInput","type":"object"},"SetAssetVersionAutoTagsReply":{"properties":{"autoTags":{"items":{"type":"string"},"type":"array"}},"title":"SetAssetVersionAutoTagsReply","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/autotags":{"put":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Adjust the autotag values that are set on an asset. The input list can only set values that are already present on the asset to reduce the list of autotags, not to add additional ones.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"putApi1AssetAssetsAssetidAutotags","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetAssetVersionAutoTagsInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetAssetVersionAutoTagsReply"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Set autotags","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/putapi1assetassetsassetidembargosembargoid.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetEmbargo":{"properties":{"embargoId":{"type":"string"},"embargoType":{"$ref":"#/components/schemas/AssetEmbargoType"},"timestampEnd":{"format":"date-time","type":"string"},"timestampStart":{"format":"date-time","type":"string"}},"title":"AssetEmbargo","type":"object"},"AssetEmbargoType":{"enum":["archive","limited","watermark"],"title":"AssetEmbargoType","type":"string"},"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetEmbargoInput":{"properties":{"embargoTimeStamp":{"format":"date-time","type":"string"}},"title":"UpdateAssetEmbargoInput","type":"object"},"UpdateAssetEmbargoReply":{"properties":{"assetId":{"type":"string"},"embargo":{"$ref":"#/components/schemas/AssetEmbargo"}},"title":"UpdateAssetEmbargoReply","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/embargos/{embargoId}":{"put":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n For an existing asset embargo, update the date restrictions of that embargo.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"putApi1AssetAssetsAssetidEmbargosEmbargoid","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"embargoId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetEmbargoInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetEmbargoReply"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Update embargo","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/putapi1assetassetsassetidmetaproperties.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"AssetTaxonomy":{"properties":{"assetId":{"type":"string"},"id":{"type":"string"},"metaPropertyOptionGroups":{"items":{"$ref":"#/components/schemas/MetaPropertyOptionGroup"},"type":"array"},"metaPropertyValues":{"items":{"$ref":"#/components/schemas/MetaPropertyValue"},"type":"array"},"metadata":{"items":{"$ref":"#/components/schemas/AssetTaxonomyMetaDataValue"},"type":"array"},"portalId":{"type":"string"},"taxonomyStatus":{"type":"string"},"timeStampModified":{"format":"date-time","type":"string"},"versionId":{"type":"string"}},"title":"AssetTaxonomy","type":"object"},"AssetTaxonomyMetaDataValue":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"AssetTaxonomyMetaDataValue","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"MetaPropertyOptionGroup":{"properties":{"isRemoved":{"type":"boolean"},"metaPropertyId":{"type":"string"},"metaPropertyType":{"$ref":"#/components/schemas/MetaPropertyType"},"values":{"items":{"$ref":"#/components/schemas/ValueReference"},"type":"array"}},"title":"MetaPropertyOptionGroup","type":"object"},"MetaPropertyType":{"enum":["option","tag","autotag"],"title":"MetaPropertyType","type":"string"},"MetaPropertyValue":{"properties":{"isRemoved":{"type":"boolean"},"metaPropertyId":{"type":"string"},"metaPropertyType":{"$ref":"#/components/schemas/MetaPropertyValueType"},"value":{"type":"string"}},"title":"MetaPropertyValue","type":"object"},"MetaPropertyValueType":{"enum":["text","date"],"title":"MetaPropertyValueType","type":"string"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateMetaPropertyOptionGroup":{"properties":{"metaPropertyId":{"type":"string"},"metaPropertyType":{"enum":["option"],"type":"string"},"values":{"items":{"type":"string"},"type":"array"}},"required":["metaPropertyId","metaPropertyType"],"title":"UpdateMetaPropertyOptionGroup","type":"object"},"UpdateMetaPropertyValue":{"properties":{"metaPropertyId":{"type":"string"},"metaPropertyType":{"$ref":"#/components/schemas/MetaPropertyValueType"},"value":{"type":"string"}},"required":["metaPropertyId","metaPropertyType","value"],"title":"UpdateMetaPropertyValue","type":"object"},"UpdateTaxonomy":{"properties":{"metaPropertyOptionGroups":{"items":{"$ref":"#/components/schemas/UpdateMetaPropertyOptionGroup"},"type":"array"},"metaPropertyValues":{"items":{"$ref":"#/components/schemas/UpdateMetaPropertyValue"},"type":"array"}},"title":"UpdateTaxonomy","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"},"ValueReference":{"properties":{"id":{"type":"string"},"isRemoved":{"type":"boolean"}},"title":"ValueReference","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/metaproperties":{"put":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Update the metaproperty option values of an asset, the given input will overwrite everything metaproperty wise that is on the asset. This does not include tags and autotags.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"putApi1AssetAssetsAssetidMetaproperties","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaxonomy"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetTaxonomy"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Set asset metaproperties","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/putapi1assetassetsassetidmetapropertiesmetapropertyid.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"AssetTaxonomy":{"properties":{"assetId":{"type":"string"},"id":{"type":"string"},"metaPropertyOptionGroups":{"items":{"$ref":"#/components/schemas/MetaPropertyOptionGroup"},"type":"array"},"metaPropertyValues":{"items":{"$ref":"#/components/schemas/MetaPropertyValue"},"type":"array"},"metadata":{"items":{"$ref":"#/components/schemas/AssetTaxonomyMetaDataValue"},"type":"array"},"portalId":{"type":"string"},"taxonomyStatus":{"type":"string"},"timeStampModified":{"format":"date-time","type":"string"},"versionId":{"type":"string"}},"title":"AssetTaxonomy","type":"object"},"AssetTaxonomyMetaDataValue":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"title":"AssetTaxonomyMetaDataValue","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"MetaPropertyOptionGroup":{"properties":{"isRemoved":{"type":"boolean"},"metaPropertyId":{"type":"string"},"metaPropertyType":{"$ref":"#/components/schemas/MetaPropertyType"},"values":{"items":{"$ref":"#/components/schemas/ValueReference"},"type":"array"}},"title":"MetaPropertyOptionGroup","type":"object"},"MetaPropertyType":{"enum":["option","tag","autotag"],"title":"MetaPropertyType","type":"string"},"MetaPropertyValue":{"properties":{"isRemoved":{"type":"boolean"},"metaPropertyId":{"type":"string"},"metaPropertyType":{"$ref":"#/components/schemas/MetaPropertyValueType"},"value":{"type":"string"}},"title":"MetaPropertyValue","type":"object"},"MetaPropertyValueType":{"enum":["text","date"],"title":"MetaPropertyValueType","type":"string"},"MetapropertyOptionGroupInput":{"properties":{"metaPropertyType":{"enum":["option"],"type":"string"},"values":{"items":{"type":"string"},"type":"array"}},"required":["metaPropertyType"],"title":"MetapropertyOptionGroupInput","type":"object"},"MetapropertyValueInput":{"properties":{"metaPropertyType":{"$ref":"#/components/schemas/MetaPropertyValueType"},"value":{"type":"string"}},"required":["metaPropertyType","value"],"title":"MetapropertyValueInput","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetMetapropertyInput":{"properties":{"metaPropertyOptionGroup":{"$ref":"#/components/schemas/MetapropertyOptionGroupInput"},"metaPropertyValue":{"$ref":"#/components/schemas/MetapropertyValueInput"}},"title":"UpdateAssetMetapropertyInput","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"},"ValueReference":{"properties":{"id":{"type":"string"},"isRemoved":{"type":"boolean"}},"title":"ValueReference","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/metaproperties/{metapropertyId}":{"put":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Update the metaproperty values of a specific metaproperty on an asset. The full list of options or value for the given metaproperty is overwritten. This endpoint can also be used if no values for the given metaproperty are set on the asset yet.\n\n> **Note:** doing the update request with an empty list of values will delete the metaproperty and its values from the asset.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"putApi1AssetAssetsAssetidMetapropertiesMetapropertyid","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"metapropertyId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetMetapropertyInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetTaxonomy"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Update individual asset metaproperty","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/putapi1assetassetsassetidrelationsrelationid.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateAssetRelationInput":{"properties":{"relatedAssetIds":{"items":{"type":"string"},"type":"array"}},"title":"UpdateAssetRelationInput","type":"object"},"UpdateAssetRelationReply":{"properties":{"assetId":{"type":"string"},"portalId":{"type":"string"},"relatedAssetIds":{"items":{"type":"string"},"type":"array"},"relationId":{"type":"string"}},"title":"UpdateAssetRelationReply","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/relations/{relationId}":{"put":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Update the set of assets the given asset is related to. The result is a bidirectional relation between the given asset and the asset's given as input Note: the recommended maximum amount of Ids to relate is 100 maximum.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"putApi1AssetAssetsAssetidRelationsRelationid","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"relationId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetRelationInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetRelationReply"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Set asset relations","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/putapi1assetassetsassetidtags.md","page_updatedAt":"2026-07-17T07:20:18.000Z","fetched":"2026-09-30","openapi":{"components":{"schemas":{"AssetRequestFailureError":{"properties":{"message":{"type":"string"}},"title":"AssetRequestFailureError","type":"object"},"BadGatewayError":{"properties":{"message":{"type":"string"}},"title":"BadGatewayError","type":"object"},"BadRequestError":{"properties":{"message":{"type":"string"}},"title":"BadRequestError","type":"object"},"CreateCropError":{"properties":{"message":{"type":"string"}},"title":"CreateCropError","type":"object"},"CreateError":{"properties":{"message":{"type":"string"}},"title":"CreateError","type":"object"},"DomainError":{"oneOf":[{"$ref":"#/components/schemas/AssetRequestFailureError"},{"$ref":"#/components/schemas/BadGatewayError"},{"$ref":"#/components/schemas/BadRequestError"},{"$ref":"#/components/schemas/CreateCropError"},{"$ref":"#/components/schemas/CreateError"},{"$ref":"#/components/schemas/EditAdvanceRightsError"},{"$ref":"#/components/schemas/EditError"},{"$ref":"#/components/schemas/ForbiddenError"},{"$ref":"#/components/schemas/GatewayTimeoutError"},{"$ref":"#/components/schemas/GetAssetRelationsError"},{"$ref":"#/components/schemas/HealthError"},{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/NotFoundError"},{"$ref":"#/components/schemas/NotImplementedError"},{"$ref":"#/components/schemas/PublishAssetError"},{"$ref":"#/components/schemas/ReTriggerError"},{"$ref":"#/components/schemas/RestoreError"},{"$ref":"#/components/schemas/RetrieveError"},{"$ref":"#/components/schemas/ReviewAssetVersionError"},{"$ref":"#/components/schemas/SetAutoTagsError"},{"$ref":"#/components/schemas/SetVersionTagsError"},{"$ref":"#/components/schemas/TrashError"},{"$ref":"#/components/schemas/UnauthorizedError"},{"$ref":"#/components/schemas/UpdateAssetRelationError"},{"$ref":"#/components/schemas/UpdateTaxonomyError"},{"$ref":"#/components/schemas/UploadUrlError"},{"$ref":"#/components/schemas/ValidateAssetError"}],"title":"DomainError"},"EditAdvanceRightsError":{"properties":{"message":{"type":"string"}},"title":"EditAdvanceRightsError","type":"object"},"EditError":{"properties":{"message":{"type":"string"}},"title":"EditError","type":"object"},"ForbiddenError":{"properties":{"message":{"type":"string"}},"title":"ForbiddenError","type":"object"},"GatewayTimeoutError":{"properties":{"message":{"type":"string"}},"title":"GatewayTimeoutError","type":"object"},"GetAssetRelationsError":{"properties":{"message":{"type":"string"}},"title":"GetAssetRelationsError","type":"object"},"HealthError":{"properties":{"message":{"type":"string"}},"title":"HealthError","type":"object"},"InternalError":{"properties":{"message":{"type":"string"}},"title":"InternalError","type":"object"},"NotFoundError":{"properties":{"message":{"type":"string"}},"title":"NotFoundError","type":"object"},"NotImplementedError":{"properties":{"message":{"type":"string"}},"title":"NotImplementedError","type":"object"},"PublishAssetError":{"properties":{"message":{"type":"string"}},"title":"PublishAssetError","type":"object"},"ReTriggerError":{"properties":{"message":{"type":"string"}},"title":"ReTriggerError","type":"object"},"RestoreError":{"properties":{"message":{"type":"string"}},"title":"RestoreError","type":"object"},"RetrieveError":{"properties":{"message":{"type":"string"}},"title":"RetrieveError","type":"object"},"ReviewAssetVersionError":{"properties":{"message":{"type":"string"}},"title":"ReviewAssetVersionError","type":"object"},"SetAutoTagsError":{"properties":{"message":{"type":"string"}},"title":"SetAutoTagsError","type":"object"},"SetTagsInput":{"properties":{"tags":{"items":{"type":"string"},"type":"array"}},"title":"SetTagsInput","type":"object"},"SetVersionTagsError":{"properties":{"message":{"type":"string"}},"title":"SetVersionTagsError","type":"object"},"SetVersionTagsReply":{"properties":{"assetId":{"type":"string"},"versionId":{"type":"string"}},"title":"SetVersionTagsReply","type":"object"},"TrashError":{"properties":{"message":{"type":"string"}},"title":"TrashError","type":"object"},"UnauthorizedError":{"properties":{"message":{"type":"string"}},"title":"UnauthorizedError","type":"object"},"UpdateAssetRelationError":{"properties":{"message":{"type":"string"}},"title":"UpdateAssetRelationError","type":"object"},"UpdateTaxonomyError":{"properties":{"message":{"type":"string"}},"title":"UpdateTaxonomyError","type":"object"},"UploadUrlError":{"properties":{"message":{"type":"string"}},"title":"UploadUrlError","type":"object"},"ValidateAssetError":{"properties":{"message":{"type":"string"}},"title":"ValidateAssetError","type":"object"}},"securitySchemes":{"httpAuth":{"scheme":"bearer","type":"http"}}},"info":{"description":"**Beta.** The Asset API lets you ingest, enrich, and manage assets on `api.bynder.com`. Endpoints are grouped by the stage of the asset lifecycle: ingestion (create → upload → publish), enrichment (metadata, tags, embargoes, rights, relations), and general retrieval/management.","title":"Asset API (Beta)","version":"1.0.0-beta"},"openapi":"3.1.0","paths":{"/api/1/asset/assets/{assetId}/tags":{"put":{"description":"> **IMPORTANT NOTE**\n> These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room. \n\n Set a given list of tags as the new tag list of an asset.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","operationId":"putApi1AssetAssetsAssetidTags","parameters":[{"in":"path","name":"assetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetTagsInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetVersionTagsReply"}}},"description":""},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}},"description":""},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"description":""},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}},"description":""},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}},"description":""},"500":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/InternalError"},{"$ref":"#/components/schemas/DomainError"}]}}},"description":""},"501":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedError"}}},"description":""},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadGatewayError"}}},"description":""},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTimeoutError"}}},"description":""}},"security":[{"httpAuth":[]}],"summary":"Set tags","tags":["Asset enrichment"]}}},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"description":"Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.\n\n> **Note:** This API is subject to change until it reaches GA. Activation of the API is on a request basis until GA.","name":"Asset enrichment"}]}}
{"source_url":"https://api.bynder.com/reference/putapi1automationautomationsautomationid.md","page_updatedAt":"2026-05-11T06:38:26.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automations API","version":"1.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"paths":{"/api/1/automation/automations/{automationId}":{"put":{"tags":["Automations - New taxonomy API"],"summary":"Modify automation","description":"Modify an automation. Make sure to use one of the supported bodies listed in the cURL request examples. E.g. ShowOptionAll, DenyDownloads, etc.","operationId":"putApi1AutomationAutomationsAutomationid","parameters":[{"name":"x-api-correlation-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"automationId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["actionType","conditionType","triggerType"],"type":"object","properties":{"actionType":{"type":"string","enum":["SHOW_OPTION","SHOW_METAPROPERTY","PREFILL","EMPTY","SELECT","DESELECT"]},"actionsOn":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"metapropertyId":{"type":"string","format":"uuid"},"optionIds":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"conditionType":{"type":"string","enum":["ALL","ANY","ANY_OPTION"]},"triggerType":{"type":"string","enum":["SELECTED"]},"triggersOn":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"metapropertyId":{"type":"string","format":"uuid"},"optionIds":{"type":"array","items":{"type":"string","format":"uuid"}}}}}}},"examples":{"ShowMetapropertyAnyOption":{"summary":"Show metaproperty based on any trigger options","description":"Show metaproperty based on any option selection. Triggers when any option from the specified trigger metaproperty is selected.","value":{"actionType":"SHOW_METAPROPERTY","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}],"conditionType":"ANY_OPTION","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}]}},"ShowMetapropertySpecificOptions":{"summary":"Show metaproperty based on specific trigger options","description":"Show metaproperty based on specific option selection. Triggers when any of the specified options from the trigger metaproperty are selected.","value":{"actionType":"SHOW_METAPROPERTY","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ShowOptionAny":{"summary":"Show options with any specific options","description":"Show specific options based on trigger option selection. Automation will apply if any of the triggering options is selected.","value":{"actionType":"SHOW_OPTION","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ShowOptionAll":{"summary":"Show options with ALL condition","description":"Show specific options based on multiple trigger option selection. Automation will apply if all the triggering options are selected.","value":{"actionType":"SHOW_OPTION","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}],"conditionType":"ALL","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000001","optionIds":["00000000-0000-0000-0000-000000000001"]},{"metapropertyId":"00000000-0000-0000-0000-000000000002","optionIds":["00000000-0000-0000-0000-000000000002"]}]}},"PrefillMetaproperty":{"summary":"Prefill text metaproperty automation","description":"Automatically fills a text or date metaproperty with a predefined value when specific options are selected. This type of automation can only be used with Text and Date metaproperties. Furthermore, the value must be in the correct format - free text for Text metaproperties and DD/MM/YYYY for Date metaproperties.","value":{"actionType":"PREFILL","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","value":"text_that_should_be_prefilled"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"EmptyMetaproperty":{"summary":"Empty metaproperty automation","description":"Automatically clears the value of a text or date metaproperty when specific conditions are met. This type of automation can only be used with Text and Date metaproperties.","value":{"actionType":"EMPTY","actionsOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ApplyWatermark":{"summary":"Apply watermark automation","description":"Automatically apply watermark to assets when specific metaproperty options are selected.","value":{"actionType":"SELECT","actionsOn":[{"value":"watermark"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"DenyDownloads":{"summary":"Deny asset downloads automation","description":"Automatically deny downloading of assets when specific metaproperty options are selected.","value":{"actionType":"DESELECT","actionsOn":[{"value":"watermark"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"MarkAsLimitedUsage":{"summary":"Mark assets as limited usage automation","description":"Automatically mark assets as limited usage when specific metaproperty options are selected.","value":{"actionType":"SELECT","actionsOn":[{"value":"limited"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}},"ArchiveAssets":{"summary":"Archive assets automation","description":"Automatically archive assets when specific metaproperty options are selected.","value":{"actionType":"SELECT","actionsOn":[{"value":"archive"}],"conditionType":"ANY","triggerType":"SELECTED","triggersOn":[{"metapropertyId":"00000000-0000-0000-0000-000000000000","optionIds":["00000000-0000-0000-0000-000000000000"]}]}}}}},"required":true},"responses":{"202":{"description":"","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string"}}},"examples":{"AutomationUpdatedOutput":{"summary":"Response when automation was successfully updated","value":{"message":"The automation has been updated"}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}}}}},"examples":{"InvalidAutomationOutput":{"summary":"Response when the input automation is invalid","value":{"errorCode":"validation-failure","errors":[],"message":"The input is invalid"}},"DuplicateAutomationOutput":{"summary":"Response when the automation already exists","value":{"errorCode":"duplicate","message":"The automation already exists"}},"TaxonomyErrorOutput":{"summary":"Response when an error occurred while checking the taxonomy","value":{"errorCode":"taxonomy-error","errors":[],"message":"Errors occurred while checking the taxonomy"}},"ConflictingAllConditionOutput":{"summary":"Response when there will be a conflict if creating an automation with an \"all\" condition","description":"This occurs when an existing automation with an \"any\" condition overlaps with the new automation's triggers.","value":{"errorCode":"condition-all-conflict","message":"Creating an automation with condition \"all\" will create a conflict"}},"ConflictingAnyConditionOutput":{"summary":"Response when there will be a conflict if creating an automation with an \"any\" condition","description":"This occurs when an existing automation with an \"all\" condition overlaps with the new automation's triggers.","value":{"errorCode":"condition-any-conflict","message":"Creating an automation with condition \"any\" will create a conflict"}}}}}},"401":{"description":"","content":{"application/json":{"schema":{"required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}}}}},"404":{"description":"","content":{"application/json":{"schema":{"required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"}}},"examples":{"AutomationNotFoundOutput":{"summary":"Response when automation was not found","value":{"errorCode":"automation-not-found","message":"The automation was not found"}}}}}}},"security":[{"httpAuth":[]}]}}},"components":{"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/putrulesruleid.md","page_updatedAt":"2026-01-27T09:17:59.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Automation Workflow API","version":"1.0.0","description":"\nThis API allows clients to manage automation-workflow rules.\n\n<b>Servers:</b>\n\n1. <b>Local Development:</b>\n   - Base URL: http://localhost:8080/{endpoint}\n\n2. <b>Stage or Production:</b>\n   - Base URL: https://automation-workflow-service.bynder.com/api/1/automation-workflow/{endpoint}\n\nEnsure you're using the correct server depending on the environment you're working in (local or production).\n  "},"servers":[{"url":"https://{your-bynder-domain}/api/1/automation-workflow/"}],"paths":{"/rules/{ruleId}":{"put":{"tags":["Automation Workflow Rules"],"summary":"Updates an existing automation workflow rule.","description":"Updates an existing automation workflow rule.","operationId":"putRulesRuleid","parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditAutomationWorkflowRuleBody"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleRuleAutomationWorkflowResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorAuthorizationResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseNotFound"}}}}},"security":[{},{"httpAuth":[]}]}}},"components":{"schemas":{"AndCondition":{"title":"AndCondition","type":"object","properties":{"and":{"type":"array","items":{"$ref":"#/components/schemas/LeafCondition"}}}},"ArchiveTerm":{"title":"ArchiveTerm","type":"object","required":["offset_amount","offset_unit"],"properties":{"offset_amount":{"type":"integer","format":"int32"},"offset_unit":{"type":"string"}}},"AssetTypeTerm":{"title":"AssetTypeTerm","type":"object","required":["asset_type"],"properties":{"asset_type":{"type":"string"}}},"AutomationWorkflowStep":{"title":"AutomationWorkflowStep","type":"object","properties":{"step_triggers":{"type":"array","items":{"type":"string"}},"actions":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowStepActionBase"}},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/AndCondition"}}}},"AutomationWorkflowStepActionAgent":{"title":"AutomationWorkflowStepActionAgent","type":"object","required":["action_type","data"],"properties":{"action_type":{"type":"string"},"data":{"$ref":"#/components/schemas/StepActionAgentData"},"is_valid":{"type":"boolean"}}},"AutomationWorkflowStepActionBase":{"title":"AutomationWorkflowStepActionBase","oneOf":[{"$ref":"#/components/schemas/AutomationWorkflowStepActionAgent"},{"$ref":"#/components/schemas/AutomationWorkflowStepAddToCollectionAction"}]},"AutomationWorkflowStepAddToCollectionAction":{"title":"AutomationWorkflowStepAddToCollectionAction","type":"object","required":["action_type","data"],"properties":{"action_type":{"type":"string"},"data":{"$ref":"#/components/schemas/StepAddToCollectionActionData"},"is_valid":{"type":"boolean"}}},"EditAutomationWorkflowRuleBody":{"title":"EditAutomationWorkflowRuleBody","type":"object","properties":{"name":{"type":"string"},"triggers":{"type":"array","items":{"type":"string"}},"steps":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowStep"}}}},"ErrorAuthorizationResponse":{"title":"ErrorAuthorizationResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponse":{"title":"ErrorResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ErrorResponseNotFound":{"title":"ErrorResponseNotFound","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ExpressionCondition":{"title":"ExpressionCondition","type":"object","required":["operator"],"properties":{"term":{"type":"array","items":{"$ref":"#/components/schemas/Term"}},"operator":{"type":"string"}}},"LeafCondition":{"title":"LeafCondition","type":"object","required":["condition_type","expression"],"properties":{"condition_type":{"type":"string"},"expression":{"$ref":"#/components/schemas/ExpressionCondition"},"is_valid":{"type":"boolean"}}},"MetapropertyOptionTerm":{"title":"MetapropertyOptionTerm","type":"object","required":["metaproperty_id"],"properties":{"metaproperty_id":{"type":"string","format":"uuid"},"metaproperty_option_id":{"type":"string","format":"uuid"}}},"SingleRuleAutomationWorkflowResponse":{"title":"SingleRuleAutomationWorkflowResponse","type":"object","required":["id","status","name","date_created","created_by_id","date_modified","is_valid"],"properties":{"id":{"type":"string"},"status":{"type":"string"},"name":{"type":"string"},"date_created":{"type":"string"},"created_by_id":{"type":"string"},"date_modified":{"type":"string"},"edited_by_id":{"type":"string"},"date_removed":{"type":"string"},"triggers":{"type":"array","items":{"type":"string"}},"steps":{"type":"array","items":{"$ref":"#/components/schemas/AutomationWorkflowStep"}},"is_valid":{"type":"boolean"}}},"StepActionAgentData":{"title":"StepActionAgentData","type":"object","required":["agent_id"],"properties":{"agent_id":{"type":"string"},"run_name":{"type":"string"}}},"StepAddToCollectionActionData":{"title":"StepAddToCollectionActionData","type":"object","required":["collection_id"],"properties":{"collection_id":{"type":"string"}}},"Term":{"title":"Term","oneOf":[{"$ref":"#/components/schemas/ArchiveTerm"},{"$ref":"#/components/schemas/AssetTypeTerm"},{"$ref":"#/components/schemas/MetapropertyOptionTerm"}]}},"securitySchemes":{"httpAuth":{"type":"http","scheme":"bearer"}}}}}
{"source_url":"https://api.bynder.com/reference/register-uploaded-chunk.md","page_updatedAt":"2026-07-21T13:27:24.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Upload Assets API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://bynder-public-us-east-1.s3.amazonaws.com/","variables":{}}],"paths":{"/api/v4/upload/{uploadId}":{"post":{"tags":["Step 3B Register uploaded chunk"],"summary":"Register uploaded chunk","description":"Register the completion of an uploaded chunk.","operationId":"Register uploaded chunk","parameters":[{"name":"uploadId","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string","examples":["T3.fS5.5HPhtYFtm2b_.e7wVe910tL5XQutKw1jkMqlP5cPQVyZkOZxZ9lJiGUk4FIw6M0CFZ3xogTWrm.GPI2p2CaglQcAS5aH37zT_vHJnbtkebYbheXIQc_.M_6hM"]}},{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"$ref":"#/components/schemas/Content-Type"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"type":"object","properties":{"chunkNumber":{"type":"number","description":"required for every chunk","contentEncoding":"double","examples":[5]},"targetid":{"type":"string","description":"required for every chunk","examples":["final/00000000-0000-0000-0000000000000000/Logo.png"]},"filename":{"type":"string","description":"required for every chunk","examples":["api_uploads/00000000-0000-0000-0000000000000000/00000000-0000-0000-0000000000000000/Logo.png/p5"]}},"contentMediaType":"application/x-www-form-urlencoded"}}},"required":false},"responses":{"202":{"description":"Chunk registered successfully","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiV4UploadResponse"}}}},"500":{"description":"Upload failed or not ready","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiV4Upload500Error1"}}}}},"deprecated":false,"security":[{"OAuth2":["MEDIAUPLOAD","MEDIAUPLOADFORAPPROVAL"]},{"permanentToken":["MEDIAUPLOAD","MEDIAUPLOADFORAPPROVAL"]}]},"parameters":[]}},"components":{"schemas":{"ApiV4UploadResponse":{"title":"ApiV4UploadResponse","type":"object","properties":{"status":{"type":"string","description":"Only for chunk registration","examples":["ok"]},"output":{"type":"string","examples":["final/2ba07d00-586a-4a44-b13c-c58598cfe828/"]},"batchId":{"type":"string","examples":["00000000-0000-0000-0000000000000000"]},"file":{"$ref":"#/components/schemas/File"},"filename":{"type":"string","examples":["final/2ba07d00-586a-4a44-b13c-c58598cfe828/IMG_1874.JPG"]},"importId":{"type":"string","examples":["000000000-0000-0000-0000000000000000"]},"locationType":{"type":"string","examples":["s3"]},"success":{"type":"integer","contentEncoding":"int32","examples":[1]}}},"File":{"title":"File","type":"object","properties":{"bucket":{"type":"string","examples":["BUCKET"]},"path":{"type":"string","examples":["final/2ba07d00-586a-4a44-b13c-c58598cfe828/IMG_1874.JPG"]},"type":{"type":"string","examples":["s3"]}}},"ApiV4Upload500Error1":{"title":"ApiV4Upload500Error1","type":"object","properties":{"message":{"type":"string","examples":["Could not complete upload"]},"retry":{"type":"integer","contentEncoding":"int32","examples":[1]},"success":{"type":"boolean","examples":[false]}}},"Content-Type":{"title":"Content-Type","const":"application/x-www-form-urlencoded","type":"string"}},"securitySchemes":{"permanentToken":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://your-bynder-domainDefaultValue/token","scopes":{"MEDIAUPLOAD":"","MEDIAUPLOADFORAPPROVAL":""}},"authorizationCode":{"authorizationUrl":"https://your-bynder-domainDefaultValue/","tokenUrl":"https://your-bynder-domainDefaultValue/token","scopes":{"MEDIAUPLOAD":"","MEDIAUPLOADFORAPPROVAL":""}}}}}},"security":[],"tags":[{"name":"Step 3B Register uploaded chunk","description":"This endpoint finalizes the upload after all chunks have been uploaded. You need to provide the file ID and details about the file, including its name, size, and the number of chunks it was split into.\n"}]}}
{"source_url":"https://api.bynder.com/reference/removeusersfromgroup.md","page_updatedAt":"2026-07-15T15:50:57.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Groups","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Groups (Preferred)"}],"paths":{"/api/1/groups/{groupId}/remove-users":{"post":{"operationId":"removeUsersFromGroup","summary":"Remove users from a group","description":"Removes one or more users from the specified group. Pass a single-element array to remove one user.\n\nUsers not currently in the group are silently ignored (the operation is idempotent).\nAn empty `user_ids` array is accepted and is a no-op.\n\nRequires the **GROUPMANAGEMENT** security role.\n","tags":["Groups (Preferred)"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"ID of the group (hyphens optional)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMembersInput"}}}},"responses":{"200":{"description":"Users removed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMembersResult"}}}},"400":{"description":"One or more user IDs do not exist in the account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"description":"Validation error (e.g. missing `user_ids` field or malformed UUID)."}},"security":[{"permanentToken":["GROUPMANAGEMENT"]},{"OAuth2":["GROUPMANAGEMENT"]}]}}},"components":{"responses":{"Unauthorized":{"description":"Missing or invalid authentication. The response body is empty."},"Forbidden":{"description":"The authenticated user does not have the **GROUPMANAGEMENT** security role."},"NotFound":{"description":"Group not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"schemas":{"GroupMembersInput":{"type":"object","required":["user_ids"],"properties":{"user_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the users to add or remove. An empty list is a no-op."}}},"GroupMembersResult":{"type":"object","properties":{"user_count":{"type":"integer","description":"Updated number of members in the group after the operation."}}},"ErrorResponse":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable description of the error."}}}}},"NotFoundResponse":{"type":"object","properties":{"detail":{"type":"string","example":"Not Found"}}}},"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups`"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/retrieve-metaproperty-access.md","page_updatedAt":"2026-01-21T16:37:01.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Access Rights and Options API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}}],"paths":{"/api/content_access/metaproperties/{metaproperty_id}":{"get":{"tags":["Access rights"],"summary":"Retrieve metaproperty access","description":"","operationId":"Retrieve metaproperty access","parameters":[{"name":"metaproperty_id","in":"path","description":"Metaproperty id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful retrieval of metaproperty access","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiContentAccessMetapropertiesResponse"},"description":"","contentMediaType":"application/json"}}}}},"deprecated":false},"parameters":[]}},"components":{"schemas":{"ApiContentAccessMetapropertiesResponse":{"title":"ApiContentAccessMetapropertiesResponse","type":"object","properties":{"id":{"type":"string","examples":["00000000-0000-0000-0000-000000000000"]},"contentId":{"type":"string","examples":["00000000-0000-0000-0000-000000000000"]},"contentType":{"type":"string","examples":["metaproperty"]},"level":{"type":"string","examples":["metaproperty.hide"]},"ruleType":{"type":"string","examples":["allow"]},"principalId":{"type":"string","examples":["00000000-0000-0000-0000-000000000000"]},"principalType":{"type":"string","examples":["user"]},"principalName":{"type":"string","examples":["User full name"]},"principalExtraInformation":{"$ref":"#/components/schemas/PrincipalExtraInformation"}}},"PrincipalExtraInformation":{"title":"PrincipalExtraInformation","type":"object","properties":{"email":{"type":"string","examples":["user_email@bynder.com"]}}}},"securitySchemes":{"permanentToken":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://DefaultParameterValue/","tokenUrl":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token","scopes":{}}}}}},"security":[{"OAuth2":[]},{"permanentToken":[]}],"tags":[{"name":"Access rights","description":""}]}}
{"source_url":"https://api.bynder.com/reference/retrieve-poll-state.md","page_updatedAt":"2026-07-21T13:27:24.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Upload Assets API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://bynder-public-us-east-1.s3.amazonaws.com/","variables":{}}],"paths":{"/api/v4/upload/poll":{"get":{"tags":["Step 5 Poll for processing status"],"summary":"Retrieve poll state","description":"This call needs to be executed in a loop until its response returns the item(s) id(s) passed in the **items** parameter.\n","operationId":"Retrieve poll state","parameters":[{"name":"items","in":"query","description":"Comma-separated import id's of a finalised file, as returned by the finalise call.","required":true,"style":"form","explode":true,"schema":{"type":"string","examples":["00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000000"]}}],"responses":{"200":{"description":"Successful response","headers":{},"content":{"application/json":{"schema":{"examples":[{"itemsDone":["00000000-0000-0000-0000000000000000"],"itemsFailed":[],"itemsRejected":[]}],"contentMediaType":"application/json"},"examples":{"success":{"summary":"Successful response","value":{"itemsDone":["00000000-0000-0000-0000000000000000"],"itemsFailed":[],"itemsRejected":[]}}}}}}},"deprecated":false,"security":[{"OAuth2":["MEDIAUPLOAD","MEDIAUPLOADFORAPPROVAL"]},{"permanentToken":["MEDIAUPLOAD","MEDIAUPLOADFORAPPROVAL"]}]},"parameters":[]}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://your-bynder-domainDefaultValue/token","scopes":{"MEDIAUPLOAD":"","MEDIAUPLOADFORAPPROVAL":""}},"authorizationCode":{"authorizationUrl":"https://your-bynder-domainDefaultValue/","tokenUrl":"https://your-bynder-domainDefaultValue/token","scopes":{"MEDIAUPLOAD":"","MEDIAUPLOADFORAPPROVAL":""}}}}}},"security":[],"tags":[{"name":"Step 5 Poll for processing status","description":"This endpoint allows you to check the processing status of a finalized upload. It should be called repeatedly until the response indicates that the processing is complete or provides the item IDs of the processed files.\n"}]}}
{"source_url":"https://api.bynder.com/reference/retrieveallderivativepresets.md","page_updatedAt":"2026-03-31T14:54:29.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Derivative Presets API","version":"1.0.0"},"paths":{"/api/1/derivative-presets/":{"get":{"summary":"Retrieve all configured derivative presets.","description":"Retrieve all configured derivative presets.","operationId":"retrieveAllDerivativePresets","responses":{"200":{"description":"A list of derivative presets.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"prefix":{"type":"string"},"height":{"type":"integer"},"isCrop":{"type":"integer"},"dpi":{"type":"integer"},"width":{"type":"integer"},"allowedTypes":{"type":"string"},"isOnTheFly":{"type":"integer"},"isExtent":{"type":"integer"},"isPublic":{"type":"integer"}}}}}}}},"security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"OAuth 2.0"}}}}}
{"source_url":"https://api.bynder.com/reference/retrievegroupslegacy.md","page_updatedAt":"2026-07-15T15:46:48.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Groups","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Groups (Legacy)"}],"paths":{"/api/groups/list/":{"get":{"operationId":"retrieveGroupsLegacy","summary":"Retrieve groups","description":"Requires the **GROUPMANAGEMENT** security role.","tags":["Groups (Legacy)"],"parameters":[{"name":"search_term","in":"query","required":false,"schema":{"type":"string"},"description":"Search on matching group names."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1},"description":"What page of results to return."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":20},"description":"Maximum results to return. If limit is not provided the first 20 results will be returned."},{"name":"sort_order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"]},"description":"Order of the returned list of groups."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}}}}}},"security":[{"permanentToken":["GROUPMANAGEMENT"]},{"OAuth2":["GROUPMANAGEMENT"]}]}}},"components":{"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups`"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/retrievespecificderivativepreset.md","page_updatedAt":"2026-03-31T14:54:29.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Derivative Presets API","version":"1.0.0"},"paths":{"/api/1/derivative-presets/{preset_id}":{"get":{"summary":"Retrieve a specific configured derivative preset.","description":"Retrieve a specific configured derivative preset.","operationId":"retrieveSpecificDerivativePreset","parameters":[{"name":"preset_id","in":"path","required":true,"description":"The ID of the derivative preset.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A specific derivative preset.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"prefix":{"type":"string"},"height":{"type":"integer"},"isCrop":{"type":"integer"},"dpi":{"type":"integer"},"width":{"type":"integer"},"allowedTypes":{"type":"string"},"isOnTheFly":{"type":"integer"},"isExtent":{"type":"integer"},"isPublic":{"type":"integer"}}}}}}},"security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"OAuth 2.0"}}}}}
{"source_url":"https://api.bynder.com/reference/retrievewebhookipranges.md","page_updatedAt":"2026-08-03T15:12:29.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Webhooks API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}}],"tags":[{"name":"Ranges","description":""}],"paths":{"/v7/webhooks/public/api/ip-ranges":{"get":{"summary":"Retrieve Webhook IP Ranges","description":"Please be aware that using this endpoint requires either the `View Webhooks configurations` or `Manage Webhooks configurations` security role.","tags":["Ranges"],"operationId":"RetrieveWebhookIPRanges","responses":{"200":{"description":"Successful response","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"deprecated":false},"parameters":[]}}}}
{"source_url":"https://api.bynder.com/reference/save-uploaded-file-to-existing-asset.md","page_updatedAt":"2026-07-21T13:27:24.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Upload Assets API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://bynder-public-us-east-1.s3.amazonaws.com/","variables":{}}],"paths":{"/api/v4/media/{id}/save/{importId}":{"post":{"tags":["Step 6 OR Save uploaded file to existing asset"],"summary":"Save uploaded file to existing asset","description":"Be aware that the endpoints described in Step 6 are an Either/Or choice. You should use either the `Save as a new asset` endpoint to save the uploaded file as a new asset, or the `Update existing asset` endpoint to update an existing asset with the uploaded file.","operationId":"Save uploaded file to existing asset","parameters":[{"name":"id","in":"path","description":"Asset id to which to save the uploaded file.","required":true,"style":"simple","schema":{"type":"string","examples":["00000000-0000-0000-0000-000000000000"]}},{"name":"importId","in":"path","description":"Import id of a finalised and processed upload to be saved.","required":true,"style":"simple","schema":{"type":"string","examples":["00000000-0000-0000-0000-000000000000"]}}],"requestBody":{"description":"","content":{"text/plain":{"schema":{"contentMediaType":"text/plain"}}},"required":false},"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"examples":[{"mediaid":"00000000-0000-0000-0000000000000000","batchId":"00000000-0000-0000-0000000000000000","success":true,"mediaitems":[{"original":"final/00000000-0000-0000-0000000000000000/image.jpg","destination":"___URL_TO_BYNDER_CDN___"},{"original":"final/00000000-0000-0000-0000000000000000/thul-image.jpg","destination":"___URL_TO_BYNDER_CDN___"},{"original":"final/00000000-0000-0000-0000000000000000/mini-image.jpg","destination":"___URL_TO_BYNDER_CDN___"}]}],"contentMediaType":"application/json"},"examples":{"success":{"summary":"Successful response","value":{"mediaid":"00000000-0000-0000-0000000000000000","batchId":"00000000-0000-0000-0000000000000000","success":true,"mediaitems":null}}}}}}},"deprecated":false},"parameters":[]}},"security":[]}}
{"source_url":"https://api.bynder.com/reference/saveasanewasset-1.md","page_updatedAt":"2026-07-21T13:27:24.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Upload Assets API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://bynder-public-us-east-1.s3.amazonaws.com/","variables":{}}],"paths":{"/api/v4/media/save/{importId}":{"post":{"tags":["Step 6 EITHER Save as a new asset"],"summary":"Save as a new asset","description":"For metaproperties that use options (Select, Select2, Autocomplete), modifying an asset's metaproperty options should be done via option UUID's for the API to work optimally, sending name or label values will be deprecated in the future. Other metaproperties (Date, Text and Longtext), values can be submitted directly. Be aware that the endpoints described in Step 6 are an Either/Or choice. You should use either the `Save as a new asset` endpoint to save the uploaded file as a new asset, or the `Update existing asset` endpoint to update an existing asset with the uploaded file.\n","operationId":"Saveasanewasset","parameters":[{"name":"importId","in":"path","description":"Import id of a finalised and processed upload to be saved.","required":true,"style":"simple","schema":{"type":"string","examples":["00000000-0000-0000-0000-000000000000"]}},{"name":"Content-Type","in":"header","description":"","required":true,"style":"simple","schema":{"$ref":"#/components/schemas/Content-Type"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"type":"object","required":["brandId"],"properties":{"brandId":{"type":"string","description":"Brand id to save the asset to.","examples":["00000000-0000-0000-0000-0000000000000000"]},"name":{"type":"string","description":"Name of the asset.","examples":["Asset name"]},"description":{"type":"string","description":"Extended asset description.","examples":["Extended asset description"]},"copyright":{"type":"string","description":"Copyright information of the asset.","examples":["Copyright (c) Example corp."]},"tags":{"type":"string","description":"Comma-separated list of tags of the asset.","examples":["scenery,grassland,Holland"]},"metaproperty":{"type":"string","description":"Dictionary with (metaproperty) options to set on the asset. Send fields as `metaproperty.METAPROPERY_ID` with a string of all its (metaproperty) options ids comma-separated.","examples":["metaproperty.00000000-0000-0000-0000000000000000=00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000"]},"categories":{"type":"string","description":"Comma-separated category ids of the asset.","examples":["00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000"]},"audit":{"type":"boolean","description":"Flags if the asset should be sent to the waiting room.","examples":[true]},"isPublic":{"type":"boolean","description":"Flags if the asset should be Public.","examples":[true]},"accessRequestId":{"type":"string","description":"If audit is set to `true` you can specify an accessRequestId to batch uploads to the waiting room. The accessRequestId is retrieved in the response of this endpoint, after you save the first asset of your batch.","examples":["00000000-0000-0000-0000000000000000"]},"requestorId":{"type":"string","description":"If audit is set to `true` you can specify a requestor ID (user ID) to identify the user uploading the asset to the waiting room.","examples":["00000000-0000-0000-0000000000000000"]},"accessType":{"$ref":"#/components/schemas/accessType"},"ISOPublicationDate":{"type":"string","description":"Date/time of publication in ISO08601-format.","contentEncoding":"date-time","examples":["2014-06-12T18:53:21.000Z"]},"publicationDate":{"type":"string","description":"*DEPRECATED* Date/time of publication in linked API user selected locale-format.","examples":["05-31-2010"]},"archiveDate":{"type":"string","description":"Archive date/time of the asset in ISO8601-format.","contentEncoding":"date-time","examples":["2014-12-25T10:30:00.000Z"]},"watermarkDate":{"type":"string","description":"Watermark datetime. ISO8601 format: yyyy-mm-ddThh:mm:ssZ.","contentEncoding":"date-time","examples":["2014-12-25T10:30:00.000Z"]},"crc32":{"type":"integer","description":"CRC32 checksum of the original file, used for verification.","contentEncoding":"int32","examples":[79764919]}},"contentMediaType":"application/x-www-form-urlencoded"}}},"required":false},"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"examples":[{"accessRequestId":"00000000-0000-0000-0000000000000000","mediaid":"00000000-0000-0000-0000000000000000","batchId":"00000000-0000-0000-0000000000000000","success":true,"mediaitems":[{"original":"final/00000000-0000-0000-0000000000000000/image.jpg","destination":"___URL_TO_BYNDER_CDN___"},{"original":"final/00000000-0000-0000-0000000000000000/thul-image.jpg","destination":"___URL_TO_BYNDER_CDN___"},{"original":"final/00000000-0000-0000-0000000000000000/mini-image.jpg","destination":"___URL_TO_BYNDER_CDN___"}]}],"contentMediaType":"application/json"},"examples":{"success":{"summary":"Successful response","value":{"accessRequestId":"00000000-0000-0000-0000000000000000","mediaid":"00000000-0000-0000-0000000000000000","batchId":"00000000-0000-0000-0000000000000000","success":true,"mediaitems":[{"original":"final/00000000-0000-0000-0000000000000000/image.jpg","destination":"___URL_TO_BYNDER_CDN___"},{"original":"final/00000000-0000-0000-0000000000000000/thul-image.jpg","destination":"___URL_TO_BYNDER_CDN___"},{"original":"final/00000000-0000-0000-0000000000000000/mini-image.jpg","destination":"___URL_TO_BYNDER_CDN___"}]}}}}}},"303":{"description":"Import not converted yet, please poll","headers":{},"content":{"application/json":{"schema":{"examples":[{"message":"Import not converted yet, please poll","statuscode":"303"}],"contentMediaType":"application/json"},"examples":{"poll":{"summary":"Poll response","value":{"message":"Import not converted yet, please poll","statuscode":"303"}}}}}},"400":{"description":"Bad Request","headers":{},"content":{"application/json":{"schema":{"examples":["{\"message\":\"No importid provided\",\"statuscode\":\"400\"}","{\"message\":\"No brandid provided\",\"statuscode\":\"400\"}","{\"message\":\"Invalid unsigned integer for CRC32\",\"statuscode\":\"400\"}","{\"message\":\"Invalid argument type for CRC32\",\"statuscode\":\"400\"}","{\"message\":\"Date format not ISO8601-compliant\",\"statuscode\":\"400\"}"],"contentMediaType":"application/json"},"examples":{"noImportId":{"summary":"No importId provided","value":{"message":"No importid provided","statuscode":"400"}},"noBrandId":{"summary":"No brandId provided","value":{"message":"No brandid provided","statuscode":"400"}},"invalidCrc32":{"summary":"Invalid unsigned integer for CRC32","value":{"message":"Invalid unsigned integer for CRC32","statuscode":"400"}},"invalidCrc32Type":{"summary":"Invalid argument type for CRC32","value":{"message":"Invalid argument type for CRC32","statuscode":"400"}},"invalidDateFormat":{"summary":"Date format not ISO8601-compliant","value":{"message":"Date format not ISO8601-compliant","statuscode":"400"}}}}}},"403":{"description":"Access denied","headers":{},"content":{"application/json":{"schema":{"examples":[{"message":"Access denied","statuscode":"403"}],"contentMediaType":"application/json"},"examples":{"accessDenied":{"summary":"Access denied response","value":{"message":"Access denied","statuscode":"403"}}}}}},"404":{"description":"Not Found","headers":{},"content":{"application/json":{"schema":{"examples":["{\"message\":\"Import ID not found\",\"statuscode\":\"404\"}","{\"message\":\"Upload doesn't exist\",\"statuscode\":\"404\"}"],"contentMediaType":"application/json"},"examples":{"importIdNotFound":{"summary":"Import ID not found","value":{"message":"Import ID not found","statuscode":"404"}},"uploadNotExist":{"summary":"Upload doesn't exist","value":{"message":"Upload doesn't exist","statuscode":"404"}}}}}},"500":{"description":"Internal Server Error","headers":{},"content":{"application/json":{"schema":{"examples":[{"message":"Upload failed or not ready","statuscode":"500"}],"contentMediaType":"application/json"},"examples":{"uploadFailed":{"summary":"Upload failed or not ready","value":{"message":"Upload failed or not ready","statuscode":"500"}}}}}}},"deprecated":false,"security":[{"OAuth2":["MEDIAUPLOAD","MEDIAUPLOADFORAPPROVAL"]},{"permanentToken":["MEDIAUPLOAD","MEDIAUPLOADFORAPPROVAL"]}]},"parameters":[]}},"components":{"schemas":{"accessType":{"title":"accessType","enum":["upload","edit","export","shutterstock","stock"],"type":"string","description":"If audit is set to `true` you can specify an access type to define to which waiting room location the asset is uploaded to. The available locations are: Upload, Edit, Workflow approval (export), Shutterstock and Stock.","examples":["upload"]},"Content-Type":{"title":"Content-Type","const":"application/x-www-form-urlencoded","type":"string"}},"securitySchemes":{"permanentToken":{"type":"apiKey","name":"Authorization","in":"header"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://your-bynder-domainDefaultValue/token","scopes":{"MEDIAUPLOAD":"","MEDIAUPLOADFORAPPROVAL":""}},"authorizationCode":{"authorizationUrl":"https://your-bynder-domainDefaultValue/","tokenUrl":"https://your-bynder-domainDefaultValue/token","scopes":{"MEDIAUPLOAD":"","MEDIAUPLOADFORAPPROVAL":""}}}}}},"security":[],"tags":[{"name":"Step 6 EITHER Save as a new asset","description":"This endpoint finalizes the upload after all chunks have been uploaded. You need to provide the file ID and details about the file, including its name, size, and the number of chunks it was split into.\n"}]}}
{"source_url":"https://api.bynder.com/reference/updateawebhookconfiguration.md","page_updatedAt":"2026-08-03T15:12:29.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Webhooks API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}}],"tags":[{"name":"Configurations","description":""}],"paths":{"/v7/webhooks/public/api/subscriptions/{id}":{"put":{"summary":"Update a Webhook Configuration","description":"Please be aware that using this endpoint requires the `Manage Webhooks configurations` security role.","tags":["Configurations"],"operationId":"UpdateaWebhookConfiguration","parameters":[{"name":"id","in":"path","description":"Webhook configuration ID.","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiV7WebhooksPublicApiSubscriptionsRequest1"}}},"required":true},"responses":{"200":{"description":"Webhook updated successfully","headers":{},"content":{}}},"deprecated":false},"parameters":[]}},"components":{"schemas":{"ApiV7WebhooksPublicApiSubscriptionsRequest1":{"title":"ApiV7WebhooksPublicApiSubscriptionsRequest1","type":"object","properties":{"events":{"type":"array","items":{"type":"string"},"description":""},"preArchivedNotificationDays":{"type":"integer","contentEncoding":"int32","examples":[5]}}}}}}}
{"source_url":"https://api.bynder.com/reference/updategroup.md","page_updatedAt":"2026-07-15T15:50:57.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Groups","version":"1.0.0"},"servers":[{"url":"https://{your-bynder-domain}/"}],"tags":[{"name":"Groups (Preferred)"}],"paths":{"/api/1/groups/{groupId}":{"patch":{"operationId":"updateGroup","summary":"Update a group","description":"Updates the name and/or description of an existing group.\n\nAt least one field must be provided. Only the fields included in the request body are updated\n(partial update semantics).\n\nRequires the **GROUPMANAGEMENT** security role.\n","tags":["Groups (Preferred)"],"parameters":[{"name":"groupId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"ID of the group to update (hyphens optional)."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","minProperties":1,"properties":{"name":{"type":"string","description":"New name for the group. Must be unique within the account."},"description":{"type":["string","null"],"description":"New description for the group. Pass `null` to clear it."}}}}}},"responses":{"200":{"description":"Group updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"description":"A group with the requested name already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation error (e.g. empty request body, malformed group ID, or `name` is not a string)."}},"security":[{"permanentToken":["GROUPMANAGEMENT"]},{"OAuth2":["GROUPMANAGEMENT"]}]}}},"components":{"responses":{"Unauthorized":{"description":"Missing or invalid authentication. The response body is empty."},"Forbidden":{"description":"The authenticated user does not have the **GROUPMANAGEMENT** security role."},"NotFound":{"description":"Group not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"schemas":{"Group":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":["string","null"]},"user_count":{"type":"integer","description":"Number of members in the group."}},"example":{"id":"0397e4bd-33fe-4b8f-a51d-4c2f1d9b6c1a","name":"Marketing","description":"Everyone in the marketing department","user_count":12}},"ErrorResponse":{"type":"object","properties":{"detail":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable description of the error."}}}}},"NotFoundResponse":{"type":"object","properties":{"detail":{"type":"string","example":"Not Found"}}}},"securitySchemes":{"permanentToken":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups"}},"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token","scopes":{"GROUPMANAGEMENT":"Grants permission to manage groups`"}}}}}}}}
{"source_url":"https://api.bynder.com/reference/upload-file-in-chunks.md","page_updatedAt":"2026-08-07T11:12:21.000Z","fetched":"2026-09-30","openapi":{"openapi":"3.1.0","info":{"title":"Upload Assets API","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://{your-bynder-domain}/","variables":{"your-bynder-domain":{"default":"your-bynder-domainDefaultValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://{your-auth-url}","variables":{"your-auth-url":{"default":"DefaultParameterValue"}}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://DefaultParameterValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://your-bynder-domainDefaultValue/v6/authentication/oauth2","variables":{}},{"url":"https://your-bynder-domainDefaultValue","variables":{}},{"url":"https://bynder-public-us-east-1.s3.amazonaws.com/","variables":{}}],"paths":{"/":{"post":{"tags":["Step 3A Upload file in chunks"],"summary":"Upload file in chunks","description":"Uploading a file consists of the following two parts:\n\n**1. Breaking down your file into parts/chunks**\n\nEach part must be at least 5 MB in size, except for the last part. There is no size limit on the last part of your multipart upload. For more information about how Amazon handles parts/chunks, visit [Amazon's website](https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html).\n\n**2. Sending the chunks to Amazon and registering them with Bynder**\n\nYou can repeat these calls until your file has been uploaded completely.\n\n## Upload a chunk\n\nMake a `POST` request to the Amazon upload endpoint you received from calling **Get closest AmazonS3 upload endpoint**. Use `multipart/form-data` to send all of the parameters included in the `multipart_params` of the previous request, plus the additional parameters listed below.","operationId":"Upload file in chunks","parameters":[],"responses":{"200":{"description":"","headers":{},"content":{}}},"deprecated":false},"parameters":[],"servers":[{"url":"https://bynder-public-us-east-1.s3-accelerate.amazonaws.com/","description":"Dynamic upload server returned in the previous step."}]}},"security":[],"tags":[{"name":"Step 3A Upload file in chunks","description":"This endpoint uploads a chunk of the file. You need to provide the file ID obtained from the prepare upload step and the chunk number (starting from 0). The request body should contain the binary data of the chunk being uploaded.\n"}]}}