Articles API

GET/articles

Retrieve the details of all your ordered articles. You can optionally provide a "status" parameter to limit the results to only articles currently in a particular status. This can be useful for checking programmatically whether articles have been picked up or submitted, as well as confirming that they are completed before trying to retrieve the article content (until a submitted article is accepted, you will not be able to retrieve the content by API).

Request

Note: Responses will be limited to 100 articles at a time. Larger volumes will need to be navigated via pagination.

Request Headers

Header Value
Content-Type application/json
Accept application/json
Authorization Bearer (using bearer token from /oauth/token)

Request Parameters

Field Description Required
status Optional query parameter to filter results by article status. No

Response

Response Status Codes

Code Description
200 OK
400/401 Unauthorized
403 Forbidden
500 Internal Server Error

Example Successful Response

{
    "current_page": 1,
    "last_page": 3,
    "result_count": 1,
    "total_count": 3,
    "result": [
        {
            "id": 13851,
            "title": "Product X",
            "instructions": "Write a description for Product X, using details from abc.com/productx",
            "niche": "Style",
            "min_word_count": 200,
            "max_word_count": 300,
            "price": 12.50,
            "days_to_complete": 3,
            "order_type": "Contact (4+ Star Writers)",
            "writer": "duchess",
            "pool": null,
            "status": "Writing In-process",
            "current_deadline": "2015-01-10",
            "submitted_at": null,
            "accepted_at": null,
            "created_at": "2014-01-07 12:54:11"
        }
    ]
}

Example Error Response

{
    "error": "forbidden",
    "error_description": "You are not authorized to access this resource"
}

GET/articles/{article_id}

Retrieve the details of a specific article by ID.

Request

Request Headers

Header Value
Content-Type application/json
Accept application/json
Authorization Bearer (using bearer token from /oauth/token)

Response

Response Status Codes

Code Description
200 OK
400/401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Example Successful Response

{
    "id": 13851,
    "title": "Product X",
    "instructions": "Write a description for Product X, using details from abc.com/productx",
    "niche": "Style",
    "min_word_count": 200,
    "max_word_count": 300,
    "price": 12.50,
    "days_to_complete": 3,
    "order_type": "Contact (4+ Star Writers)",
    "writer": "duchess",
    "pool": null,
    "status": "Writing In-process",
    "created_at": "2014-01-07 12:54:11",
    "current_deadline": "2015-01-10",
    "submitted_at": null,
    "accepted_at": null
}

Example Error Response

{
    "error": "not_found",
    "error_description": "Not a valid resource"
}

GET/articles/{article_id}/content

Retrieve the content and copyscape results for a completed article. If you attempt to pull an article that you have not yet accepted after the Writer submission, you will receive a 403 error.

Request

Request Headers

Header Value
Content-Type application/json
Accept application/json
Authorization Bearer (using bearer token from /oauth/token)

Response

Response Status Codes

Code Description
200 OK
400/401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Example Successful Response

{
    "content": "<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>\r\n<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>\r\n<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>\r\n<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>\r\n<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>\r\n<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>",
    "copyscape_matches": {
        "http://xyz.com": 18,
        "http://abc.com": 16,
        "http://ghi.com": 25
    }
}

Example Error Response

{
    "error": "unauthorized",
    "error_description": "Token not valid"
}