Collaborators API

« API Overview

The Collaborator resources allow you to retrieve information about the collaborators for an application.

Contents

List Collaborators

Retrieve a list of collaborators for an application, ordered by user name. Item properties match collaborator detail response properties with the addition of the detail URL.

Request

GET /applications/:slug/collaborators

Response

Status: 200 OK

[{
    "user" :
    {
        "id" : "WseYku+3w4HAMf+dIq854Qw/2Qc=",
        "name" : "test"
    },
    "role" : "collaborator",
    "url" : "https://appharbor.com/applications/:application/collaborators/:id"
}]

Get Collaborator Detail

Retreive the details for the specified collaborator.

Request

GET /applications/:slug/collaborators/:id

Response

Status: 200 OK

{
    "user" :
    {
        "id" : "WseYku+3w4HAMf+dIq854Qw/2Qc=",
        "name" : "test"
    },
    "role" : "collaborator"
}

Response Properties

user The user representation of the collaborator.
role The access level for the collaborator. Possible values are collaborator or administrator.

Create Collaborator

Create a new collaborator on the application with the specified role.

Request

POST /applications/:slug/collaborators

{
    "collaboratorEmail" : "test@example.org",
    "role" : "collaborator"
}

Request Parameters

collaboratorEmail Required The email address of the collaborator to add.
role Required The access level for the collaborator. Accepted values are collaborator or administrator

Response

Status: 201 Created
Location: https://appharbor.com/applications/:application/collaborators/:id

Edit Collaborator

Edit the details for an existing collaborator.

Request

PUT /applications/:slug/collaborators/:id

{
    "role" : "administrator"
}

Request Parameters

role Required The access level for the collaborator. Accepted values are collaborator or administrator

Response

Status: 200 OK

Remove Collaborator

Delete the collaborator from the specified application.

Request

DELETE /applications/:slug/collaborators/:id

Response

Status: 204 No Content

Back to overview

Recent Discussions

21 Sep, 2014 12:33 AM
20 Sep, 2014 01:28 AM
19 Sep, 2014 01:05 AM
16 Sep, 2014 11:22 PM
15 Sep, 2014 12:55 PM