TeamGrid Developer Hub

Search results for "{{ search.query }}"

No results found for "{{search.query}}". Ask about it in support.
Suggest Edits

TeamGrid API

 

The TeamGrid API is a RESTful interface, providing programmatic access to your team data. The API accepts JSON in requests and returns JSON content in all of its responses, including errors. Only the UTF-8 character encoding is supported for both requests and responses.

Suggest Edits

Authentication

 

To start with our API you need a valid API token. You can generate API tokens in your TeamGrid Settings. Tokens are only valid for a specific team. It will be possible to limit the permissions for tokens in the near future. Responses will only include data, that is associated with the team in which the token was created.

To authenticate with our API, you have to provide your bearer token in the "Authorization" header. If the authentication fails, our API respond with a 401 status code.

GET /teams HTTPS/1.1
Host: api.teamgridapp.com
Authorization: Bearer <your_token>
Suggest Edits

Pagination

 

Requests that return multiple items will be paginated to 50 items by default. You can specify further pages with the ?page parameter. You can also set a custom page size with the ?limit parameter.

 

With webhooks, you can receive informations about occurring events in TeamGrid.
Visit the settings of your team, to register new webhooks.

Please note, that a webhook will automatically removed, if it response with a 410 status code.

Suggest Edits

Rate limit

 

The API have a rate limit of 100 requests per minute on every API token and url path.

Suggest Edits

/teams

Get the team

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/teams
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK
{
    "statusCode": 200,
    "status": "OK",
    "info": "Teams",
    "data": {
      "_id": "asdEpuAgasdabBWbAR",
      "name": "TeamGrid",
      "createdAt": "2015-04-01T00:00:00.000Z",
      "currency": "EUR",
      "contactId": "YcqgSxJMuvjzNy9uW",
      "defaultRole": "Wmg9xtXuqvdxoWKxT",
      "interface": [
        {
          "colors": {
            "primary": "#01a19b"
          }
        }
      ],
      "roles": [
        {
          "permissions": [
            "tasks",
            "tasks.create",
            "tasks.create.others",
            "tasks.times",
            "tasks.times.view",
            "tasks.times.view.others",
            "tasks.times.create",
            "tasks.times.create.others",
            "tasks.times.edit",
            "tasks.times.edit.others",
            "tasks.times.remove",
            "tasks.times.remove.others",
            "tasks.details",
            "tasks.details.edit",
            "tasks.details.edit.others",
            "tasks.details.edit.user",
            "tasks.details.edit.tags",
            "tasks.details.edit.subscribers",
            "tasks.details.edit.projects",
            "tasks.details.stream",
            "tasks.details.stream.comments",
            "tasks.details.stream.comments.create",
            "tasks.details.stream.comments.create.upload",
            "tasks.details.stream.comments.remove",
            "tasks.details.stream.comments.remove.others",
            "tasks.details.checklist",
            "tasks.details.checklist.create",
            "tasks.details.checklist.edit",
            "tasks.details.checklist.remove",
            "tasks.complete",
            "tasks.complete.others",
            "notes",
            "notes.create",
            "notes.edit",
            "notes.edit.others",
            "analytics",
            "analytics.users",
            "analytics.times",
            "analytics.tasks",
            "analytics.projects",
            "analytics.time",
            "live",
            "projects",
            "projects.grid",
            "projects.grid.lists",
            "projects.grid.lists.create",
            "projects.grid.lists.edit",
            "projects.grid.lists.remove",
            "projects.create",
            "projects.edit",
            "projects.edit.others",
            "projects.edit.contacts",
            "projects.tasks",
            "projects.tasks.move",
            "projects.lists",
            "projects.lists.create",
            "projects.lists.edit",
            "projects.lists.remove",
            "projects.analytics",
            "projects.analytics.time",
            "projects.complete",
            "projects.complete.others",
            "projects.budget",
            "projects.budget.edit",
            "projects.stream",
            "projects.stream.comments",
            "projects.stream.comments.create",
            "projects.stream.comments.create.upload",
            "projects.stream.comments.remove",
            "projects.stream.comments.remove.others",
            "projects.accounting",
            "projects.accounting.edit",
            "projects.costs",
            "projects.revenue",
            "projects.profit",
            "contacts",
            "contacts.create",
            "contacts.edit",
            "contacts.edit.others",
            "contacts.comments",
            "contacts.comments.create",
            "contacts.comments.create.upload",
            "contacts.comments.remove",
            "contacts.comments.remove.others",
            "contacts.accounting",
            "contacts.accounting.edit",
            "contacts.budget",
            "contacts.budget.edit",
            "settings.tags",
            "settings",
            "settings.tags.create",
            "tasks.remove",
            "projects.archive",
            "tasks.times.lock",
            "tasks.times.lock.others",
            "tasks.details.edit.services",
            "tasks.details.edit.contacts",
            "tasks.remove.others",
            "projects.archive.others",
            "contacts.remove",
            "contacts.remove.others",
            "notes.remove",
            "notes.remove.others",
            "analytics.export",
            "analytics.services",
            "analytics.clients",
            "analytics.costs",
            "analytics.revenue",
            "analytics.profit",
            "settings.general",
            "settings.tags.edit",
            "settings.tags.remove",
            "settings.design",
            "settings.labs",
            "settings.permissionmanagement",
            "settings.services",
            "settings.services.create",
            "settings.services.edit",
            "settings.services.remove",
            "projects.edit.sharing"
          ],
          "description": "Can do everything except managing team members and the subscription",
          "name": "User",
          "_id": "Wmg9xtXuqvdxoWKxT"
        }
      ],
      "users": [
        {
          "roleId": "default",
          "contactId": "ujwfXdwqCYj5gg9Gh",
          "costRate": 30,
          "userId": "evSyQe6nnvrMYMCSC"
        },
        {
          "roleId": "default",
          "contactId": "Cucym7KhSguMgPNnb",
          "costRate": 30,
          "userId": "JFZCwR6Jqg8Kw7HXu"
        },
        {
          "roleId": "Wmg9xtXuqvdxoWKxT",
          "contactId": "es8gjT7TuXbNtRGxW",
          "userId": "5HRg3uwwtuiMKZznZ"
        },
        {
          "roleId": "Wmg9xtXuqvdxoWKxT",
          "contactId": "ncELaxnyvgccHhkRM",
          "userId": "fDpDHuBN6DhAeBkNP"
        }
      ]
    }
}
 
