AgileZen API Documentation

Invites

Invite Endpoints

List invites to the specified project

GET https://agilezen.com/api/v1/projects/{projectid}/invites

Returns the list of invites to the specified project.

Requires Admin access on the project.
Supports: Pagination

{
  "page": 1,
  "pageSize": 100,
  "totalPages": 1,
  "totalItems": 1,
  "items": [
    {
      "id": 1,
      "createTime": "2011-02-25T16:53:09",
      "email": "georgesr@bluth.com",
      "token": "7072d4c39059432ea791a03407463f7c",
      "sender": {
        "id": 1,
        "name": "Gob Bluth",
        "userName": "gob",
        "email": "Gob@bluth.com"
      },
      "role": {
        "id": 3,
        "name": "Administrators"
      }
    }
  ]
}
<?xml version="1.0" encoding="utf-8"?>
<invites>
  <items>
    <invite>
      <createTime>2011-02-25T16:53:09</createTime>
      <email>georgesr@bluth.com</email>
      <id>1</id>
      <role>
        <id>3</id>
        <name>Administrators</name>
      </role>
      <sender>
        <email>Gob@bluth.com</email>
        <id>1</id>
        <name>Gob Bluth</name>
        <userName>gob</userName>
      </sender>
      <token>7072d4c39059432ea791a03407463f7c</token>
    </invite>
  </items>
  <page>1</page>
  <pageSize>100</pageSize>
  <totalItems>1</totalItems>
  <totalPages>1</totalPages>
</invites>

Get an invite

GET https://agilezen.com/api/v1/projects/{projectid}/invites/{inviteid}

Returns the invite specified.

Requires Admin access on the project.

{
  "id": 1,
  "createTime": "2011-02-25T16:53:09",
  "email": "georgesr@bluth.com",
  "token": "7072d4c39059432ea791a03407463f7c",
  "sender": {
    "id": 1,
    "name": "Gob Bluth",
    "userName": "gob",
    "email": "Gob@bluth.com"
  },
  "role": {
    "id": 3,
    "name": "Administrators"
  }
}
<?xml version="1.0" encoding="utf-8"?>
<invite>
  <createTime>2011-02-25T16:53:09</createTime>
  <email>georgesr@bluth.com</email>
  <id>1</id>
  <role>
    <id>3</id>
    <name>Administrators</name>
  </role>
  <sender>
    <email>Gob@bluth.com</email>
    <id>1</id>
    <name>Gob Bluth</name>
    <userName>gob</userName>
  </sender>
  <token>7072d4c39059432ea791a03407463f7c</token>
</invite>

Create an invite

POST https://agilezen.com/api/v1/projects/{projectid}/invites

Creates an invite for the specified project.

Requires Admin access on the project.

The request data should be an object with the following properties:

PropertyTypeDescription
emailstringThe email address for desired person
roleintegerThe id of the desired role

The email address specified will receive an email informing them of the pending invite. Invites while pending count against total number of collaborators in a project. If you exceed the limit of collaborators for your account, AgileZen will return a 402 HTTP response code.

Returns the invite added to the specified project.

{
  "id": 1,
  "createTime": "2011-02-25T16:53:09",
  "email": "georgesr@bluth.com",
  "token": "7072d4c39059432ea791a03407463f7c",
  "sender": {
    "id": 1,
    "name": "Gob Bluth",
    "userName": "gob",
    "email": "Gob@bluth.com"
  },
  "role": {
    "id": 3,
    "name": "Administrators"
  }
}
<?xml version="1.0" encoding="utf-8"?>
<invite>
  <createTime>2011-02-25T16:53:09</createTime>
  <email>georgesr@bluth.com</email>
  <id>1</id>
  <role>
    <id>3</id>
    <name>Administrators</name>
  </role>
  <sender>
    <email>Gob@bluth.com</email>
    <id>1</id>
    <name>Gob Bluth</name>
    <userName>gob</userName>
  </sender>
  <token>7072d4c39059432ea791a03407463f7c</token>
</invite>

Delete an invite

DELETE https://agilezen.com/api/v1/projects/{projectid}/invites/{inviteid}

Deletes the specified invite using the ID of the invite.

On success, returns an empty result with a 200 status code.

Requires Admin access on the project.

Filters

There are currently no filters available for invites.

Enrichments

There are currently no enrichments available for invites.