Shortimize API

Collection Management

Endpoint:https://api.shortimize.com

Organize accounts and videos into collections

Get All Collections

GET
https://api.shortimize.com
/collections

Premium Operation - upgrade to Premium API in the app.

Retrieves all collections linked to your organisation. Collections are used to organize and group accounts and videos for easier management.

Rate Limit: 30 requests per minute

Get All Collections › query Parameters

  • parent_idstring

    Filter collections by parent ID. Use 'null' for root-level collections only.

  • include_childrenboolean

    Include child collections in the response

    Default: false

Get All Collections › Headers

  • Authorizationstring · required

    Bearer token for authentication

Get All Collections › Responses

Successful response with a list of collections

  • dataobject[]
  • countinteger

    Number of collections returned

Create Collection

POST
https://api.shortimize.com
/collections

Creates a new collection for organizing accounts and videos.

Rate Limit: 30 requests per minute

Create Collection › Headers

  • Authorizationstring · required

    Bearer token for authentication

Create Collection › Request Body

  • namestring · maxLength: 100 · required

    Collection name

  • parent_idstring · uuid

    Optional parent collection ID for nested collections

  • accessstring · enum

    Access level for the collection

    Enum values:
    private
    public
    protected
    Default: private

Create Collection › Responses

Collection created successfully

  • idstring · uuid
  • namestring
  • organisation_idstring · uuid
  • accessstring
  • created_atstring · date-time

Get Collection

GET
https://api.shortimize.com
/collections/{collection_id}

Premium Operation - upgrade to Premium API in the app.

Retrieves a specific collection by ID.

Rate Limit: 30 requests per minute

Get Collection › path Parameters

  • collection_idstring · uuid · required

    The unique identifier of the collection

Get Collection › query Parameters

  • include_countsboolean

    Include video and account counts

    Default: false

Get Collection › Headers

  • Authorizationstring · required

Get Collection › Responses

Collection details

  • idstring · uuid
  • namestring
  • organisation_idstring · uuid
  • parent_idstring | null
  • accessstring
  • hashstring | null
  • display_settingsobject | null
  • created_atstring · date-time
  • hashtagsstring[]
  • video_countinteger

    Only if include_counts=true

  • account_countinteger

    Only if include_counts=true

Delete Collection

DELETE
https://api.shortimize.com
/collections/{collection_id}

Deletes a collection. This will also remove all associations with accounts and videos.

Rate Limit: 30 requests per minute

Delete Collection › path Parameters

  • collection_idstring · uuid · required

Delete Collection › Headers

  • Authorizationstring · required

Delete Collection › Request Body
optional

Delete Collection › Responses

Collection deleted successfully

  • successboolean
  • deleted_idstring · uuid

Update Collection

PATCH
https://api.shortimize.com
/collections/{collection_id}

Updates a collection's properties.

Rate Limit: 30 requests per minute

Update Collection › path Parameters

  • collection_idstring · uuid · required

Update Collection › Headers

  • Authorizationstring · required

Update Collection › Request Body

  • namestring · maxLength: 100
  • parent_idstring | null · uuid
  • accessstring · enum
    Enum values:
    private
    public
    protected
  • passwordstring · minLength: 8

    Password for protected collections

  • display_settingsobject

    Display settings for public collections

Update Collection › Responses

Collection updated successfully

No data returned

Get Collection Videos

GET
https://api.shortimize.com
/collections/{collection_id}/videos

Premium Operation - upgrade to Premium API in the app.

Retrieves all videos in a collection with pagination.

Rate Limit: 30 requests per minute

Get Collection Videos › path Parameters

  • collection_idstring · uuid · required

Get Collection Videos › query Parameters

  • pageinteger

    Page number (default: 1)

    Default: 1
  • limitinteger · max: 5000

    Items per page (default: 100, max: 5000)

    Default: 100
  • order_bystring

    Field to order by

    Default: created_at
  • order_directionstring · enum

    Order direction

    Enum values:
    asc
    desc
    Default: desc

Get Collection Videos › Headers

  • Authorizationstring · required

Get Collection Videos › Responses

List of videos in the collection

  • dataobject[]
  • paginationobject

Add Videos to Collection

POST
https://api.shortimize.com
/collections/{collection_id}/videos

Adds one or more videos to a collection.

Rate Limit: 30 requests per minute

Add Videos to Collection › path Parameters

  • collection_idstring · uuid · required

Add Videos to Collection › Headers

  • Authorizationstring · required

Add Videos to Collection › Request Body

  • video_idsstring[] · minItems: 1 · maxItems: 100 · required

    Array of video IDs to add to the collection

Add Videos to Collection › Responses

Videos added successfully

  • successboolean
  • collection_idstring
  • videos_addedinteger

Remove Videos from Collection

DELETE
https://api.shortimize.com
/collections/{collection_id}/videos

Removes one or more videos from a collection.

Rate Limit: 30 requests per minute

Remove Videos from Collection › path Parameters

  • collection_idstring · uuid · required

Remove Videos from Collection › Headers

  • Authorizationstring · required

Remove Videos from Collection › Request Body

  • video_idsstring[] · minItems: 1 · maxItems: 100 · required

    Array of video IDs to remove from the collection

Remove Videos from Collection › Responses

Videos removed successfully

  • successboolean
  • collection_idstring
  • videos_removedinteger

Get Collection Accounts

GET
https://api.shortimize.com
/collections/{collection_id}/accounts

Premium Operation - upgrade to Premium API in the app.

Retrieves all accounts in a collection with pagination.

Rate Limit: 30 requests per minute

Get Collection Accounts › path Parameters

  • collection_idstring · uuid · required

Get Collection Accounts › query Parameters

  • pageinteger

    Page number (default: 1)

    Default: 1
  • limitinteger · max: 5000

    Items per page (default: 100, max: 5000)

    Default: 100
  • order_bystring

    Field to order by

    Default: created_at
  • order_directionstring · enum

    Order direction

    Enum values:
    asc
    desc
    Default: desc

Get Collection Accounts › Headers

  • Authorizationstring · required

Get Collection Accounts › Responses

List of accounts in the collection

  • dataobject[]
  • paginationobject

Add Accounts to Collection

POST
https://api.shortimize.com
/collections/{collection_id}/accounts

Adds one or more accounts to a collection.

Rate Limit: 30 requests per minute

Add Accounts to Collection › path Parameters

  • collection_idstring · uuid · required

Add Accounts to Collection › Headers

  • Authorizationstring · required

Add Accounts to Collection › Request Body

  • account_idsstring[] · minItems: 1 · maxItems: 100 · required

    Array of account IDs to add to the collection

Add Accounts to Collection › Responses

Accounts added successfully

  • successboolean
  • collection_idstring
  • accounts_addedinteger

Remove Accounts from Collection

DELETE
https://api.shortimize.com
/collections/{collection_id}/accounts

Removes one or more accounts from a collection.

Rate Limit: 30 requests per minute

Remove Accounts from Collection › path Parameters

  • collection_idstring · uuid · required

Remove Accounts from Collection › Headers

  • Authorizationstring · required

Remove Accounts from Collection › Request Body

  • account_idsstring[] · minItems: 1 · maxItems: 100 · required

    Array of account IDs to remove from the collection

Remove Accounts from Collection › Responses

Accounts removed successfully

  • successboolean
  • collection_idstring
  • accounts_removedinteger
Video ManagementStatistics