Field
Possible values
Description

_id

String (17 characters long)

Unique identifier

name

String

Display name of the team

contactId

String (17 characters long)

Unique identifier of the company contact of this team

users

Object[] (see below for sub fields)

Users of this team

users.$.userId

String (17 characters long)

Unique identifier of the user

users.$.contactId

String (17 characters long)

Unique identifier of the person contact assigned to this user

users.$.costRate

Number

Hourly cost rate of this user

users.$.roleId

String (17 characters long)

Unique identifier of the role assigned to this user

users.$.currentTaskId

String (17 characters long)

Unique identifier of the task on which the user in currently working on

roles

Object[] (see below for sub fields)

Roles defined in this team

roles.$._id

String (17 characters long)

Unique identifier of the role

roles.$.name

String

Display name of this role

roles.$.description

String

Description of this role

roles.$.permissions

String[] (see example for possible values)

Permissions assigned to this role

defaultRole

String (17 characters long)

Unique identifier of the role which is the default role for new members

interface

Object (see below for sub fields)

Interface settings

interface.colors

Object (see below for sub fields)

Color settings

interface.colors.primary

String

Primary color

currency

Number

Currency of this team

createdAt

Date

When was this team created

createdBy

String (17 characters long)

Unique identifier of the user who has created this team

Suggest Edits

/contacts

Get all contacts

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/contacts
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Contacts",
    "data": [
        {
            "type": "company",
            "companyTitle": "Meteor Development Group",
            "addresses": [
                {
                    "address": {
                        "fullAddress": "140 10th St, San Francisco, CA 94103, USA",
                        "lng": -122.41546270000003,
                        "lat": 37.77468959999999,
                        "zip": "94103",
                        "country": "US",
                        "state": "CA",
                        "city": "San Francisco",
                        "street": "10th St",
                        "street_number": "140"
                    },
                    "type": "business"
                }
            ],
            "createdAt": "2015-09-28T06:48:28.660Z",
            "createdBy": "evSyQe6nnvrMYMCSC",
            "billing": {
                "budget": {
                    "type": 100
                },
                "accounting": {
                    "type": 3
                }
            }
        }
    ],
    "pagination": {
        "total": 41,
        "limit": 1,
        "page": 1,
        "pages": 41
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Contacts",
    "pagination": {
        "total": 41,
        "limit": 1,
        "page": 1,
        "pages": 41
    }
}

Query Params

page
int32
limit
int32
 

With the "Get Contacts" endpoint you can receive all your created entries from your TeamGrid address book. You can filter by companies and individuals.

Field
Possible values
Description

_id

String (17 characters long)

Unique identifier

type

company or person

Indicates the type of the contact

gender

male or female
(only available if type is person)

Gender of the person

salutation

String
(only available if type is person)

Academic title of the person

firstname

String
(only available if type is person)

Firstname(s) of the person

lastname

String
(only available if type is person)

Lastname of the person

birthday

Date
(only available if type is person)

Birthday of the person

companyTitle

String
(only available if type is company)

Name of the company

emails

Object[]
(see below for sub fields)

Email addresses of the contact

emails.$.type

private, business or other

Type of the email

emails.$.email

String

Email address

phoneNumbers

Object[]
(see below for sub fields)

Phone numbers of the contact

phoneNumbers.$.type

mobile, landline, business, fax, direct or other

Type of the phone number

phoneNumbers.$.number

String

Phone number

addresses

Object[]
(see below for sub fields)

Addresses of the contact

addresses.$.type

private, business or other

Type of the address

addresses.$.address

Object
(see below for sub fields)

Address

addresses.$.address.fullAddress

String

Concatenated values of the address

addresses.$.address.lat

Number

Latitude

addresses.$.address.lng

Number

Longitude

addresses.$.address.street

String

Street

addresses.$.address.street_number

String

House number

addresses.$.address.city

String

City

addresses.$.address.state

String

State

