List collaborators on an app

GET

/v1/apps/{appName}/collaborators

const url = 'https://api.aetherpush.com/v1/apps/example/collaborators';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aetherpush.com/v1/apps/example/collaborators \
  --header 'Authorization: Bearer <token>'

Returns the collaborator map for the app. Requires the caller to be a collaborator on (or owner of) the app.

Authorizations

accessKeyAuth
apiKeyAuth
read

Parameters

Path Parameters

appName

required

string

Responses

200

Map of collaborators keyed by email.

application/json

object

collaborators

required

Map keyed by collaborator email.

object

key

additional properties

object

permission

required

App role. Owner controls the app; Admin manages collaborators and deployments on top of Developer; Developer performs release operations; Viewer is read-only.

string

Allowed values: Owner Admin Developer Viewer

isCurrentAccount

boolean

capabilities

Named permissions the requesting account holds on this app.

Array<string>

Allowed values: app.read app.manage app.delete app.transfer collaborators.manage deployments.manage releases.deploy releases.promote releases.rollback metrics.read deploymentKeys.read

Example

{
  "collaborators": {
    "alice@example.com": {
      "permission": "Owner",
      "isCurrentAccount": true
    },
    "bob@example.com": {
      "permission": "Developer"
    }
  }
}

401

Unauthenticated.

application/json

object

error

required

Human-readable error message.

string

requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}

404

App not found.

application/json

object

error

required

Human-readable error message.

string

requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
  "error": "The requested resource was not found.",
  "requestId": "req_abc123"
}