Links

GET /links.json

Lists all links on projects that the authenticated user is associated with. 

Request

GET /links.json

Response

{
    "projects": [
        {
            "links": [
                {
                    "project-id": "999",
                    "name": "Website",
                    "description": "Link to the website",
                    "created-by-userfirstname": "Demo",
                    "height": "600",
                    "private": "0",
                    "width": "800",
                    "created-by-userId": "999",
                    "created-by-userlastname": "User",
                    "category-id": "999",
                    "open-in-new-window": "1",
                    "id": "999",
                    "provider": "default",
                    "created-date": "2014-03-31T13:17:14Z",
                    "category-name": "Demo Links 2",
                    "code": "http://demo1company.com"
                }
            ],
            "name": "demo",
            "id": "999"
        }
    ]
}

See Links in data reference


GET /projects/{project_id}/links.json

This lets you query the list of links for a project. 

Request

GET /projects/{project_id}/links.json

Response

{
    "project": {
        "links": [
            {
                "project-id": "999",
                "name": "Website",
                "description": "Link to the website",
                "created-by-userfirstname": "Demo",
                "height": "600",
                "private": "0",
                "width": "800",
                "created-by-userId": "999",
                "created-by-userlastname": "User",
                "category-id": "999",
                "open-in-new-window": "1",
                "id": "999",
                "provider": "default",
                "created-date": "2014-03-31T13:17:14Z",
                "category-name": "Demo Links 2",
                "code": "http://demo1company.com"
            }
        ],
        "name": "demo",
        "id": "999"
    }
}

See Links in data reference


GET /links/{link_id}.json

This returns all details about an individual link. 

Request

GET /links/{link_id}.json

Response

{
    "link": {
        "project-id": "999",
        "name": "Website",
        "description": "Link to the website",
        "created-by-userfirstname": "Demo",
        "height": "600",
        "private": "0",
        "width": "800",
        "created-by-userId": "999",
        "created-by-userlastname": "User",
        "category-id": "999",
        "project-name": "demo",
        "open-in-new-window": "1",
        "id": "999",
        "provider": "default",
        "created-date": "2014-03-31T13:17:14Z",
        "category-name": "Demo Links 2",
        "code": "http://demo1company.com"
    },
    "STATUS": "OK"
}

See Links in data reference


Create a Single Link

POST /projects/{project_id}/links.json

This command will create a single link.

  • code must be valid Embed Code, IFrame Code or a URL

Request

{
  "link": {
    "name": "Teamwork.com",
    "description": "The Teamwork website",
    "private": "0",
    "code": "http://teamwork.com",
    "width": "800",
    "height": "600",
    "category-id": "999",
    "category-name": "Demo Links 2",
    "notify": "",
    "open-in-new-window": "1",
    "tags": "tag1,tag2,tag3"
  }
}

Response

Returns HTTP status code 200 on success.

See Links in data reference


Update a Single Link

PUT /links/{link_id}.json

This command will update a single link.

  • code must be valid Embed Code, IFrame Code or a URL

Request

{
  "link": {
    "name": "Teamwork",
    "description": "The Teamwork website",
    "private": "0",
    "code": "http://teamwork.com",
    "width": "800",
    "height": "600",
    "category-id": "3",
    "category-name": "Demo Links 2",
    "notify": "",
    "open-in-new-window": "1",
    "tags": "tag1,tag2,tag3"
  }
}

Response

Returns HTTP status code 200 on success.

See Links in data reference


Delete a Single Link

DELETE /links/{link_id}.json

Deletes the link specified by link_id.

Response

Returns HTTP status code 200 on success.