addresses.$.address.zip

String

Zip code

addresses.$.address.country

String

Country

websites

Object[]
(see below for sub fields)

Websites of the contact

websites.$.type

private, business or other

Type of the website

websites.$.url

String

Url of the website

socialNetworks

Object[]
(see below for sub fields)

Accounts of the contact in social networks

socialNetworks.$.type

facebook, twitter, linkedin or xing

Type of the social network

socialNetworks.$.username

String

Username in the social network

companies

Object[]
(only available if type is person; see below for sub fields)

Companies linked to the person

companies.$.companyId

String (17 characters long)

Reference to the _id of the company contact

companies.$.position

String

Position of the person at this company

companies.$.phone

String

Phone number of the person at this company

companies.$.email

String

Email address of the person at this company

companies.$.address

see addresses (without the type

Address of the person at this company

billing

Object
(see below for sub fields)

Billing settings

billing.accounting

Object
(see below for sub fields)

Accounting settings

billing.accounting.type

Number

Type of the accounting configuration for this contact.
0: by service
1: by person
2: by hourlyRate (see billing.accounting.hourlyRate)
3: none

billing.accounting.hourlyRate

Number

Hourly rate for this contact. Only applies if billing.accounting.type is 2

billing.budget

Object
(see below for sub fields)

Budget settings

billing.budget.type

Number

Type of the budget configuration of this contact.
0: by hours
1: by fees
4: hours per month
5: fees per month
100: none

billing.budget.hours

Number

Budget in hours. Only applies if billing.budget.type is 0 or 4

billing.budget.fees

Number

Budget in fees. Only applies if billing.budget.type is 1 or 5

billing.users

Object[]
(see below for sub fields)

Custom accounting configuration by users

billing.users.$.userId

String (17 characters long)

Unique identifier of the user

billing.users.$.hourlyRate

Number

If this user create time entries assigned to the contact, this hourly rate will be applied

billing.services

Object[]
(see below for sub fields)

Custom accounting configuration by services

billing.services.$.serviceId

String (17 characters long)

Unique identifier of the service

billing.services.$.billable

Boolean

Indicates wether time entries, assigned to the contact and this service are billable

billing.services.$.hourlyRate

Number

If a user create time entries assigned to the contact and this service, this hourly rate will be applied

createdAt

Date

When was the contact created

createdBy

String (17 characters long)

Unique identifier of the user who created this contact

Suggest Edits

/contacts/:_id

Get a contact

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/contacts/_id
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Contacts",
    "data": {
      "type": "company",
      "companyTitle": "Meteor Development Group",
      "addresses": [
        {
          "address": {
            "fullAddress": "140 10th St, San Francisco, CA 94103, USA",
            "lng": -122.41546270000003,
            "lat": 37.77468959999999,
            "zip": "94103",
            "country": "US",
            "state": "CA",
            "city": "San Francisco",
            "street": "10th St",
            "street_number": "140"
          },
          "type": "business"
        }
      ],
      "createdAt": "2015-09-28T06:48:28.660Z",
      "createdBy": "evSyQe6nnvrMYMCSC",
      "billing": {
        "budget": {
          "type": 100
        },
        "accounting": {
          "type": 3
        }
      }
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Contacts"
}

Path Params

_id
string
required

Identifier of the contact

 
Suggest Edits

/contacts

Create a contact

 

Authentication

 Authentication is required for this endpoint.
posthttps://api.teamgridapp.com/contacts
{
  "type": "company",
  "companyTitle": "Meteor Development Group",
  "addresses": [
    {
      "address": {
        "fullAddress": "140 10th St, San Francisco, CA 94103, USA",
        "lng": -122.41546270000003,
        "lat": 37.77468959999999,
        "zip": "94103",
        "country": "US",
        "state": "CA",
        "city": "San Francisco",
        "street": "10th St",
        "street_number": "140"
      },
      "type": "business"
    }
  ],
  "billing": {
    "budget": {
      "type": 100
    },
    "accounting": {
      "type": 3
    }
  }
}
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     201 Created
{
    "statusCode": 201,
    "status": "Created",
    "info": "Contacts",
    "data": {
      "type": "company",
      "companyTitle": "Meteor Development Group",
      "addresses": [
        {
          "address": {
            "fullAddress": "140 10th St, San Francisco, CA 94103, USA",
            "lng": -122.41546270000003,
            "lat": 37.77468959999999,
            "zip": "94103",
            "country": "US",
            "state": "CA",
            "city": "San Francisco",
            "street": "10th St",
            "street_number": "140"
          },
          "type": "business"
        }
      ],
      "createdAt": "2015-09-28T06:48:28.660Z",
      "createdBy": "evSyQe6nnvrMYMCSC",
      "billing": {
        "budget": {
          "type": 100
        },
        "accounting": {
          "type": 3
        }
      }
    }
}
 
Suggest Edits

/contacts/:_id

Update a contact

 

Authentication

 Authentication is required for this endpoint.
puthttps://api.teamgridapp.com/contacts/_id
{
  "companyTitle": "Meteor Development Group"
}
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK
{
    "statusCode": 200,
    "status": "OK",
    "info": "Contacts",
    "data": {
      "type": "company",
      "companyTitle": "Meteor Development Group",
      "addresses": [
        {
          "address": {
            "fullAddress": "140 10th St, San Francisco, CA 94103, USA",
            "lng": -122.41546270000003,
            "lat": 37.77468959999999,
            "zip": "94103",
            "country": "US",
            "state": "CA",
            "city": "San Francisco",
            "street": "10th St",
            "street_number": "140"
          },
          "type": "business"
        }
      ],
      "createdAt": "2015-09-28T06:48:28.660Z",
      "createdBy": "evSyQe6nnvrMYMCSC",
      "billing": {
        "budget": {
          "type": 100
        },
        "accounting": {
          "type": 3
        }
      }
    }
}

Path Params

_id
string
required

Identifier of the contact

 
Suggest Edits

/projects

Get all projects

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/projects
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Projects",
    "data": [
        {
            "name": "TeamGrid 1.0",
            "createdBy": "5HRg3uwwtuiMKZznZ",
            "createdAt": "2015-03-20T13:04:56.550Z",
            "completed": true,
            "billing": {
                "accounting": {
                    "hourlyRate": 10,
                    "type": 3
                },
                "budget": {
                    "type": 100
                }
            },
            "listId": "2t3mdrXiSvfEg3HfS",
            "order": 2
        }
    ],
    "pagination": {
        "total": 106,
        "limit": 1,
        "page": 1,
        "pages": 106
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Projects"
}

Query Params

page
int32
limit
int32
 
Field
Possible values
Description

_id

String (17 characters long)

Unique identifier

name

String

Display name of the project

briefing

String

Briefing of the project. Can be formatted with markdown

startDate

Date

Start date of the project

dueDate

Date

Due date of the project

contactId

String (17 characters long)

Unique identifier of the contact to which this project is assigned to

listId

String (17 characters long)

Unique identifier of the projects list to which this project is assigned to

order

Number

Order in the projects list to which this project is assigned to

managerId

String (17 characters long)

Unique identifier of the user who is the project manager

completed

Boolean

Indicates wether this project is completed or not

archived

Boolean

Indicates wether this project is archived or not

billing

Object (see below for sub fields)

Billing settings

billing.accounting

Object (see below for sub fields)

Accounting settings

billing.accounting.type

Number

Type of the accounting configuration for this project.
0: by service
1: by person
2: by hourlyRate (see billing.accounting.hourlyRate)
3: none
4: use settings of assigned contact

billing.accounting.hourlyRate

Number

Hourly rate for this project. Only applies if billing.accounting.type is 2

billing.budget

Object (see below for sub fields)

Budget settings

billing.budget.type

Number

Type of the budget configuration of this project.
0: by hours
1: by fees
4: hours per month
5: fees per month
6: use budget of assigned contact
100: none

billing.budget.hours

Number

Budget in hours. Only applies if billing.budget.type is 0 or 4

billing.budget.fees

Number

Budget in fees. Only applies if billing.budget.type is 1 or 5

billing.users

Object[] (see below for sub fields)

Custom accounting configuration by users

billing.users.$.userId

String (17 characters long)

Unique identifier of the user

billing.users.$.hourlyRate

Number

If this user create time entries assigned to the project, this hourly rate will be applied

billing.services

Object[] (see below for sub fields)

Custom accounting configuration by services

billing.services.$.serviceId

String (17 characters long)

Unique identifier of the service

billing.services.$.billable

Boolean

Indicates wether time entries, assigned to the project and this service are billable

billing.services.$.hourlyRate

Number

If a user create time entries assigned to the project and this service, this hourly rate will be applied

createdAt

Date

When was the project created

createdBy

String (17 characters long)

Unique identifier of the user who created this project

Suggest Edits

/projects/:_id

Get a project

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/projects/_id
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Projects",
    "data": {
      "name": "TeamGrid 1.0",
      "createdBy": "5HRg3uwwtuiMKZznZ",
      "createdAt": "2015-03-20T13:04:56.550Z",
      "completed": true,
      "billing": {
        "accounting": {
          "hourlyRate": 10,
          "type": 3
        },
        "budget": {
          "type": 100
        }
      },
      "listId": "2t3mdrXiSvfEg3HfS",
      "order": 2
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Projects"
}

Path Params

_id
string
required

Identifier of the project

 
Suggest Edits

/projects

Create a project

 

Authentication

 Authentication is required for this endpoint.
posthttps://api.teamgridapp.com/projects
{
  "name": "TeamGrid 1.0",
  "completed": true,
  "billing": {
    "accounting": {
      "hourlyRate": 10,
      "type": 3
    },
    "budget": {
      "type": 100
    }
  },
  "listId": "2t3mdrXiSvfEg3HfS",
  "order": 2
}
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     201 Created
{
    "statusCode": 201,
    "status": "Created",
    "info": "Projects",
    "data": {
      "name": "TeamGrid 1.0",
      "createdBy": "5HRg3uwwtuiMKZznZ",
      "createdAt": "2015-03-20T13:04:56.550Z",
      "completed": true,
      "billing": {
        "accounting": {
          "hourlyRate": 10,
          "type": 3
        },
        "budget": {
          "type": 100
        }
      },
      "listId": "2t3mdrXiSvfEg3HfS",
      "order": 2
    }
}
 
Suggest Edits

/projects/:_id

Update a project

 

Authentication

 Authentication is required for this endpoint.
puthttps://api.teamgridapp.com/projects/_id
{
  "completed": true
}
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Projects",
    "data": {
      "name": "TeamGrid 1.0",
      "createdBy": "5HRg3uwwtuiMKZznZ",
      "createdAt": "2015-03-20T13:04:56.550Z",
      "completed": true,
      "billing": {
        "accounting": {
          "hourlyRate": 10,
          "type": 3
        },
        "budget": {
          "type": 100
        }
      },
      "listId": "2t3mdrXiSvfEg3HfS",
      "order": 2
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Projects"
}

Path Params

_id
string
required

Identifier of the project

 
Suggest Edits

/tasks

Get all tasks

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/tasks
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Tasks",
    "data": [
        {
            "name": "Mobile: Aufgabendetailseite schließen",
            "userId": "evSyQe6nnvrMYMCSC",
            "createdAt": "2015-04-25T19:07:00.104Z",
            "createdBy": "5HRg3uwwtuiMKZznZ",
            "projectId": "eryS45sSqb2y7KzWA",
            "listOrder": 11,
            "tagIds": ["crZMsNMGBBjgrrt6K", "4JkdmuyqyyEYCzBP7"],
            "plannedTime": 0,
            "subTasks": null
        }
    ],
    "pagination": {
        "total": 1427,
        "limit": 1,
        "page": 1,
        "pages": 1427
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Tasks"
}

Query Params

page
int32
limit
int32
contactId
string

Filters the list by contact. Can be either a single ID, or multiple comma-separated IDs.

projectId
string

Filters the list by project. Can be either a single ID, or multiple comma-separated IDs.

completed
boolean

Is the task completed or not

 
Field
Possible values
Description

_id

String (17 characters long)

Unique identifier

name

String

Display name of the task.

description

String

Task description.

startDate

Date

Start date of the task

dueDate

Date

Due date of the task.

plannedTime

Number

Planned time of this task in minutes.

serviceId

String (17 characters long)

Unique identifier of the service assigned to this task.

projectId

String (17 characters long)

Unique identifier of the project assigned to this task.

contactId

String (17 characters long)

Unique identifier of the contact assigned to this task.

personalListId

String (17 characters long)

Unique identifier of the personal list to which this task is assigned to.

personalListOrder

Number

Order in the personal list to which this task is assigned to.

listId

String (17 characters long)

Unique identifier of the project list to which this task is assigned to.

listOrder

Number

Order in the project list to which this task is assigned to.

duplicateOf

String (17 characters long)

Unique identifier of the task of which this task is a duplicate.

order

Number

Order in the column of the user to which this task is assigned to.

userId

String (17 characters long)

Unique identifier of the user assigned to this task.

tagIds

String[] (each is 17 characters long)

Unique identifiers of the tags assigned to this task.

subscriberIds

String[] (each is 17 characters long)

Unique identifiers of the users whose are subscribed to this task.

completed

Boolean

Indicates wether this task is completed or not.

subTasks

Object[] (see below for sub fields)

Checklist entries of this task.

subTasks.$.title

String

Display name of this checklist entry.

subTasks.$.completed

Boolean

Indicates wether this checklist entry is completed or not.

subTasks.$.order

Number

Order of the checklist entry.

createdAt

Date

When was the task created.

createdBy

String (17 characters long)

Unique identifier of the user who created this task.

Suggest Edits

/tasks/:_id

Get a task

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/tasks/_id
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Tasks",
    "data": {
      "name": "Mobile: Aufgabendetailseite schließen",
      "userId": "evSyQe6nnvrMYMCSC",
      "createdAt": "2015-04-25T19:07:00.104Z",
      "createdBy": "5HRg3uwwtuiMKZznZ",
      "projectId": "eryS45sSqb2y7KzWA",
      "listOrder": 11,
      "tagIds": ["crZMsNMGBBjgrrt6K", "4JkdmuyqyyEYCzBP7"],
      "plannedTime": 0,
      "subTasks": null
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Tasks"
}

Path Params

_id
string
required

Identifier of the task

 
Suggest Edits

/tasks

Create a task

 

Authentication

 Authentication is required for this endpoint.
posthttps://api.teamgridapp.com/tasks
{
  "name": "Mobile development",
  "userId": "evSyQe6nnvrMYMCSC",
  "projectId": "eryS45sSqb2y7KzWA",
  "tagIds": ["crZMsNMGBBjgrrt6K", "4JkdmuyqyyEYCzBP7"],
  "plannedTime": 0
}
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     201 Created
{
    "statusCode": 201,
    "status": "Created",
    "info": "Tasks",
    "data": {
      "name": "Mobile: Aufgabendetailseite schließen",
      "userId": "evSyQe6nnvrMYMCSC",
      "createdAt": "2015-04-25T19:07:00.104Z",
      "createdBy": "5HRg3uwwtuiMKZznZ",
      "projectId": "eryS45sSqb2y7KzWA",
      "listOrder": 11,
      "tagIds": ["crZMsNMGBBjgrrt6K", "4JkdmuyqyyEYCzBP7"],
      "plannedTime": 0,
      "subTasks": null
    }
}
 
Suggest Edits

/tasks/:_id

Update a task

 

Authentication

 Authentication is required for this endpoint.
puthttps://api.teamgridapp.com/tasks/_id
{
  "completed": true
}
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Tasks",
    "data": {
      "name": "Mobile: Aufgabendetailseite schließen",
      "userId": "evSyQe6nnvrMYMCSC",
      "createdAt": "2015-04-25T19:07:00.104Z",
      "createdBy": "5HRg3uwwtuiMKZznZ",
      "projectId": "eryS45sSqb2y7KzWA",
      "listOrder": 11,
      "tagIds": ["crZMsNMGBBjgrrt6K", "4JkdmuyqyyEYCzBP7"],
      "plannedTime": 0,
      "completed": true,
      "subTasks": null
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Tasks"
}

Path Params

_id
string
required

Identifier of the task

 
Suggest Edits

/tasks/:_id

Delete a task

 

Authentication

 Authentication is required for this endpoint.
deletehttps://api.teamgridapp.com/tasks/_id
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     204 No Content
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Tasks"
}

