Flickr Collections API

Hierarchical collections of photosets

OpenAPI Specification

flickr-collections-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Flickr Activity Collections API
  description: 'The Flickr API exposes the photo, group, people, place, tag, gallery, and

    photoset capabilities that power flickr.com. Almost all flickr.com

    functionality is reachable through a single REST-like endpoint

    `https://api.flickr.com/services/rest` using a `method=flickr.{namespace}.{method}`

    query parameter and `format=json&nojsoncallback=1` for JSON output.


    This OpenAPI specification models a curated set of the most widely used

    methods across the Flickr API''s 250+ method namespaces (activity, auth,

    blogs, cameras, collections, commons, contacts, favorites, galleries,

    groups, groupsDiscuss, interestingness, machinetags, panda, people, photos,

    photos.geo, photos.licenses, photos.notes, photos.transform, photos.upload,

    photosets, places, prefs, profile, push, reflection, stats, tags, test, urls).


    Authentication is API key + OAuth 1.0a (HMAC-SHA1). Commercial use of the

    API requires prior permission from Flickr.

    '
  version: 1.0.0
  termsOfService: https://www.flickr.com/services/api/tos/
  contact:
    name: Flickr API Support
    url: https://www.flickr.com/help/api/
  license:
    name: Flickr API Terms of Use
    url: https://www.flickr.com/services/api/tos/
  x-generated-from: documentation
  x-last-validated: '2026-05-30'
servers:
- url: https://api.flickr.com/services
  description: Flickr REST API
- url: https://up.flickr.com/services
  description: Flickr Upload endpoint
security:
- ApiKeyAuth: []
- OAuth1:
  - read
  - write
  - delete
tags:
- name: Collections
  description: Hierarchical collections of photosets
paths:
  /rest/flickr.collections.getTree:
    get:
      operationId: collectionsGetTree
      summary: Get The Collection Tree
      description: Returns a tree (or sub-tree) of collections belonging to a user.
      tags:
      - Collections
      parameters:
      - $ref: '#/components/parameters/ApiKey'
      - name: collection_id
        in: query
        schema:
          type: string
        example: 12345678-72157712345
      - $ref: '#/components/parameters/UserId'
      responses:
        '200':
          description: Collection tree
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionTree'
              examples:
                CollectionsGetTree200Example:
                  summary: Default collectionsGetTree 200 response
                  x-microcks-default: true
                  value:
                    collection:
                    - id: '52345678901'
                      title: Golden Gate Sunset
                      description: Detailed photo metadata.
                      iconlarge: https://www.flickr.com/services/api/
                      set:
                      - id: '52345678901'
                        title: Golden Gate Sunset
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CollectionTree:
      type: object
      properties:
        collection:
          type: array
          items:
            $ref: '#/components/schemas/Collection'
    Collection:
      type: object
      properties:
        id:
          type: string
          example: '52345678901'
        title:
          type: string
          example: Golden Gate Sunset
        description:
          type: string
          example: Detailed photo metadata.
        iconlarge:
          type: string
          format: uri
          example: https://www.flickr.com/services/api/
        set:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: '52345678901'
              title:
                type: string
                example: Golden Gate Sunset
  parameters:
    UserId:
      name: user_id
      in: query
      required: true
      schema:
        type: string
      example: 12345678@N00
    ApiKey:
      name: api_key
      in: query
      required: true
      description: Application API key.
      schema:
        type: string
      example: ab1234567890cdef1234567890abcd12
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: query
      name: api_key
      description: Application API key for non-authenticated and read-only public requests.
    OAuth1:
      type: oauth2
      description: 'Flickr uses OAuth 1.0a (HMAC-SHA1). The OpenAPI 3 schema cannot model

        OAuth 1.0a directly, so this entry approximates the flow. Token URLs:

        - Request token: https://www.flickr.com/services/oauth/request_token

        - Authorize:     https://www.flickr.com/services/oauth/authorize

        - Access token:  https://www.flickr.com/services/oauth/access_token

        '
      flows:
        authorizationCode:
          authorizationUrl: https://www.flickr.com/services/oauth/authorize
          tokenUrl: https://www.flickr.com/services/oauth/access_token
          scopes:
            read: Read access to private content owned by the user
            write: Modify content owned by the user
            delete: Delete content owned by the user