CloudObjects / Directory / Medium Integration / Medium.com - Unofficial API Spec
Sign in

Medium.com - Unofficial API Spec

a wa:WebAPI in Medium Integration

Medium’s unofficial API documentation using OpenAPI specification.# Official APIOfficial API document can also be viewed for most up to date API spec at [https://github.com/Medium/medium-api-docs](https://github.com/Medium/medium-api-docs).Developer Blog - [Welcome to the Medium API](https://medium.com/blog/welcome-to-the-medium-api-3418f956552)

Base URL

The API endpoint is located at the following URL:
https://api.medium.com/v1

Authentication

No authentication methods were specified. Please contact the API provider to get this information!

API Methods

These are the methods supported by the API:

  • GET /me

    Returns details of the user who has granted permission to the application.

    There are no parameters for this request.

    Success response:

    OK

    Status Code 200
    Content Type application/json
    JSON Schema see UserResponse
    Error response:

    The `accessToken` is invalid or has been revoked.

    Status Code 401
    
    
  • GET /publications/{publicationId}/contributors

    This endpoint returns a list of contributors for a given publication. In other words, a list of Medium users who are allowed to publish under a publication, as well as a description of their exact role in the publication (for now, either an editor or a writer).

    Required parameters:
    publicationId -
    Success response:

    OK

    Status Code 200
    Content Type application/json
    JSON Schema see ContributorResponse
    Error response:

    The `accessToken` is invalid or has been revoked.

    Status Code 401
    
    
  • POST /publications/{publicationId}/posts

    creating a post and associating it with a publication on Medium. The request also shows this association, considering posts a collection of resources under a publicationThere are additional rules around publishing that each request to this API must respect: - If the authenticated user is an 'editor' for the publication, they can create posts with any publish status. Posts published as 'public' or 'unlisted' will appear in collection immediately, while posts created as 'draft' will remain in pending state under publication. - If the authenticated user is a 'writer' for the chosen publication, they can only create a post as a 'draft'. That post will remain in pending state under publication until an editor for the publication approves it. - If the authenticated user is neither a 'writer' nor an 'editor', they are not allowed to create any posts in a publication.

    Required parameters:
    publicationId -
    Request body:
    Content Type application/json
    JSON Schema see Post
    Success response:

    OK

    Status Code 200
    Content Type application/json
    JSON Schema see PostDetails
    Error responses:

    Required fields were invalid, not specified.

    Status Code 400

    The `accessToken` is invalid or has been revoked.

    Status Code 401

    The `publicationId` in request path doesn’t point to a publication that the user can publish into.

    Status Code 403
    
    
  • POST /users/{authorId}/posts

    Creates a post on the authenticated user’s profile.

    Required parameters:
    authorId -
    Request body:
    Content Type application/json
    JSON Schema see Post
    Success response:

    OK

    Status Code 200
    Content Type application/json
    JSON Schema see PostDetails
    Error responses:

    Required fields were invalid, not specified.

    Status Code 400

    The `accessToken` is invalid or has been revoked.

    Status Code 401

    The user does not have permission to publish, or the authorId in the request path points to wrong/non-existent user.

    Status Code 403
    
    
  • GET /users/{userId}/publications

    Returns a full list of publications that the user is related to in some way. This includes all publications the user is subscribed to, writes to, or edits.

    Required parameters:
    userId -
    Success response:

    OK

    Status Code 200
    Content Type application/json
    JSON Schema see PublicationResponse
    Error responses:

    The `accessToken` is invalid, lacks the `listPublications` scope or has been revoked.

    Status Code 401

    The request attempts to list publications for another user.

    Status Code 403
    
    
Meta
URI / COID
coid://medium.cloudobjects.io/API/1.0.0
Revision
3-ee9ed4faeb94aba64c5d28e8fb1a09a2
Last updated
2016-12-07 09:51 (UTC)
Created at
2017-10-20 12:14 (UTC)
Usage permission
co:Private
Objects in this namespace