Path Params

_id
string
required

Identifier of the task

 
Suggest Edits

/times

Get all time entries

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/times
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Times",
    "data": [
      {
        "_id": "25Nni2dnTi2qcR7hb",
        "taskId": "FyBMR3CdYpME6NXBM",
        "start": "2015-05-04T12:45:53.735Z",
        "userId": "JFZCwR6Jqg8KW7HXu",
        "duration": 1,
        "hourlyRate": 0,
        "costRate": 25,
        "end": "2015-05-04T12:46:00.427Z",
        "projectId": "MNtEAQftLWS78eo2x",
        "projectName": "TeamGrid",
        "taskName": "Budget- & Abrechnung optimieren",
        "userName": "Max Nowack",
        "costs": 0.4166666666666667,
        "revenue": 0,
        "profit": -0.4166666666666667,
        "taskCompleted": true,
        "projectCompleted": true,
        "archived": null,
        "billed": null,
        "createdAt": null,
        "createdBy": null,
        "contactId": null,
        "listId": null,
        "serviceId": null,
        "contactName": null,
        "serviceName": null
      }
    ],
    "pagination": {
        "total": 1770,
        "limit": 1,
        "page": 1,
        "pages": 1770
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Times"
}

Query Params

page
int32

Allows to access follow-up pages when combined with limit. Default: 1

