GET Jobs - TextKing/textking-api GitHub Wiki

GET /project/{projectId}/jobs

Request: GET /project/{projectId}/jobs

Returns a collection of jobs for a project.

Query parameters

Parameter Description
per_page An integer value defining how many entries should be returned. Only values between 1 and 100 (both inclusive) are allowed. If not given, this defaults to 100.
page Return search results starting at a given page. Used for paging through more than one page of results.

Request headers

Header Description
Authorization oAuth 2 authentication header
Accept application/json or application/xml

Response status codes

HTTP status Description
200 Ok Successful request.
400 Bad Request The project ID is not a valid UUID.
404 Not Found The project with the given ID does not exist.

Example

Load the jobs for the project with the ID bc141454-5949-401b-9c05-7591ee2f562:

GET /v1/project/bc141454-5949-401b-9c05-7591ee2f562/jobs HTTP/1.1
Host: api.textking.com
Accept: application/json
Authorization: Bearer youraccesstoken

Response:

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8

{
    "page": 1,
    "per_page": 100,
    "total": 2,
    "items": [
        {
            "id": "d0c30471-7c70-45d4-bcc1-a7773cb352bd",
            "number": "EN1216947-01",
            "name": "Alice-de.docx German > English",
            "source_language": "de",
            "target_language": "en",
            "quality": "translation",
            "topic": "49353ab0-fdbf-4e1c-a063-cdf4aad98782",
            "briefing": null,
            "state": "translation-delivered",
            "words": 2,
            "net_price": 0.22,
            "currency": "EUR",
            "is_active": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/job/d0c30471-7c70-45d4-bcc1-a7773cb352bd"
                },
                {
                    "rel": "urn:textking:project",
                    "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624"
                },
                {
                    "rel": "urn:textking:document",
                    "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/job/d0c30471-7c70-45d4-bcc1-a7773cb352bd/document"
                },
                {
                    "rel": "urn:textking:translation",
                    "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/job/d0c30471-7c70-45d4-bcc1-a7773cb352bd/translation"
                },
                {
                    "rel": "urn:textking:topic",
                    "href": "https://api.textking.com/v1/topic/49353ab0-fdbf-4e1c-a063-cdf4aad98782"
                },
                {
                    "rel": "urn:textking:callbacks",
                    "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/job/d0c30471-7c70-45d4-bcc1-a7773cb352bd/callbacks"
                }
            ]
        },
        {
            "id": "966d5389-4d0b-4456-b3dd-c25d64741067",
            "number": "EN1216947-02",
            "name": "Alice-de.docx German > English",
            "source_language": "de",
            "target_language": "en",
            "quality": "translation-and-correction",
            "topic": "49353ab0-fdbf-4e1c-a063-cdf4aad98782",
            "briefing": null,
            "state": "translation-pending",
            "words": 2097,
            "net_price": 272.61,
            "currency": "EUR",
            "is_active": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/job/966d5389-4d0b-4456-b3dd-c25d64741067"
                },
                {
                    "rel": "urn:textking:project",
                    "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624"
                },
                {
                    "rel": "urn:textking:document",
                    "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/job/966d5389-4d0b-4456-b3dd-c25d64741067/document"
                },
                {
                    "rel": "urn:textking:translation",
                    "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/job/966d5389-4d0b-4456-b3dd-c25d64741067/translation"
                },
                {
                    "rel": "urn:textking:topic",
                    "href": "https://api.textking.com/v1/topic/49353ab0-fdbf-4e1c-a063-cdf4aad98782"
                },
                {
                    "rel": "urn:textking:callbacks",
                    "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/job/966d5389-4d0b-4456-b3dd-c25d64741067/callbacks"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://api.textking.com/v1/project/bc141454-5949-401b-9c05-7591ee2f5624/jobs?page=1&per_page=100"
        }
    ]
}
⚠️ **GitHub.com Fallback** ⚠️