Me
The me endpoint provides a shortcut to access the currently-logged-in user’s information.
Me Endpoints
Get my user data
GET https://agilezen.com/api/v1/meReturns your metadata.
Supports: Enrichments
{
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
}
<?xml version="1.0" encoding="utf-8"?>
<user>
<bio />
<createTime />
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</user>
Update my user data
PUT https://agilezen.com/api/v1/meSets the specified properties on your user record.
Supports: Enrichments
The request data should be an object with any of the following properties. You don’t need to specify all of the properties – just the ones you want to modify.
| Property | Type | Description |
|---|---|---|
| name | string | Your display name |
| username | string | Your username, used to log in |
| string | Your primary email address | |
| bio | string | A quick description of who you are |
On success, returns your updated user data.
{
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
}
<?xml version="1.0" encoding="utf-8"?>
<user>
<bio />
<createTime />
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</user>
Get my stories
GET https://agilezen.com/api/v1/me/storiesReturns a list of all stories currently assigned to you across all projects you are involved in.
Supports: Enrichments
{
"page": 1,
"pageSize": 100,
"totalPages": 1,
"totalItems": 8,
"items": [
{
"id": 1,
"text": "Build Spec house",
"size": "5",
"color": "teal",
"priority": "9",
"deadline": "2011-02-24T00:00:00",
"status": "started",
"project": {
"id": 1,
"name": "Sudden Valley"
},
"phase": {
"id": 3,
"name": "Working"
},
"creator": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
},
"owner": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
}
},
{
"id": 2,
"text": "Unveil Business Model, Starla",
"size": "",
"color": "orange",
"priority": "",
"status": "started",
"project": {
"id": 1,
"name": "Sudden Valley"
},
"phase": {
"id": 4,
"name": "Complete"
},
"creator": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
},
"owner": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
}
},
{
"id": 3,
"text": "Buy boat \"The Sea Word\"",
"size": "",
"color": "orange",
"priority": "",
"status": "finished",
"project": {
"id": 1,
"name": "Sudden Valley"
},
"phase": {
"id": 5,
"name": "Archive"
},
"creator": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
},
"owner": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
}
},
{
"id": 4,
"text": "Find Dad, win his approval",
"size": "",
"color": "orange",
"priority": "",
"status": "started",
"project": {
"id": 1,
"name": "Sudden Valley"
},
"phase": {
"id": 3,
"name": "Working"
},
"creator": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
},
"owner": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
}
},
{
"id": 7,
"text": "Get back control of company",
"size": "",
"color": "teal",
"priority": "",
"status": "started",
"project": {
"id": 1,
"name": "Sudden Valley"
},
"phase": {
"id": 3,
"name": "Working"
},
"creator": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
},
"owner": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
}
},
{
"id": 15,
"text": "Perform amazing magic trick",
"size": "",
"color": "orange",
"priority": "",
"status": "planned",
"project": {
"id": 1,
"name": "Sudden Valley"
},
"phase": {
"id": 1,
"name": "Backlog"
},
"creator": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
},
"owner": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
}
},
{
"id": 1,
"text": "Go to Mexico to find Dad",
"size": "",
"color": "orange",
"priority": "",
"status": "started",
"project": {
"id": 2,
"name": "Chicken Dance"
},
"phase": {
"id": 8,
"name": "Working"
},
"creator": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
},
"owner": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
}
},
{
"id": 6,
"text": "taunt Michael for being a chicken!",
"size": "",
"color": "orange",
"priority": "",
"status": "started",
"project": {
"id": 2,
"name": "Chicken Dance"
},
"phase": {
"id": 7,
"name": "Ready"
},
"creator": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
},
"owner": {
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com"
}
}
]
}
<?xml version="1.0" encoding="utf-8"?>
<stories>
<items>
<story>
<color>teal</color>
<creator>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</creator>
<deadline>2011-02-24T00:00:00</deadline>
<id>1</id>
<owner>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</owner>
<phase>
<id>3</id>
<name>Working</name>
</phase>
<priority>9</priority>
<project>
<id>1</id>
<name>Sudden Valley</name>
</project>
<size>5</size>
<status>started</status>
<text>Build Spec house</text>
</story>
<story>
<color>orange</color>
<creator>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</creator>
<id>2</id>
<owner>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</owner>
<phase>
<id>4</id>
<name>Complete</name>
</phase>
<priority />
<project>
<id>1</id>
<name>Sudden Valley</name>
</project>
<size />
<status>started</status>
<text>Unveil Business Model, Starla</text>
</story>
<story>
<color>orange</color>
<creator>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</creator>
<id>3</id>
<owner>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</owner>
<phase>
<id>5</id>
<name>Archive</name>
</phase>
<priority />
<project>
<id>1</id>
<name>Sudden Valley</name>
</project>
<size />
<status>finished</status>
<text>Buy boat "The Sea Word"</text>
</story>
<story>
<color>orange</color>
<creator>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</creator>
<id>4</id>
<owner>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</owner>
<phase>
<id>3</id>
<name>Working</name>
</phase>
<priority />
<project>
<id>1</id>
<name>Sudden Valley</name>
</project>
<size />
<status>started</status>
<text>Find Dad, win his approval</text>
</story>
<story>
<color>teal</color>
<creator>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</creator>
<id>7</id>
<owner>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</owner>
<phase>
<id>3</id>
<name>Working</name>
</phase>
<priority />
<project>
<id>1</id>
<name>Sudden Valley</name>
</project>
<size />
<status>started</status>
<text>Get back control of company</text>
</story>
<story>
<color>orange</color>
<creator>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</creator>
<id>15</id>
<owner>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</owner>
<phase>
<id>1</id>
<name>Backlog</name>
</phase>
<priority />
<project>
<id>1</id>
<name>Sudden Valley</name>
</project>
<size />
<status>planned</status>
<text>Perform amazing magic trick</text>
</story>
<story>
<color>orange</color>
<creator>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</creator>
<id>1</id>
<owner>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</owner>
<phase>
<id>8</id>
<name>Working</name>
</phase>
<priority />
<project>
<id>2</id>
<name>Chicken Dance</name>
</project>
<size />
<status>started</status>
<text>Go to Mexico to find Dad</text>
</story>
<story>
<color>orange</color>
<creator>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</creator>
<id>6</id>
<owner>
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<userName>gob</userName>
</owner>
<phase>
<id>7</id>
<name>Ready</name>
</phase>
<priority />
<project>
<id>2</id>
<name>Chicken Dance</name>
</project>
<size />
<status>started</status>
<text>taunt Michael for being a chicken!</text>
</story>
</items>
<page>1</page>
<pageSize>100</pageSize>
<totalItems>8</totalItems>
<totalPages>1</totalPages>
</stories>
Enrichments
This resource supports the following enrichments.
Stories
GET https://agilezen.com/api/v1/me?with=storiesReturns your user data with references for all of your assigned stories.
{
"id": 1,
"name": "Gob Bluth",
"userName": "gob",
"email": "Gob@bluth.com",
"stories": [
{
"id": 1,
"text": "Build Spec house"
},
{
"id": 2,
"text": "Unveil Business Model, Starla"
},
{
"id": 3,
"text": "Buy boat \"The Sea Word\""
},
{
"id": 4,
"text": "Find Dad, win his approval"
},
{
"id": 7,
"text": "Get back control of company"
},
{
"id": 15,
"text": "Perform amazing magic trick"
},
{
"id": 1,
"text": "Go to Mexico to find Dad"
},
{
"id": 6,
"text": "taunt Michael for being a chicken!"
}
]
}
<?xml version="1.0" encoding="utf-8"?>
<user>
<bio />
<createTime />
<email>Gob@bluth.com</email>
<id>1</id>
<name>Gob Bluth</name>
<stories>
<story>
<id>1</id>
<text>Build Spec house</text>
</story>
<story>
<id>2</id>
<text>Unveil Business Model, Starla</text>
</story>
<story>
<id>3</id>
<text>Buy boat "The Sea Word"</text>
</story>
<story>
<id>4</id>
<text>Find Dad, win his approval</text>
</story>
<story>
<id>7</id>
<text>Get back control of company</text>
</story>
<story>
<id>15</id>
<text>Perform amazing magic trick</text>
</story>
<story>
<id>1</id>
<text>Go to Mexico to find Dad</text>
</story>
<story>
<id>6</id>
<text>taunt Michael for being a chicken!</text>
</story>
</stories>
<userName>gob</userName>
</user>