limit
int32

Limits the list to the given number of entries. Default: 50

billed
boolean

Is the time entry billed or not

userId
string

Filters the list by user. Can be either a single ID or multiple comma-separated IDs.

taskId
string

Filters the list by task. Can be either a single ID, or multiple comma-separated IDs.

projectId
string

Filters the list by project. Can be either a single ID, or multiple comma-separated IDs.

serviceId
string

Filters the list by service. Can be either a single ID, or multiple comma-separated IDs.

contactId
string

Filters the list by contact. Can be either a single ID, or multiple comma-separated IDs.

startFrom
date

Filter the list to get times beginning from a specific date

startTo
date

Filter the list to get times until a specific date

taskCompleted
boolean

Is the corresponding task completed or not

projectCompleted
boolean

Is the corresponding project completed or not

taskArchived
boolean

Is the corresponding task archived or not

projectArchived
boolean

Is the corresponding project archived or not

 
Field
Possible values
Description

_id

String (17 characters long)

Unique identifier

start

Date

Start date of the time entry

end

Date

End date of the time entry
(empty if time tracking is active)

taskId

String (17 characters long)

Unique identifier of the task on which this time entry was created

userId

String (17 characters long)

Unique identifier of the user assigned to this time entry

hourlyRate

Decimal

Hourly rate which was applied to this time entry

costRate

Decimal

Cost rate which was applied to this time entry

duration

Decimal

Duration of the time entry in minutes

billed

Boolean

Indicates wether this time entry is marked as billed

comment

String

Comment of this time entry

createdAt

Date

When was this time entry created

createdBy

String (17 characters long)

Unique identifier of the user who has created this time entry

contactId

String (17 characters long)

Unique identifier of the contact assigned to the task of this time entry

projectId

String (17 characters long)

Unique identifier of the project assigned to the task of this time entry

listId

String (17 characters long)

Unique identifier of the project list assigned to the task of this time entry

serviceId

String (17 characters long)

Unique identifier of the service assigned to the task of this time entry

contactName

String

Name of the contact assigned to the task of this time entry

projectName

String

Name of the project assigned to the task of this time entry

taskName

String

Name of the task of this time entry

serviceName

String

Name of the service assigned to the task of this time entry

userName

String

Name of the user of this time entry

projectCompleted

Boolean

Completion state of the project assigned to the task of this time entry

taskCompleted

Boolean

Completion state of the task of this time entry

costs

Decimal

Calculated field: (duration / 60) * costRate

revenue

Decimal

Calculated field: (duration / 60) * hourlyRate

profit

Decimal

Calculated field: revenue - costs

Suggest Edits

/times/:_id

Get a time entry

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/times/_id
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Times",
    "data": {
      "start": "2015-10-02T14:00:14.758Z",
      "taskId": "37BwYFbs2GbvdwtRd",
      "userId": "JFZCwR6Jqg8Kw7HXu",
      "createdAt": "2015-10-02T14:00:14.759Z",
      "createdBy": "JFZCwR6Jqg8Kw7HXu",
      "hourlyRate": 0,
      "costRate": 30,
      "end": "2015-10-02T14:20:51.932Z"
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Times"
}

Path Params

_id
string
required

Identifier of the time entry

 
Suggest Edits

/times

Create a time entry

 

Authentication

 Authentication is required for this endpoint.
posthttps://api.teamgridapp.com/times
{
  "start": "2015-10-02T14:00:14.758Z",
  "taskId": "37BwYFbs2GbvdwtRd",
  "userId": "JFZCwR6Jqg8Kw7HXu",
  "createdAt": "2015-10-02T14:00:14.759Z",
  "createdBy": "JFZCwR6Jqg8Kw7HXu",
  "hourlyRate": 0,
  "costRate": 30,
  "end": "2015-10-02T14:20:51.932Z"
}
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     201 Created
{
    "statusCode": 201,
    "status": "Created",
    "info": "Times",
    "data": {
      "start": "2015-10-02T14:00:14.758Z",
      "taskId": "37BwYFbs2GbvdwtRd",
      "userId": "JFZCwR6Jqg8Kw7HXu",
      "createdAt": "2015-10-02T14:00:14.759Z",
      "createdBy": "JFZCwR6Jqg8Kw7HXu",
      "hourlyRate": 0,
      "costRate": 30,
      "end": "2015-10-02T14:20:51.932Z"
    }
}
 
Suggest Edits

/times/:_id

Update a time entry

 

Authentication

 Authentication is required for this endpoint.
puthttps://api.teamgridapp.com/times/_id
{
  "billed": true
}
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Times",
    "data": {
      "start": "2015-10-02T14:00:14.758Z",
      "taskId": "37BwYFbs2GbvdwtRd",
      "userId": "JFZCwR6Jqg8Kw7HXu",
      "createdAt": "2015-10-02T14:00:14.759Z",
      "createdBy": "JFZCwR6Jqg8Kw7HXu",
      "hourlyRate": 0,
      "costRate": 30,
      "end": "2015-10-02T14:20:51.932Z"
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Times"
}

Path Params

_id
string
required

Identifier of the time entry

 
Suggest Edits

/times/:_id

Delete a time entry

 

Authentication

 Authentication is required for this endpoint.
deletehttps://api.teamgridapp.com/times/_id
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     204 No Content
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Times"
}

Path Params

_id
string
required

Identifier of the time entry

 
Suggest Edits

/services

Get all services

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/services
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Services",
    "data": [
        {
            "createdAt": "2015-04-30T18:03:22.412Z",
            "createdBy": "evSyQe6nnvrMYMCSC",
            "title": "Programmierung",
            "billable": true,
            "hourlyRate": 80
        }
    ],
    "pagination": {
        "total": 5,
        "limit": 1,
        "page": 1,
        "pages": 5
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Services"
}

Query Params

page
int32
limit
int32
 
Field
Possible values
Description

_id

String (17 characters long)

Unique identifier

title

String

Display name of the service

billable

Boolean

Indicates wether time entries, assigned to this service are billable (can be overridden by contact or project settings).

hourlyRate

Number

If a user create time entries assigned to this service, this hourly rate will be applied (can be overridden by contact or project settings).

createdAt

Date

When was the service created.

createdBy

String (17 characters long)

Unique identifier of the user who created this service.

Suggest Edits

/services/:_id

Get a service

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/services/_id
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Services",
    "data": {
      "createdAt": "2015-04-30T18:03:22.412Z",
      "createdBy": "evSyQe6nnvrMYMCSC",
      "title": "Programmierung",
      "billable": true,
      "hourlyRate": 80
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Services"
}

Path Params

_id
string
required

Identifier of the service

 
Suggest Edits

/tags

Get all tags

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/tags
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Tags",
    "data": [
        {
            "name": "Improvement",
            "color": "#f6c74a",
            "createdAt": "2015-04-11T09:19:05.744Z",
            "createdBy": "evSyQe6nnvrMYMCSC"
        }
    ],
    "pagination": {
        "total": 33,
        "limit": 1,
        "page": 1,
        "pages": 33
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Tags"
}

Query Params

page
int32
limit
int32
 
Field
Possible values
Description

_id

String (17 characters long)

Unique identifier

name

String

Display name of the tag.

color

String

Color of this tag (Hex).

createdAt

Date

When was this tag created.

createdBy

String (17 characters long)

Unique identifier of the user who has created this tag.

Suggest Edits

/tags/:_id

Get a tag

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/tags/_id
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Tags",
    "data": {
      "name": "Improvement",
      "color": "#f6c74a",
      "createdAt": "2015-04-11T09:19:05.744Z",
      "createdBy": "evSyQe6nnvrMYMCSC"
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Tags"
}

Path Params

_id
string
required

Identifier of the tag

 
Suggest Edits

/lists

Get all lists

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/lists
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Lists",
    "data": [
        {
            "parentId": "sNocCpFd9jpvRp6HL",
            "createdAt": "2015-04-08T13:18:20.765Z",
            "createdBy": "5HRg3uwwtuiMKZznZ",
            "name": "Tst",
            "type": "tasks"
        }
    ],
    "pagination": {
        "total": 292,
        "limit": 1,
        "page": 1,
        "pages": 292
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Lists"
}

Query Params

page
int32
limit
int32
 

With the "Get Lists" endpoint you receive all your created task lists from projects, lists in the projects grid view or personal "My Tasks" lists.

Field
Possible values
Description

_id

String (17 characters long)

Unique identifier

name

String

Display name of this list

parentId

String (17 characters long)

Unique identifier of the parent (user or project)

type

tasks, personal or projects

Indicates the type of the list.
tasksif the parent is a project.
personal if the parent is a user.
projects if the list is a projects list of the team.

order

Number

Position of the list. Used for sorting

createdAt

Date

When was the list created

createdBy

String (17 characters long)

Unique identifier of the user who created this list

Suggest Edits

/lists/:_id

Get a list

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/lists/_id
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Lists",
    "data": {
      "parentId": "sNocCpFd9jpvRp6HL",
      "createdAt": "2015-04-08T13:18:20.765Z",
      "createdBy": "5HRg3uwwtuiMKZznZ",
      "name": "Tst",
      "type": "tasks"
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Lists"
}

Path Params

_id
string
required

Identifier of the list

 

Authentication

 Authentication is required for this endpoint.
posthttps://api.teamgridapp.com/lists
{
	"name": "Tst",
	"type": "tasks",
  "parentId": "sNocCpFd9jpvRp6HL"
}
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK
{
    "statusCode": 201,
    "status": "Created",
    "info": "Lists",
    "data": {
      "name": "Tst",
      "type": "tasks",
      "parentId": "sNocCpFd9jpvRp6HL",
      "createdAt": "2015-10-02T14:00:14.759Z",
      "createdBy": "JFZCwR6Jqg8Kw7HXu"
    }
}
 

Coming soon

Suggest Edits

/lists/:_id

 

Authentication

 Authentication is required for this endpoint.
puthttps://api.teamgridapp.com/lists
{
	"name": "Changed name"
}
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Lists",
    "data": {
      "parentId": "sNocCpFd9jpvRp6HL",
      "createdAt": "2015-04-08T13:18:20.765Z",
      "createdBy": "5HRg3uwwtuiMKZznZ",
      "name": "Changed name",
      "type": "tasks"
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Lists"
}

Path Params

_id
string
required

Identifier of the list

 

Coming soon

Suggest Edits

/lists/:_id

 

Authentication

 Authentication is required for this endpoint.
deletehttps://api.teamgridapp.com/lists
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     204 No Content
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Lists"
}

Path Params

_id
string
required

Identifier of the list

 

Coming soon

Suggest Edits

/webhooks

Get all webhooks

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/webhooks
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  204 No Content
{
    "statusCode": 200,
    "status": "OK",
    "info": "Webhooks",
    "data": [
        {
            "_id": "sNocCpFd9jpvRp6HL",
            "url": "https://webhooktest.teamgridapp.com/",
            "actions": ["task_created", "task_updated"]
        }
    ]
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Webhooks"
}
 

With the "Webhooks" endpoint you receive all your created webhooks.

Field
Possible values
Description

_id

String (17 characters long)

Unique identifier

url

String

URL of the webhook

actions

[String] (17 characters long)

Array of action which should trigger the webhook

Suggest Edits

/webhooks/:_id

Get a webhook

 

Authentication

 Authentication is required for this endpoint.
gethttps://api.teamgridapp.com/webhooks/_id
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     200 OK  400 Bad Request
{
    "statusCode": 200,
    "status": "OK",
    "info": "Webhooks",
    "data": {
      "_id": "sNocCpFd9jpvRp6HL",
      "url": "https://webhooktest.teamgridapp.com/",
      "actions": ["task_created", "task_updated"]
    }
}
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Lists"
}

Path Params

_id
string
required

Identifier of the webhook

 
Suggest Edits

/webhooks

Register a webhook

 

Authentication

 Authentication is required for this endpoint.
posthttps://api.teamgridapp.com/webhooks
{
  "url": "https://webhooktest.teamgridapp.com/",
  "actions": ["task_created", "task_updated"]
}
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     201 Created
{
    "statusCode": 201,
    "status": "Created",
    "info": "Webhooks",
    "data": {
      "_id": "sNocCpFd9jpvRp6HL",
      "url": "https://webhooktest.teamgridapp.com/",
      "actions": ["task_created", "task_updated"]
    }
}
 
Suggest Edits

/webhooks/:_id

Delete a webhook

 

Authentication

 Authentication is required for this endpoint.
deletehttps://api.teamgridapp.com/webhooks/_id
No code samples available
{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
     204 No Content
{
    "statusCode": 204,
    "status": "No Content",
    "info": "Webhooks"
}

Path Params

_id
string
required

Identifier of the webhook